Skip to content

Commit c62bdd1

Browse files
jstedfastjstedfast
committed
Use <see langword="x"/> instead of <c>x</c>
* Use <see langword="null"/> instead of <c>null</c> * Use <see langword="true"/> instead of <c>true</c> * Use <see langword="false"/> instead of <c>false</c>
1 parent f54c53f commit c62bdd1

File tree

143 files changed

+2023
-2023
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

143 files changed

+2023
-2023
lines changed

‎MailKit/AccessControl.cs‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -50,9 +50,9 @@ public class AccessControl
5050
/// <param name="name">The identifier name.</param>
5151
/// <param name="rights">The access rights.</param>
5252
/// <exception cref="System.ArgumentNullException">
53-
/// <para><paramref name="name"/> is <c>null</c>.</para>
53+
/// <para><paramref name="name"/> is <see langword="null" />.</para>
5454
/// <para>-or-</para>
55-
/// <para><paramref name="rights"/> is <c>null</c>.</para>
55+
/// <para><paramref name="rights"/> is <see langword="null" />.</para>
5656
/// </exception>
5757
public AccessControl (string name, IEnumerable<AccessRight> rights)
5858
{
@@ -73,9 +73,9 @@ public AccessControl (string name, IEnumerable<AccessRight> rights)
7373
/// <param name="name">The identifier name.</param>
7474
/// <param name="rights">The access rights.</param>
7575
/// <exception cref="System.ArgumentNullException">
76-
/// <para><paramref name="name"/> is <c>null</c>.</para>
76+
/// <para><paramref name="name"/> is <see langword="null" />.</para>
7777
/// <para>-or-</para>
78-
/// <para><paramref name="rights"/> is <c>null</c>.</para>
78+
/// <para><paramref name="rights"/> is <see langword="null" />.</para>
7979
/// </exception>
8080
public AccessControl (string name, string rights)
8181
{
@@ -95,7 +95,7 @@ public AccessControl (string name, string rights)
9595
/// </remarks>
9696
/// <param name="name">The identifier name.</param>
9797
/// <exception cref="System.ArgumentNullException">
98-
/// <paramref name="name"/> is <c>null</c>.
98+
/// <paramref name="name"/> is <see langword="null" />.
9999
/// </exception>
100100
public AccessControl (string name)
101101
{

‎MailKit/AccessControlList.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ public class AccessControlList : List<AccessControl>
4747
/// </remarks>
4848
/// <param name="controls">The list of access controls.</param>
4949
/// <exception cref="System.ArgumentNullException">
50-
/// <paramref name="controls"/> is <c>null</c>.
50+
/// <paramref name="controls"/> is <see langword="null" />.
5151
/// </exception>
5252
public AccessControlList (IEnumerable<AccessControl> controls) : base (controls)
5353
{

‎MailKit/AccessRight.cs‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -154,8 +154,8 @@ public AccessRight (char right)
154154
/// Determines whether the specified <see cref="MailKit.AccessRight"/> is equal to the current <see cref="MailKit.AccessRight"/>.
155155
/// </remarks>
156156
/// <param name="other">The <see cref="MailKit.AccessRight"/> to compare with the current <see cref="MailKit.AccessRight"/>.</param>
157-
/// <returns><c>true</c> if the specified <see cref="MailKit.AccessRight"/> is equal to the current
158-
/// <see cref="MailKit.AccessRight"/>; otherwise, <c>false</c>.</returns>
157+
/// <returns><see langword="true" /> if the specified <see cref="MailKit.AccessRight"/> is equal to the current
158+
/// <see cref="MailKit.AccessRight"/>; otherwise, <see langword="false" />.</returns>
159159
public bool Equals (AccessRight other)
160160
{
161161
return other.Right == Right;
@@ -169,7 +169,7 @@ public bool Equals (AccessRight other)
169169
/// <remarks>
170170
/// Determines whether two access rights are equal.
171171
/// </remarks>
172-
/// <returns><c>true</c> if <paramref name="right1"/> and <paramref name="right2"/> are equal; otherwise, <c>false</c>.</returns>
172+
/// <returns><see langword="true" /> if <paramref name="right1"/> and <paramref name="right2"/> are equal; otherwise, <see langword="false" />.</returns>
173173
/// <param name="right1">The first access right to compare.</param>
174174
/// <param name="right2">The second access right to compare.</param>
175175
public static bool operator == (AccessRight right1, AccessRight right2)
@@ -183,7 +183,7 @@ public bool Equals (AccessRight other)
183183
/// <remarks>
184184
/// Determines whether two access rights are not equal.
185185
/// </remarks>
186-
/// <returns><c>true</c> if <paramref name="right1"/> and <paramref name="right2"/> are not equal; otherwise, <c>false</c>.</returns>
186+
/// <returns><see langword="true" /> if <paramref name="right1"/> and <paramref name="right2"/> are not equal; otherwise, <see langword="false" />.</returns>
187187
/// <param name="right1">The first access right to compare.</param>
188188
/// <param name="right2">The second access right to compare.</param>
189189
public static bool operator != (AccessRight right1, AccessRight right2)
@@ -198,8 +198,8 @@ public bool Equals (AccessRight other)
198198
/// Determines whether the specified <see cref="System.Object"/> is equal to the current <see cref="MailKit.AccessRight"/>.
199199
/// </remarks>
200200
/// <param name="obj">The <see cref="System.Object"/> to compare with the current <see cref="MailKit.AccessRight"/>.</param>
201-
/// <returns><c>true</c> if the specified <see cref="System.Object"/> is equal to the current <see cref="MailKit.AccessRight"/>;
202-
/// otherwise, <c>false</c>.</returns>
201+
/// <returns><see langword="true" /> if the specified <see cref="System.Object"/> is equal to the current <see cref="MailKit.AccessRight"/>;
202+
/// otherwise, <see langword="false" />.</returns>
203203
public override bool Equals (object obj)
204204
{
205205
return obj is AccessRight right && right.Right == Right;

‎MailKit/AccessRights.cs‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ public class AccessRights : ICollection<AccessRight>
4747
/// </remarks>
4848
/// <param name="rights">The access rights.</param>
4949
/// <exception cref="System.ArgumentNullException">
50-
/// <paramref name="rights"/> is <c>null</c>.
50+
/// <paramref name="rights"/> is <see langword="null" />.
5151
/// </exception>
5252
public AccessRights (IEnumerable<AccessRight> rights)
5353
{
@@ -62,7 +62,7 @@ public AccessRights (IEnumerable<AccessRight> rights)
6262
/// </remarks>
6363
/// <param name="rights">The access rights.</param>
6464
/// <exception cref="System.ArgumentNullException">
65-
/// <paramref name="rights"/> is <c>null</c>.
65+
/// <paramref name="rights"/> is <see langword="null" />.
6666
/// </exception>
6767
public AccessRights (string rights)
6868
{
@@ -96,7 +96,7 @@ public int Count {
9696
/// <remarks>
9797
/// Gets whether or not this set of access rights is read only.
9898
/// </remarks>
99-
/// <value><c>true</c> if this collection is read only; otherwise, <c>false</c>.</value>
99+
/// <value><see langword="true" /> if this collection is read only; otherwise, <see langword="false" />.</value>
100100
public bool IsReadOnly {
101101
get { return false; }
102102
}
@@ -119,7 +119,7 @@ void ICollection<AccessRight>.Add (AccessRight right)
119119
/// <remarks>
120120
/// Adds the specified access right if it is not already included.
121121
/// </remarks>
122-
/// <returns><c>true</c> if the right was added; otherwise, <c>false</c>.</returns>
122+
/// <returns><see langword="true" /> if the right was added; otherwise, <see langword="false" />.</returns>
123123
/// <param name="right">The access right.</param>
124124
public bool Add (AccessRight right)
125125
{
@@ -137,7 +137,7 @@ public bool Add (AccessRight right)
137137
/// <remarks>
138138
/// Adds the right specified by the given character.
139139
/// </remarks>
140-
/// <returns><c>true</c> if the right was added; otherwise, <c>false</c>.</returns>
140+
/// <returns><see langword="true" /> if the right was added; otherwise, <see langword="false" />.</returns>
141141
/// <param name="right">The right.</param>
142142
public bool Add (char right)
143143
{
@@ -152,7 +152,7 @@ public bool Add (char right)
152152
/// </remarks>
153153
/// <param name="rights">The rights.</param>
154154
/// <exception cref="System.ArgumentNullException">
155-
/// <paramref name="rights"/> is <c>null</c>.
155+
/// <paramref name="rights"/> is <see langword="null" />.
156156
/// </exception>
157157
public void AddRange (string rights)
158158
{
@@ -171,7 +171,7 @@ public void AddRange (string rights)
171171
/// </remarks>
172172
/// <param name="rights">The rights.</param>
173173
/// <exception cref="System.ArgumentNullException">
174-
/// <paramref name="rights"/> is <c>null</c>.
174+
/// <paramref name="rights"/> is <see langword="null" />.
175175
/// </exception>
176176
public void AddRange (IEnumerable<AccessRight> rights)
177177
{
@@ -199,7 +199,7 @@ public void Clear ()
199199
/// <remarks>
200200
/// Determines whether or not the set of access rights already contains the specified right
201201
/// </remarks>
202-
/// <returns><value>true</value> if the specified right exists; otherwise <value>false</value>.</returns>
202+
/// <returns><see langword="true" /> if the specified right exists; otherwise, <see langword="false" />.</returns>
203203
/// <param name="right">The access right.</param>
204204
public bool Contains (AccessRight right)
205205
{
@@ -216,7 +216,7 @@ public bool Contains (AccessRight right)
216216
/// <param name="array">The array.</param>
217217
/// <param name="arrayIndex">The array index.</param>
218218
/// <exception cref="System.ArgumentNullException">
219-
/// <paramref name="array"/> is <c>null</c>.
219+
/// <paramref name="array"/> is <see langword="null" />.
220220
/// </exception>
221221
/// <exception cref="System.ArgumentOutOfRangeException">
222222
/// <paramref name="arrayIndex"/> is out of range.
@@ -238,7 +238,7 @@ public void CopyTo (AccessRight[] array, int arrayIndex)
238238
/// <remarks>
239239
/// Removes the specified access right.
240240
/// </remarks>
241-
/// <returns><value>true</value> if the access right was removed; otherwise <value>false</value>.</returns>
241+
/// <returns><see langword="true" /> if the access right was removed; otherwise, <see langword="false" />.</returns>
242242
/// <param name="right">The access right.</param>
243243
public bool Remove (AccessRight right)
244244
{

‎MailKit/AlertEventArgs.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ public class AlertEventArgs : EventArgs
4545
/// </remarks>
4646
/// <param name="message">The alert message.</param>
4747
/// <exception cref="System.ArgumentNullException">
48-
/// <paramref name="message"/> is <c>null</c>.
48+
/// <paramref name="message"/> is <see langword="null" />.
4949
/// </exception>
5050
public AlertEventArgs (string message)
5151
{

‎MailKit/Annotation.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ public class Annotation
4646
/// </remarks>
4747
/// <param name="entry">The annotation entry.</param>
4848
/// <exception cref="System.ArgumentNullException">
49-
/// <paramref name="entry"/> is <c>null</c>.
49+
/// <paramref name="entry"/> is <see langword="null" />.
5050
/// </exception>
5151
public Annotation (AnnotationEntry entry)
5252
{

‎MailKit/AnnotationAttribute.cs‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ public class AnnotationAttribute : IEquatable<AnnotationAttribute>
106106
/// </remarks>
107107
/// <param name="specifier">The annotation attribute specifier.</param>
108108
/// <exception cref="System.ArgumentNullException">
109-
/// <paramref name="specifier"/> is <c>null</c>.
109+
/// <paramref name="specifier"/> is <see langword="null" />.
110110
/// </exception>
111111
/// <exception cref="System.ArgumentException">
112112
/// <paramref name="specifier"/> contains illegal characters.
@@ -179,8 +179,8 @@ public string Specifier {
179179
/// Determines whether the specified <see cref="MailKit.AnnotationAttribute"/> is equal to the current <see cref="MailKit.AnnotationAttribute"/>.
180180
/// </remarks>
181181
/// <param name="other">The <see cref="MailKit.AnnotationAttribute"/> to compare with the current <see cref="MailKit.AnnotationAttribute"/>.</param>
182-
/// <returns><c>true</c> if the specified <see cref="MailKit.AnnotationAttribute"/> is equal to the current
183-
/// <see cref="MailKit.AnnotationAttribute"/>; otherwise, <c>false</c>.</returns>
182+
/// <returns><see langword="true" /> if the specified <see cref="MailKit.AnnotationAttribute"/> is equal to the current
183+
/// <see cref="MailKit.AnnotationAttribute"/>; otherwise, <see langword="false" />.</returns>
184184
public bool Equals (AnnotationAttribute other)
185185
{
186186
return other?.Specifier == Specifier;
@@ -194,7 +194,7 @@ public bool Equals (AnnotationAttribute other)
194194
/// <remarks>
195195
/// Determines whether two annotation attributes are equal.
196196
/// </remarks>
197-
/// <returns><c>true</c> if <paramref name="attr1"/> and <paramref name="attr2"/> are equal; otherwise, <c>false</c>.</returns>
197+
/// <returns><see langword="true" /> if <paramref name="attr1"/> and <paramref name="attr2"/> are equal; otherwise, <see langword="false" />.</returns>
198198
/// <param name="attr1">The first annotation attribute to compare.</param>
199199
/// <param name="attr2">The second annotation attribute to compare.</param>
200200
public static bool operator == (AnnotationAttribute attr1, AnnotationAttribute attr2)
@@ -208,7 +208,7 @@ public bool Equals (AnnotationAttribute other)
208208
/// <remarks>
209209
/// Determines whether two annotation attributes are not equal.
210210
/// </remarks>
211-
/// <returns><c>true</c> if <paramref name="attr1"/> and <paramref name="attr2"/> are not equal; otherwise, <c>false</c>.</returns>
211+
/// <returns><see langword="true" /> if <paramref name="attr1"/> and <paramref name="attr2"/> are not equal; otherwise, <see langword="false" />.</returns>
212212
/// <param name="attr1">The first annotation attribute to compare.</param>
213213
/// <param name="attr2">The second annotation attribute to compare.</param>
214214
public static bool operator != (AnnotationAttribute attr1, AnnotationAttribute attr2)
@@ -223,8 +223,8 @@ public bool Equals (AnnotationAttribute other)
223223
/// Determines whether the specified <see cref="System.Object"/> is equal to the current <see cref="MailKit.AnnotationAttribute"/>.
224224
/// </remarks>
225225
/// <param name="obj">The <see cref="System.Object"/> to compare with the current <see cref="MailKit.AnnotationAttribute"/>.</param>
226-
/// <returns><c>true</c> if the specified <see cref="System.Object"/> is equal to the current
227-
/// <see cref="MailKit.AnnotationAttribute"/>; otherwise, <c>false</c>.</returns>
226+
/// <returns><see langword="true" /> if the specified <see cref="System.Object"/> is equal to the current
227+
/// <see cref="MailKit.AnnotationAttribute"/>; otherwise, <see langword="false" />.</returns>
228228
public override bool Equals (object obj)
229229
{
230230
return obj is AnnotationAttribute attribute && attribute.Specifier == Specifier;

‎MailKit/AnnotationEntry.cs‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -185,7 +185,7 @@ static void ValidatePartSpecifier (string partSpecifier)
185185
/// <param name="path">The annotation entry path.</param>
186186
/// <param name="scope">The scope of the annotation.</param>
187187
/// <exception cref="System.ArgumentNullException">
188-
/// <paramref name="path"/> is <c>null</c>.
188+
/// <paramref name="path"/> is <see langword="null" />.
189189
/// </exception>
190190
/// <exception cref="System.ArgumentException">
191191
/// <paramref name="path"/> is invalid.
@@ -214,9 +214,9 @@ public AnnotationEntry (string path, AnnotationScope scope = AnnotationScope.Bot
214214
/// <param name="path">The annotation entry path.</param>
215215
/// <param name="scope">The scope of the annotation.</param>
216216
/// <exception cref="System.ArgumentNullException">
217-
/// <para><paramref name="partSpecifier"/> is <c>null</c>.</para>
217+
/// <para><paramref name="partSpecifier"/> is <see langword="null" />.</para>
218218
/// <para>-or-</para>
219-
/// <para><paramref name="path"/> is <c>null</c>.</para>
219+
/// <para><paramref name="path"/> is <see langword="null" />.</para>
220220
/// </exception>
221221
/// <exception cref="System.ArgumentException">
222222
/// <para><paramref name="partSpecifier"/> is invalid.</para>
@@ -248,9 +248,9 @@ public AnnotationEntry (string partSpecifier, string path, AnnotationScope scope
248248
/// <param name="path">The annotation entry path.</param>
249249
/// <param name="scope">The scope of the annotation.</param>
250250
/// <exception cref="System.ArgumentNullException">
251-
/// <para><paramref name="part"/> is <c>null</c>.</para>
251+
/// <para><paramref name="part"/> is <see langword="null" />.</para>
252252
/// <para>-or-</para>
253-
/// <para><paramref name="path"/> is <c>null</c>.</para>
253+
/// <para><paramref name="path"/> is <see langword="null" />.</para>
254254
/// </exception>
255255
/// <exception cref="System.ArgumentException">
256256
/// <paramref name="path"/> is invalid.
@@ -325,8 +325,8 @@ public AnnotationScope Scope {
325325
/// Determines whether the specified <see cref="MailKit.AnnotationEntry"/> is equal to the current <see cref="MailKit.AnnotationEntry"/>.
326326
/// </remarks>
327327
/// <param name="other">The <see cref="MailKit.AnnotationEntry"/> to compare with the current <see cref="MailKit.AnnotationEntry"/>.</param>
328-
/// <returns><c>true</c> if the specified <see cref="MailKit.AnnotationEntry"/> is equal to the current
329-
/// <see cref="MailKit.AnnotationEntry"/>; otherwise, <c>false</c>.</returns>
328+
/// <returns><see langword="true" /> if the specified <see cref="MailKit.AnnotationEntry"/> is equal to the current
329+
/// <see cref="MailKit.AnnotationEntry"/>; otherwise, <see langword="false" />.</returns>
330330
public bool Equals (AnnotationEntry other)
331331
{
332332
return other?.Entry == Entry;
@@ -340,7 +340,7 @@ public bool Equals (AnnotationEntry other)
340340
/// <remarks>
341341
/// Determines whether two annotation entries are equal.
342342
/// </remarks>
343-
/// <returns><c>true</c> if <paramref name="entry1"/> and <paramref name="entry2"/> are equal; otherwise, <c>false</c>.</returns>
343+
/// <returns><see langword="true" /> if <paramref name="entry1"/> and <paramref name="entry2"/> are equal; otherwise, <see langword="false" />.</returns>
344344
/// <param name="entry1">The first annotation entry to compare.</param>
345345
/// <param name="entry2">The second annotation entry to compare.</param>
346346
public static bool operator == (AnnotationEntry entry1, AnnotationEntry entry2)
@@ -354,7 +354,7 @@ public bool Equals (AnnotationEntry other)
354354
/// <remarks>
355355
/// Determines whether two annotation entries are not equal.
356356
/// </remarks>
357-
/// <returns><c>true</c> if <paramref name="entry1"/> and <paramref name="entry2"/> are not equal; otherwise, <c>false</c>.</returns>
357+
/// <returns><see langword="true" /> if <paramref name="entry1"/> and <paramref name="entry2"/> are not equal; otherwise, <see langword="false" />.</returns>
358358
/// <param name="entry1">The first annotation entry to compare.</param>
359359
/// <param name="entry2">The second annotation entry to compare.</param>
360360
public static bool operator != (AnnotationEntry entry1, AnnotationEntry entry2)
@@ -369,8 +369,8 @@ public bool Equals (AnnotationEntry other)
369369
/// Determines whether the specified <see cref="System.Object"/> is equal to the current <see cref="MailKit.AnnotationEntry"/>.
370370
/// </remarks>
371371
/// <param name="obj">The <see cref="System.Object"/> to compare with the current <see cref="MailKit.AnnotationEntry"/>.</param>
372-
/// <returns><c>true</c> if the specified <see cref="System.Object"/> is equal to the current
373-
/// <see cref="MailKit.AnnotationEntry"/>; otherwise, <c>false</c>.</returns>
372+
/// <returns><see langword="true" /> if the specified <see cref="System.Object"/> is equal to the current
373+
/// <see cref="MailKit.AnnotationEntry"/>; otherwise, <see langword="false" />.</returns>
374374
public override bool Equals (object obj)
375375
{
376376
return obj is AnnotationEntry entry && entry.Entry == Entry;
@@ -409,7 +409,7 @@ public override string ToString ()
409409
/// <param name="entry">The annotation entry.</param>
410410
/// <returns>The parsed annotation entry.</returns>
411411
/// <exception cref="System.ArgumentNullException">
412-
/// <paramref name="entry"/> is <c>null</c>.
412+
/// <paramref name="entry"/> is <see langword="null" />.
413413
/// </exception>
414414
/// <exception cref="System.FormatException">
415415
/// <paramref name="entry"/> does not conform to the annotation entry syntax.

‎MailKit/AnnotationsChangedEventArgs.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ internal AnnotationsChangedEventArgs (int index) : base (index)
5858
/// <param name="index">The message index.</param>
5959
/// <param name="annotations">The annotations that changed.</param>
6060
/// <exception cref="System.ArgumentNullException">
61-
/// <paramref name="annotations"/> is <c>null</c>.
61+
/// <paramref name="annotations"/> is <see langword="null" />.
6262
/// </exception>
6363
public AnnotationsChangedEventArgs (int index, IEnumerable<Annotation> annotations) : base (index)
6464
{

0 commit comments

Comments
 (0)