Skip to content

Commit c8d0f3d

Browse files
authored
Intellisense fixes (#4133)
* intellisense fixes * additional fixes * feedback
1 parent cadf8c7 commit c8d0f3d

File tree

13 files changed

+42
-50
lines changed

13 files changed

+42
-50
lines changed

xml/Microsoft.Extensions.Configuration.AzureKeyVault/AzureKeyVaultConfigurationOptions.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,7 @@
172172
<ReturnType>System.Nullable&lt;System.TimeSpan&gt;</ReturnType>
173173
</ReturnValue>
174174
<Docs>
175-
<summary>Gets or sets the timespan to wait between attempts at polling the Azure KeyVault for changes. <code>null</code> to disable reloading.</summary>
175+
<summary>Gets or sets the timespan to wait between attempts at polling the Azure KeyVault for changes. <see langword="null" /> to disable reloading.</summary>
176176
<value>To be added.</value>
177177
<remarks>To be added.</remarks>
178178
</Docs>

xml/Microsoft.Extensions.Configuration.AzureKeyVault/IKeyVaultSecretManager.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@
7777
<param name="secret">The <see cref="T:Microsoft.Azure.KeyVault.Models.SecretItem" /> instance.</param>
7878
<summary>Checks if <see cref="T:Microsoft.Azure.KeyVault.Models.SecretItem" /> value should be retrieved.</summary>
7979
<returns>
80-
<code>true</code> is secrets value should be loaded, otherwise <code>false</code>.</returns>
80+
<see langword="true" /> is secrets value should be loaded, otherwise <see langword="false" />.</returns>
8181
<remarks>To be added.</remarks>
8282
</Docs>
8383
</Member>

xml/Microsoft.Extensions.Logging.Console/ConsoleLoggerOptions.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@
6262
<ReturnType>System.Boolean</ReturnType>
6363
</ReturnValue>
6464
<Docs>
65-
<summary>Disables colors when <code>true</code>.</summary>
65+
<summary>Disables colors when <see langword="true" />.</summary>
6666
<value>To be added.</value>
6767
<remarks>To be added.</remarks>
6868
</Docs>
@@ -109,7 +109,7 @@
109109
<ReturnType>System.Boolean</ReturnType>
110110
</ReturnValue>
111111
<Docs>
112-
<summary>Includes scopes when <code>true</code>.</summary>
112+
<summary>Includes scopes when <see langword="true" />.</summary>
113113
<value>To be added.</value>
114114
<remarks>To be added.</remarks>
115115
</Docs>

xml/Microsoft.Extensions.Logging/EventId.xml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@
7777
<param name="other">An object to compare with this object.</param>
7878
<summary>Indicates whether the current object is equal to another object of the same type. Two events are equal if they have the same id.</summary>
7979
<returns>
80-
<code>true</code> if the current object is equal to the other parameter; otherwise, <code>false</code>.</returns>
80+
<see langword="true" /> if the current object is equal to the other parameter; otherwise, <see langword="false" />.</returns>
8181
<remarks>To be added.</remarks>
8282
</Docs>
8383
</Member>
@@ -217,7 +217,7 @@
217217
<param name="right">The second <see cref="T:Microsoft.Extensions.Logging.EventId" />.</param>
218218
<summary>Checks if two specified <see cref="T:Microsoft.Extensions.Logging.EventId" /> instances have the same value. They are equal if they have the same Id.</summary>
219219
<returns>
220-
<code>true</code> if the objects are equal.</returns>
220+
<see langword="true" /> if the objects are equal.</returns>
221221
<remarks>To be added.</remarks>
222222
</Docs>
223223
</Member>
@@ -279,7 +279,7 @@
279279
<param name="right">The second <see cref="T:Microsoft.Extensions.Logging.EventId" />.</param>
280280
<summary>Checks if two specified <see cref="T:Microsoft.Extensions.Logging.EventId" /> instances have different values.</summary>
281281
<returns>
282-
<code>true</code> if the objects are not equal.</returns>
282+
<see langword="true" /> if the objects are not equal.</returns>
283283
<remarks>To be added.</remarks>
284284
</Docs>
285285
</Member>

xml/Microsoft.Extensions.ObjectPool/IPooledObjectPolicy`1.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@
8181
<param name="obj">The object to return to the pool.</param>
8282
<summary>Runs some processing when an object was returned to the pool. Can be used to reset the state of an object and indicate if the object should be returned to the pool.</summary>
8383
<returns>
84-
<code>true</code> if the object should be returned to the pool. <code>false</code> if it's not possible/desirable for the pool to keep the object.</returns>
84+
<see langword="true" /> if the object should be returned to the pool. <see langword="false" /> if it's not possible/desirable for the pool to keep the object.</returns>
8585
<remarks>To be added.</remarks>
8686
</Docs>
8787
</Member>

xml/Microsoft.Extensions.Primitives/StringSegment.xml

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@
9898
<summary>Initializes an instance of the <see cref="T:Microsoft.Extensions.Primitives.StringSegment" /> struct.</summary>
9999
<remarks>To be added.</remarks>
100100
<exception cref="T:System.ArgumentNullException">
101-
<paramref name="buffer" /> is <code>null</code>.
101+
<paramref name="buffer" /> is <see langword="null" />.
102102
</exception>
103103
<exception cref="T:System.ArgumentOutOfRangeException">
104104
<paramref name="offset" /> or <paramref name="length" /> is less than zero, or <paramref name="offset" /> +
@@ -279,10 +279,10 @@
279279
<param name="comparisonType">One of the enumeration values that specifies the rules to use in the comparison.</param>
280280
<summary>Checks if the end of this <see cref="T:Microsoft.Extensions.Primitives.StringSegment" /> matches the specified <see cref="T:System.String" /> when compared using the specified <paramref name="comparisonType" />.</summary>
281281
<returns>
282-
<code>true</code> if <paramref name="text" /> matches the end of this <see cref="T:Microsoft.Extensions.Primitives.StringSegment" />; otherwise, <code>false</code>.</returns>
282+
<see langword="true" /> if <paramref name="text" /> matches the end of this <see cref="T:Microsoft.Extensions.Primitives.StringSegment" />; otherwise, <see langword="false" />.</returns>
283283
<remarks>To be added.</remarks>
284284
<exception cref="T:System.ArgumentNullException">
285-
<paramref name="text" /> is <code>null</code>.
285+
<paramref name="text" /> is <see langword="null" />.
286286
</exception>
287287
</Docs>
288288
</Member>
@@ -318,7 +318,7 @@
318318
<param name="other">An object to compare with this object.</param>
319319
<summary>Indicates whether the current object is equal to another object of the same type.</summary>
320320
<returns>
321-
<code>true</code> if the current object is equal to the other parameter; otherwise, <code>false</code>.</returns>
321+
<see langword="true" /> if the current object is equal to the other parameter; otherwise, <see langword="false" />.</returns>
322322
<remarks>To be added.</remarks>
323323
</Docs>
324324
</Member>
@@ -387,7 +387,7 @@
387387
<param name="text">The <see cref="T:System.String" /> to compare with the current <see cref="T:Microsoft.Extensions.Primitives.StringSegment" />.</param>
388388
<summary>Checks if the specified <see cref="T:System.String" /> is equal to the current <see cref="T:Microsoft.Extensions.Primitives.StringSegment" />.</summary>
389389
<returns>
390-
<code>true</code> if the specified <see cref="T:System.String" /> is equal to the current <see cref="T:Microsoft.Extensions.Primitives.StringSegment" />; otherwise, <code>false</code>.</returns>
390+
<see langword="true" /> if the specified <see cref="T:System.String" /> is equal to the current <see cref="T:Microsoft.Extensions.Primitives.StringSegment" />; otherwise, <see langword="false" />.</returns>
391391
<remarks>To be added.</remarks>
392392
</Docs>
393393
</Member>
@@ -422,7 +422,7 @@
422422
<param name="comparisonType">One of the enumeration values that specifies the rules to use in the comparison.</param>
423423
<summary>Indicates whether the current object is equal to another object of the same type.</summary>
424424
<returns>
425-
<code>true</code> if the current object is equal to the other parameter; otherwise, <code>false</code>.</returns>
425+
<see langword="true" /> if the current object is equal to the other parameter; otherwise, <see langword="false" />.</returns>
426426
<remarks>To be added.</remarks>
427427
</Docs>
428428
</Member>
@@ -457,10 +457,10 @@
457457
<param name="comparisonType">One of the enumeration values that specifies the rules to use in the comparison.</param>
458458
<summary>Checks if the specified <see cref="T:System.String" /> is equal to the current <see cref="T:Microsoft.Extensions.Primitives.StringSegment" />.</summary>
459459
<returns>
460-
<code>true</code> if the specified <see cref="T:System.String" /> is equal to the current <see cref="T:Microsoft.Extensions.Primitives.StringSegment" />; otherwise, <code>false</code>.</returns>
460+
<see langword="true" /> if the specified <see cref="T:System.String" /> is equal to the current <see cref="T:Microsoft.Extensions.Primitives.StringSegment" />; otherwise, <see langword="false" />.</returns>
461461
<remarks>To be added.</remarks>
462462
<exception cref="T:System.ArgumentNullException">
463-
<paramref name="text" /> is <code>null</code>.
463+
<paramref name="text" /> is <see langword="null" />.
464464
</exception>
465465
</Docs>
466466
</Member>
@@ -496,7 +496,7 @@
496496
<summary>Determines whether two specified <see cref="T:Microsoft.Extensions.Primitives.StringSegment" /> objects have the same value. A parameter specifies the culture, case, and
497497
sort rules used in the comparison.</summary>
498498
<returns>
499-
<code>true</code> if the objects are equal; otherwise, <code>false</code>.</returns>
499+
<see langword="true" /> if the objects are equal; otherwise, <see langword="false" />.</returns>
500500
<remarks>To be added.</remarks>
501501
</Docs>
502502
</Member>
@@ -776,7 +776,7 @@
776776
was found; -1 if no character in <paramref name="anyOf" /> was found.</returns>
777777
<remarks>To be added.</remarks>
778778
<exception cref="T:System.ArgumentNullException">
779-
<paramref name="anyOf" /> is <code>null</code>.
779+
<paramref name="anyOf" /> is <see langword="null" />.
780780
</exception>
781781
<exception cref="T:System.ArgumentOutOfRangeException">
782782
<paramref name="startIndex" /> or <paramref name="count" /> is less than zero, or <paramref name="startIndex" /> + <paramref name="count" /> is
@@ -960,11 +960,11 @@
960960
<Parameter Name="right" Type="Microsoft.Extensions.Primitives.StringSegment" />
961961
</Parameters>
962962
<Docs>
963-
<param name="left">The first <see cref="T:Microsoft.Extensions.Primitives.StringSegment" /> to compare, or <code>null</code>.</param>
964-
<param name="right">The second <see cref="T:Microsoft.Extensions.Primitives.StringSegment" /> to compare, or <code>null</code>.</param>
963+
<param name="left">The first <see cref="T:Microsoft.Extensions.Primitives.StringSegment" /> to compare, or <see langword="null" />.</param>
964+
<param name="right">The second <see cref="T:Microsoft.Extensions.Primitives.StringSegment" /> to compare, or <see langword="null" />.</param>
965965
<summary>Checks if two specified <see cref="T:Microsoft.Extensions.Primitives.StringSegment" /> have the same value.</summary>
966966
<returns>
967-
<code>true</code> if the value of <paramref name="left" /> is the same as the value of <paramref name="right" />; otherwise, <code>false</code>.</returns>
967+
<see langword="true" /> if the value of <paramref name="left" /> is the same as the value of <paramref name="right" />; otherwise, <see langword="false" />.</returns>
968968
<remarks>To be added.</remarks>
969969
</Docs>
970970
</Member>
@@ -1083,11 +1083,11 @@
10831083
<Parameter Name="right" Type="Microsoft.Extensions.Primitives.StringSegment" />
10841084
</Parameters>
10851085
<Docs>
1086-
<param name="left">The first <see cref="T:Microsoft.Extensions.Primitives.StringSegment" /> to compare, or <code>null</code>.</param>
1087-
<param name="right">The second <see cref="T:Microsoft.Extensions.Primitives.StringSegment" /> to compare, or <code>null</code>.</param>
1086+
<param name="left">The first <see cref="T:Microsoft.Extensions.Primitives.StringSegment" /> to compare, or <see langword="null" />.</param>
1087+
<param name="right">The second <see cref="T:Microsoft.Extensions.Primitives.StringSegment" /> to compare, or <see langword="null" />.</param>
10881088
<summary>Checks if two specified <see cref="T:Microsoft.Extensions.Primitives.StringSegment" /> have different values.</summary>
10891089
<returns>
1090-
<code>true</code> if the value of <paramref name="left" /> is different from the value of <paramref name="right" />; otherwise, <code>false</code>.</returns>
1090+
<see langword="true" /> if the value of <paramref name="left" /> is different from the value of <paramref name="right" />; otherwise, <see langword="false" />.</returns>
10911091
<remarks>To be added.</remarks>
10921092
</Docs>
10931093
</Member>
@@ -1154,10 +1154,10 @@
11541154
<param name="comparisonType">One of the enumeration values that specifies the rules to use in the comparison.</param>
11551155
<summary>Checks if the beginning of this <see cref="T:Microsoft.Extensions.Primitives.StringSegment" /> matches the specified <see cref="T:System.String" /> when compared using the specified <paramref name="comparisonType" />.</summary>
11561156
<returns>
1157-
<code>true</code> if <paramref name="text" /> matches the beginning of this <see cref="T:Microsoft.Extensions.Primitives.StringSegment" />; otherwise, <code>false</code>.</returns>
1157+
<see langword="true" /> if <paramref name="text" /> matches the beginning of this <see cref="T:Microsoft.Extensions.Primitives.StringSegment" />; otherwise, <see langword="false" />.</returns>
11581158
<remarks>To be added.</remarks>
11591159
<exception cref="T:System.ArgumentNullException">
1160-
<paramref name="text" /> is <code>null</code>.
1160+
<paramref name="text" /> is <see langword="null" />.
11611161
</exception>
11621162
</Docs>
11631163
</Member>
@@ -1334,8 +1334,8 @@
13341334
</ReturnValue>
13351335
<Parameters />
13361336
<Docs>
1337-
<summary>Returns the <see cref="T:System.String" /> represented by this <see cref="T:Microsoft.Extensions.Primitives.StringSegment" /> or <code>String.Empty</code> if the <see cref="T:Microsoft.Extensions.Primitives.StringSegment" /> does not contain a value.</summary>
1338-
<returns>The <see cref="T:System.String" /> represented by this <see cref="T:Microsoft.Extensions.Primitives.StringSegment" /> or <code>String.Empty</code> if the <see cref="T:Microsoft.Extensions.Primitives.StringSegment" /> does not contain a value.</returns>
1337+
<summary>Returns the <see cref="T:System.String" /> represented by this <see cref="T:Microsoft.Extensions.Primitives.StringSegment" /> or <see cref="F:System.String.Empty" /> if the <see cref="T:Microsoft.Extensions.Primitives.StringSegment" /> does not contain a value.</summary>
1338+
<returns>The <see cref="T:System.String" /> represented by this <see cref="T:Microsoft.Extensions.Primitives.StringSegment" /> or <see cref="F:System.String.Empty" /> if the <see cref="T:Microsoft.Extensions.Primitives.StringSegment" /> does not contain a value.</returns>
13391339
<remarks>To be added.</remarks>
13401340
</Docs>
13411341
</Member>

xml/System.IO.Pipes/PipesAclExtensions.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -86,10 +86,10 @@
8686
<param name="pipeSecurity">The security information to apply to the pipe stream.</param>
8787
<summary>Changes the security attributes of an existing pipe stream.</summary>
8888
<remarks>To be added.</remarks>
89-
<exception cref="System.ArgumentNullException">
89+
<exception cref="T:System.ArgumentNullException">
9090
<paramref name="pipeSecurity" /> is <see langword="null" />.
9191
</exception>
92-
<exception cref="System.IO.IOException">
92+
<exception cref="T:System.IO.IOException">
9393
<paramref name="stream" /> is a disconnected <see cref="T:System.IO.Pipes.NamedPipeClientStream" /> instance.
9494
</exception>
9595
</Docs>

xml/System.Reflection.Metadata.Ecma335/InstructionEncoder.xml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@
112112
</Parameters>
113113
<Docs>
114114
<param name="methodHandle">To be added.</param>
115-
<summary>Encodes <code>call</code> instruction and its operand.</summary>
115+
<summary>Encodes <c>call</c> instruction and its operand.</summary>
116116
<remarks>To be added.</remarks>
117117
</Docs>
118118
</Member>
@@ -141,7 +141,7 @@
141141
</Parameters>
142142
<Docs>
143143
<param name="methodHandle">To be added.</param>
144-
<summary>Encodes <code>call</code> instruction and its operand.</summary>
144+
<summary>Encodes <c>call</c> instruction and its operand.</summary>
145145
<remarks>To be added.</remarks>
146146
</Docs>
147147
</Member>
@@ -170,7 +170,7 @@
170170
</Parameters>
171171
<Docs>
172172
<param name="methodHandle">To be added.</param>
173-
<summary>Encodes <code>call</code> instruction and its operand.</summary>
173+
<summary>Encodes <c>call</c> instruction and its operand.</summary>
174174
<remarks>To be added.</remarks>
175175
</Docs>
176176
</Member>
@@ -199,7 +199,7 @@
199199
</Parameters>
200200
<Docs>
201201
<param name="methodHandle">To be added.</param>
202-
<summary>Encodes <code>call</code> instruction and its operand.</summary>
202+
<summary>Encodes <c>call</c> instruction and its operand.</summary>
203203
<remarks>To be added.</remarks>
204204
</Docs>
205205
</Member>
@@ -228,7 +228,7 @@
228228
</Parameters>
229229
<Docs>
230230
<param name="signature">To be added.</param>
231-
<summary>Encodes <code>calli</code> instruction and its operand.</summary>
231+
<summary>Encodes <c>calli</c> instruction and its operand.</summary>
232232
<remarks>To be added.</remarks>
233233
</Docs>
234234
</Member>
@@ -576,7 +576,7 @@ If `null` the encoder doesn't support construction of control flow.
576576
</Parameters>
577577
<Docs>
578578
<param name="handle">To be added.</param>
579-
<summary>Encodes <code>ldstr</code> instruction and its operand.</summary>
579+
<summary>Encodes <c>ldstr</c> instruction and its operand.</summary>
580580
<remarks>To be added.</remarks>
581581
</Docs>
582582
</Member>

xml/System.Threading.Tasks.Dataflow/BatchedJoinBlock`2.xml

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -372,9 +372,7 @@ After `Fault` has been called on a dataflow block, that block will complete, suc
372372
<param name="messageConsumed">
373373
<see langword="true" /> if the message was successfully consumed. <see langword="false" /> otherwise.</param>
374374
<summary>Passes the ownership of the message identified by the <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader" /> from this <see cref="T:System.Threading.Tasks.Dataflow.ISourceBlock`1" /> instance to the <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1" />.</summary>
375-
<returns> The value of the consumed message. This may correspond to a different <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader" /> instance than was previously reserved and passed as the <paramref name="messageHeader" /> to <see cref="M:ConsumeMessage" />. The consuming <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1" /> must use the returned value instead of the value passed as messageValue through <see cref="M:OfferMessage" />.
376-
If the message requested is not available, the return value will be <see langword="null" /> (Nothing in Visual Basic).
377-
</returns>
375+
<returns>The value of the consumed message. This may correspond to a different <see cref="T:System.Threading.Tasks.Dataflow.DataflowMessageHeader" /> instance than was previously reserved and passed as the <paramref name="messageHeader" /> to <see cref="M:ConsumeMessage" />. The consuming <see cref="T:System.Threading.Tasks.Dataflow.ITargetBlock`1" /> must use the returned value instead of the value passed as messageValue through <c>OfferMessage</c>. If the message requested is not available, the return value will be <see langword="null" /> (Nothing in Visual Basic).</returns>
378376
<remarks>
379377
<format type="text/markdown"><![CDATA[
380378

0 commit comments

Comments
 (0)