Skip to content

Commit 1adf006

Browse files
authored
Intellisense review fixes - Part 1 (#3482)
* Intellisense review fixes * fix bad xml
1 parent 1fe6042 commit 1adf006

20 files changed

+88
-80
lines changed

xml/Microsoft.Extensions.DependencyInjection/HttpClientBuilderExtensions.xml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@
4848
<returns>An <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder" /> that can be used to configure the client.</returns>
4949
<remarks>
5050
<para>
51-
The <see paramref="configureHandler" /> delegate should return a new instance of the message handler each time it
51+
The <paramref name="configureHandler" /> delegate should return a new instance of the message handler each time it
5252
is invoked.
5353
</para>
5454
<para>
@@ -84,7 +84,7 @@
8484
<param name="configureHandler">A delegate that is used to create a <see cref="T:System.Net.Http.DelegatingHandler" />.</param>
8585
<summary>Adds a delegate that will be used to create an additional message handler for a named <see cref="T:System.Net.Http.HttpClient" />.</summary>
8686
<returns>An <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder" /> that can be used to configure the client.</returns>
87-
<remarks>The <see paramref="configureHandler" /> delegate should return a new instance of the message handler each time it
87+
<remarks>The <paramref name="configureHandler" /> delegate should return a new instance of the message handler each time it
8888
is invoked.</remarks>
8989
</Docs>
9090
</Member>
@@ -470,7 +470,7 @@
470470
<returns>An <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder" /> that can be used to configure the client.</returns>
471471
<remarks>
472472
<para>
473-
The <see paramref="configureHandler" /> delegate should return a new instance of the message handler each time it
473+
The <paramref name="configureHandler" /> delegate should return a new instance of the message handler each time it
474474
is invoked.
475475
</para>
476476
<para>
@@ -507,7 +507,7 @@
507507
<summary>Adds a delegate that will be used to configure the primary <see cref="T:System.Net.Http.HttpMessageHandler" /> for a
508508
named <see cref="T:System.Net.Http.HttpClient" />.</summary>
509509
<returns>An <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder" /> that can be used to configure the client.</returns>
510-
<remarks>The <see paramref="configureHandler" /> delegate should return a new instance of the message handler each time it
510+
<remarks>The <paramref name="configureHandler" /> delegate should return a new instance of the message handler each time it
511511
is invoked.</remarks>
512512
</Docs>
513513
</Member>

xml/System.Buffers/SequenceReader`1.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -641,7 +641,7 @@
641641
<Docs>
642642
<param name="delimiters">The delimiters to search for.</param>
643643
<param name="advancePastDelimiter">
644-
<see langword="true" /> to move past the first instance of any of the given <paramref name="delimiters" />; <see lanword="false" /> to not move past the delimiter.</param>
644+
<see langword="true" /> to move past the first instance of any of the given <paramref name="delimiters" />; <see langword="false" /> to not move past the delimiter.</param>
645645
<summary>Searches for any of a number of specified delimiters and optionally advances past the first one to be found.</summary>
646646
<returns>
647647
<see langword="true" /> if any of the given <paramref name="delimiters" /> was found; otherwise, <see langword="false" />.</returns>

xml/System.Collections/CollectionBase.xml

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -329,9 +329,7 @@ A <xref:System.Collections.CollectionBase> instance is always modifiable. See <x
329329
</ReturnValue>
330330
<Docs>
331331
<summary>Gets the number of elements contained in the <see cref="T:System.Collections.CollectionBase" /> instance. This property cannot be overridden.</summary>
332-
<value>The number of elements contained in the <see cref="T:System.Collections.CollectionBase" /> instance.
333-
334-
Retrieving the value of this property is an `O(1)` operation.</value>
332+
<value>The number of elements contained in the <see cref="T:System.Collections.CollectionBase" /> instance. Retrieving the value of this property is an O(1) operation.</value>
335333
<remarks>
336334
<format type="text/markdown"><![CDATA[
337335
@@ -341,7 +339,7 @@ A <xref:System.Collections.CollectionBase> instance is always modifiable. See <x
341339
[!code-cpp[System.Collections.CollectionBase#1](~/samples/snippets/cpp/VS_Snippets_CLR_System/system.Collections.CollectionBase/CPP/collectionbase.cpp#1)]
342340
[!code-csharp[System.Collections.CollectionBase#1](~/samples/snippets/csharp/VS_Snippets_CLR_System/system.Collections.CollectionBase/CS/collectionbase.cs#1)]
343341
[!code-vb[System.Collections.CollectionBase#1](~/samples/snippets/visualbasic/VS_Snippets_CLR_System/system.Collections.CollectionBase/VB/collectionbase.vb#1)]
344-
342+
345343
]]></format>
346344
</remarks>
347345
</Docs>
@@ -453,9 +451,7 @@ A <xref:System.Collections.CollectionBase> instance is always modifiable. See <x
453451
</ReturnValue>
454452
<Docs>
455453
<summary>Gets an <see cref="T:System.Collections.ArrayList" /> containing the list of elements in the <see cref="T:System.Collections.CollectionBase" /> instance.</summary>
456-
<value>An <see cref="T:System.Collections.ArrayList" /> representing the <see cref="T:System.Collections.CollectionBase" /> instance itself.
457-
458-
Retrieving the value of this property is an `O(1)` operation.</value>
454+
<value>An <see cref="T:System.Collections.ArrayList" /> representing the <see cref="T:System.Collections.CollectionBase" /> instance itself. Retrieving the value of this property is an O(1) operation.</value>
459455
<remarks>
460456
<format type="text/markdown"><![CDATA[
461457

xml/System.Collections/ReadOnlyCollectionBase.xml

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -157,9 +157,7 @@ A <xref:System.Collections.ReadOnlyCollectionBase> instance is always read-only.
157157
</ReturnValue>
158158
<Docs>
159159
<summary>Gets the number of elements contained in the <see cref="T:System.Collections.ReadOnlyCollectionBase" /> instance.</summary>
160-
<value>The number of elements contained in the <see cref="T:System.Collections.ReadOnlyCollectionBase" /> instance.
161-
162-
Retrieving the value of this property is an `O(1)` operation.</value>
160+
<value>The number of elements contained in the <see cref="T:System.Collections.ReadOnlyCollectionBase" /> instance. Retrieving the value of this property is an O(1) operation.</value>
163161
<remarks>
164162
<format type="text/markdown"><![CDATA[
165163

xml/System.Data.Common/DbCommand.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -645,7 +645,7 @@
645645
<Parameters />
646646
<Docs>
647647
<summary>Asynchronously diposes the command object.</summary>
648-
<returns>A <see cref="P:System.Threading.Tasks.ValueTask" /> representing the asynchronous operation.</returns>
648+
<returns>A <see cref="T:System.Threading.Tasks.ValueTask" /> representing the asynchronous operation.</returns>
649649
<remarks>
650650
<format type="text/markdown"><![CDATA[
651651
@@ -1495,7 +1495,7 @@
14951495
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="0" FrameworkAlternate="netcore-3.0;netstandard-2.1" />
14961496
</Parameters>
14971497
<Docs>
1498-
<param name="cancellationToken">An optional token to cancel the asynchronous operation. The default value is <see cref="System.Threading.CancellationToken.None" />.</param>
1498+
<param name="cancellationToken">An optional token to cancel the asynchronous operation. The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>
14991499
<summary>Asynchronously creates a prepared (or compiled) version of the command on the data source.</summary>
15001500
<returns>A <see cref="P:System.Threading.Tasks.Task" /> representing the asynchronous operation.</returns>
15011501
<remarks>

xml/System.Data.Common/DbConnection.xml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -294,7 +294,7 @@
294294
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="0" FrameworkAlternate="netcore-3.0;netstandard-2.1" />
295295
</Parameters>
296296
<Docs>
297-
<param name="cancellationToken">An optional token to cancel the asynchronous operation. The default value is <see cref="System.Threading.CancellationToken.None" />.</param>
297+
<param name="cancellationToken">An optional token to cancel the asynchronous operation. The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>
298298
<summary>Asynchronously begins a database transaction.</summary>
299299
<returns>A task whose <see cref="P:System.Threading.Tasks.Task`1.Result" /> property is an object representing the new transaction.</returns>
300300
<remarks>
@@ -337,7 +337,7 @@
337337
</Parameters>
338338
<Docs>
339339
<param name="isolationLevel">One of the enumeration values that specifies the isolation level for the transaction to use.</param>
340-
<param name="cancellationToken">An optional token to cancel the asynchronous operation. The default value is <see cref="System.Threading.CancellationToken.None" />.</param>
340+
<param name="cancellationToken">An optional token to cancel the asynchronous operation. The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>
341341
<summary>Asynchronously begins a database transaction.</summary>
342342
<returns>A task whose <see cref="P:System.Threading.Tasks.Task`1.Result" /> property is an object representing the new transaction.</returns>
343343
<remarks>
@@ -427,7 +427,7 @@
427427
</Parameters>
428428
<Docs>
429429
<param name="databaseName">The name of the database for the connection to use.</param>
430-
<param name="cancellationToken">An optional token to cancel the asynchronous operation. The default value is <see cref="System.Threading.CancellationToken.None" />.</param>
430+
<param name="cancellationToken">An optional token to cancel the asynchronous operation. The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>
431431
<summary>Asynchronously changes the current database for an open connection.</summary>
432432
<returns>A task representing the asynchronous operation.</returns>
433433
<remarks>
@@ -943,7 +943,7 @@
943943
<Parameters />
944944
<Docs>
945945
<summary>Asynchronously diposes the connection object.</summary>
946-
<returns>A <see cref="P:System.Threading.Tasks.ValueTask" /> representing the asynchronous operation.</returns>
946+
<returns>A <see cref="T:System.Threading.Tasks.ValueTask" /> representing the asynchronous operation.</returns>
947947
<remarks>
948948
<format type="text/markdown"><![CDATA[
949949

xml/System.Data.Common/DbDataReader.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -348,7 +348,7 @@
348348
<Parameters />
349349
<Docs>
350350
<summary>Asynchronously releases all resources used by the current instance of the <see cref="T:System.Data.Common.DbDataReader" /> class.</summary>
351-
<returns>A <see cref="P:System.Threading.Tasks.ValueTask" /> representing the asynchronous operation.</returns>
351+
<returns>A <see cref="T:System.Threading.Tasks.ValueTask" /> representing the asynchronous operation.</returns>
352352
<remarks>
353353
<format type="text/markdown"><![CDATA[
354354

xml/System.Data.Common/DbTransaction.xml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@
138138
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="0" FrameworkAlternate="netcore-3.0;netstandard-2.1" />
139139
</Parameters>
140140
<Docs>
141-
<param name="cancellationToken">An optional token to cancel the asynchronous operation. The default value is <see cref="System.Threading.CancellationToken.None" />.</param>
141+
<param name="cancellationToken">An optional token to cancel the asynchronous operation. The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>
142142
<summary>Asynchronously commits the database transaction.</summary>
143143
<returns>A <see cref="P:System.Threading.Tasks.Task" /> representing the asynchronous operation.</returns>
144144
<remarks>
@@ -382,7 +382,7 @@
382382
<Parameters />
383383
<Docs>
384384
<summary>Asynchronously diposes the transaction object.</summary>
385-
<returns>A <see cref="P:System.Threading.Tasks.ValueTask" /> representing the asynchronous operation.</returns>
385+
<returns>A <see cref="T:System.Threading.Tasks.ValueTask" /> representing the asynchronous operation.</returns>
386386
<remarks>
387387
<format type="text/markdown"><![CDATA[
388388
@@ -499,7 +499,7 @@
499499
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="0" FrameworkAlternate="netcore-3.0;netstandard-2.1" />
500500
</Parameters>
501501
<Docs>
502-
<param name="cancellationToken">An optional token to cancel the asynchronous operation. The default value is <see cref="System.Threading.CancellationToken.None" />.</param>
502+
<param name="cancellationToken">An optional token to cancel the asynchronous operation. The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>
503503
<summary>Asynchronously rolls back a transaction from a pending state.</summary>
504504
<returns>A task representing the asynchronous operation.</returns>
505505
<remarks>

xml/System.DirectoryServices.ActiveDirectory/ActiveDirectorySchedule.xml

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -158,19 +158,26 @@
158158
</term><description> The source is available for replication from 45 to 59 minutes after the hour.
159159

160160
</description></item></list>
161+
</value>
162+
<remarks>
163+
<format type="text/markdown"><![CDATA[
164+
165+
## Examples
161166
162-
The following C# example shows how to use this property to determine if the source is available for replication at 15:50 Coordinated Universal Time on Tuesday.
167+
The following example shows how to use this property to determine if the source is available for replication at 15:50 Coordinated Universal Time on Tuesday:
163168
164169
```csharp
165-
Boolean isAvailable = scheduleObject.RawSchedule[2, 15, 3];
170+
bool isAvailable = scheduleObject.RawSchedule[2, 15, 3];
166171
```
167172
168-
The following C# example shows how to use this property to calculate the 15-minute interval at runtime by dividing the minutes by 15.
173+
The following example shows how to use this property to calculate the 15-minute interval at runtime by dividing the minutes by 15:
169174
170175
```csharp
171-
Boolean isAvailable = scheduleObject.RawSchedule[2, 15, (Int32)50/15];
172-
```</value>
173-
<remarks>To be added.</remarks>
176+
bool isAvailable = scheduleObject.RawSchedule[2, 15, (Int32)50/15];
177+
```
178+
179+
]]></format>
180+
</remarks>
174181
</Docs>
175182
</Member>
176183
<Member MemberName="ResetSchedule">

xml/System.DirectoryServices.ActiveDirectory/ActiveDirectorySchemaClass.xml

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -396,10 +396,11 @@
396396
<ReturnType>System.String</ReturnType>
397397
</ReturnValue>
398398
<Docs>
399-
<summary>Gets the ldapDisplayName of the <see cref="T:System.DirectoryServices.ActiveDirectory.ActiveDirectorySchemaClass" /> object. For more information, see the topic [LDAP-Display-Name](https://msdn.microsoft.com/library/default.asp?url=/library/adschema/adschema/a_ldapdisplayname.asp) in the MSDN Library at [https://msdn.microsoft.com](https://msdn.microsoft.com/).</summary>
400-
<value>A <see cref="T:System.String" /> that contains the ldapDisplayName of the <see cref="T:System.DirectoryServices.ActiveDirectory.ActiveDirectorySchemaClass" /> object. For more information, see the topic [LDAP-Display-Name](https://msdn.microsoft.com/library/default.asp?url=/library/adschema/adschema/a_ldapdisplayname.asp) in the MSDN Library at [https://msdn.microsoft.com](https://msdn.microsoft.com/).</value>
399+
<summary>Gets the ldapDisplayName of the <see cref="T:System.DirectoryServices.ActiveDirectory.ActiveDirectorySchemaClass" /> object.</summary>
400+
<value>A string that contains the ldapDisplayName of the <see cref="T:System.DirectoryServices.ActiveDirectory.ActiveDirectorySchemaClass" /> object.</value>
401401
<remarks>To be added.</remarks>
402402
<altmember cref="M:System.DirectoryServices.ActiveDirectory.ActiveDirectorySchemaClass.Save" />
403+
<related type="Article" href="/windows/win32/adschema/a-ldapdisplayname">LDAP-Display-Name attribute</related>
403404
</Docs>
404405
</Member>
405406
<Member MemberName="Oid">
@@ -562,7 +563,7 @@
562563
## Remarks
563564
The <xref:System.DirectoryServices.ActiveDirectory.ActiveDirectorySchemaClass.SchemaGuid%2A> is used in many Active Directory Domain Services configuration operations, such as managing extended rights.
564565
565-
For more information, see [schemaIDGUID](https://msdn.microsoft.com/library/ee380169.aspx) or [Schema-ID-GUID](/windows/desktop/adschema/a-schemaidguid).
566+
For more information, see [schemaIDGUID](https://docs.microsoft.com/openspecs/windows_protocols/ms-tail/5038cdbe-b665-429c-a36e-36a45f576b81) or [Schema-ID-GUID](/windows/desktop/adschema/a-schemaidguid).
566567
567568
]]></format>
568569
</remarks>

0 commit comments

Comments
 (0)