Skip to content

Commit 0e5d128

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 8520ff9 commit 0e5d128

File tree

110 files changed

+572
-572
lines changed

Some content is hidden

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

110 files changed

+572
-572
lines changed

‎MimeKit/AttachmentCollection.cs

+7-7
Original file line numberDiff line numberDiff line change
@@ -57,10 +57,10 @@ public class AttachmentCollection : IList<MimeEntity>
5757
/// </summary>
5858
/// <remarks>
5959
/// <para>Creates a new <see cref="AttachmentCollection"/>.</para>
60-
/// <para>If <paramref name="linkedResources"/> is <c>true</c>, then the attachments
60+
/// <para>If <paramref name="linkedResources"/> is <see langword="true" />, then the attachments
6161
/// are treated as if they are linked to another <see cref="MimePart"/>.</para>
6262
/// </remarks>
63-
/// <param name="linkedResources">If set to <c>true</c>; the attachments are treated as linked resources.</param>
63+
/// <param name="linkedResources">If set to <see langword="true" />; the attachments are treated as linked resources.</param>
6464
public AttachmentCollection (bool linkedResources)
6565
{
6666
attachments = new List<MimeEntity> ();
@@ -96,7 +96,7 @@ public int Count {
9696
/// <remarks>
9797
/// A <see cref="AttachmentCollection"/> is never read-only.
9898
/// </remarks>
99-
/// <value><c>true</c> if the collection is read only; otherwise, <c>false</c>.</value>
99+
/// <value><see langword="true" /> if the collection is read only; otherwise, <see langword="false" />.</value>
100100
public bool IsReadOnly {
101101
get { return false; }
102102
}
@@ -848,7 +848,7 @@ public void Clear ()
848848
/// <remarks>
849849
/// Removes all attachments from the collection, optionally disposing them in the process.
850850
/// </remarks>
851-
/// <param name="dispose"><c>true</c> if all the attachments should be disposed; otherwise, <c>false</c>.</param>
851+
/// <param name="dispose"><see langword="true" /> if all the attachments should be disposed; otherwise, <see langword="false" />.</param>
852852
public void Clear (bool dispose)
853853
{
854854
if (dispose) {
@@ -865,8 +865,8 @@ public void Clear (bool dispose)
865865
/// <remarks>
866866
/// Determines whether the collection contains the specified attachment.
867867
/// </remarks>
868-
/// <returns><value>true</value> if the specified attachment exists;
869-
/// otherwise <value>false</value>.</returns>
868+
/// <returns><see langword="true" /> if the specified attachment exists;
869+
/// otherwise, <see langword="false" />.</returns>
870870
/// <param name="attachment">The attachment.</param>
871871
/// <exception cref="System.ArgumentNullException">
872872
/// <paramref name="attachment"/> is <see langword="null"/>.
@@ -955,7 +955,7 @@ public void Insert (int index, MimeEntity attachment)
955955
/// <remarks>
956956
/// Removes the specified attachment.
957957
/// </remarks>
958-
/// <returns><value>true</value> if the attachment was removed; otherwise <value>false</value>.</returns>
958+
/// <returns><see langword="true" /> if the attachment was removed; otherwise, <see langword="false" />.</returns>
959959
/// <param name="attachment">The attachment.</param>
960960
/// <exception cref="System.ArgumentNullException">
961961
/// <paramref name="attachment"/> is <see langword="null"/>.

‎MimeKit/ContentDisposition.cs

+12-12
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,7 @@ public string Disposition {
145145
/// <remarks>
146146
/// A convenience property to determine if the entity should be considered an attachment or not.
147147
/// </remarks>
148-
/// <value><c>true</c> if the <see cref="MimePart"/> is an attachment; otherwise, <c>false</c>.</value>
148+
/// <value><see langword="true" /> if the <see cref="MimePart"/> is an attachment; otherwise, <see langword="false" />.</value>
149149
public bool IsAttachment {
150150
get { return disposition.Equals (Attachment, StringComparison.OrdinalIgnoreCase); }
151151
set { disposition = value ? Attachment : Inline; }
@@ -356,7 +356,7 @@ internal string Encode (FormatOptions options, Encoding charset)
356356
/// <returns>The serialized string.</returns>
357357
/// <param name="options">The formatting options.</param>
358358
/// <param name="charset">The charset to be used when encoding the parameter values.</param>
359-
/// <param name="encode">If set to <c>true</c>, the parameter values will be encoded.</param>
359+
/// <param name="encode">If set to <see langword="true" />, the parameter values will be encoded.</param>
360360
/// <exception cref="System.ArgumentNullException">
361361
/// <para><paramref name="options"/> is <see langword="null"/>.</para>
362362
/// <para>-or-</para>
@@ -394,7 +394,7 @@ public string ToString (FormatOptions options, Encoding charset, bool encode)
394394
/// </remarks>
395395
/// <returns>The serialized string.</returns>
396396
/// <param name="charset">The charset to be used when encoding the parameter values.</param>
397-
/// <param name="encode">If set to <c>true</c>, the parameter values will be encoded.</param>
397+
/// <param name="encode">If set to <see langword="true" />, the parameter values will be encoded.</param>
398398
/// <exception cref="System.ArgumentNullException">
399399
/// <paramref name="charset"/> is <see langword="null"/>.
400400
/// </exception>
@@ -411,7 +411,7 @@ public string ToString (Encoding charset, bool encode)
411411
/// optionally encoding the parameters as they would be encoded for transport.
412412
/// </remarks>
413413
/// <returns>The serialized string.</returns>
414-
/// <param name="encode">If set to <c>true</c>, the parameter values will be encoded.</param>
414+
/// <param name="encode">If set to <see langword="true" />, the parameter values will be encoded.</param>
415415
public string ToString (bool encode)
416416
{
417417
return ToString (FormatOptions.Default, Encoding.UTF8, encode);
@@ -532,7 +532,7 @@ internal static bool TryParse (ParserOptions options, byte[] text, ref int index
532532
/// Parses a Content-Disposition value from the supplied buffer starting at the given index
533533
/// and spanning across the specified number of bytes.
534534
/// </remarks>
535-
/// <returns><c>true</c> if the disposition was successfully parsed; otherwise, <c>false</c>.</returns>
535+
/// <returns><see langword="true" /> if the disposition was successfully parsed; otherwise, <see langword="false" />.</returns>
536536
/// <param name="options">The parser options.</param>
537537
/// <param name="buffer">The input buffer.</param>
538538
/// <param name="startIndex">The starting index of the input buffer.</param>
@@ -563,7 +563,7 @@ public static bool TryParse (ParserOptions options, byte[] buffer, int startInde
563563
/// Parses a Content-Disposition value from the supplied buffer starting at the given index
564564
/// and spanning across the specified number of bytes.
565565
/// </remarks>
566-
/// <returns><c>true</c> if the disposition was successfully parsed; otherwise, <c>false</c>.</returns>
566+
/// <returns><see langword="true" /> if the disposition was successfully parsed; otherwise, <see langword="false" />.</returns>
567567
/// <param name="buffer">The input buffer.</param>
568568
/// <param name="startIndex">The starting index of the input buffer.</param>
569569
/// <param name="length">The number of bytes in the input buffer to parse.</param>
@@ -586,7 +586,7 @@ public static bool TryParse (byte[] buffer, int startIndex, int length, out Cont
586586
/// <remarks>
587587
/// Parses a Content-Disposition value from the supplied buffer starting at the specified index.
588588
/// </remarks>
589-
/// <returns><c>true</c> if the disposition was successfully parsed; otherwise, <c>false</c>.</returns>
589+
/// <returns><see langword="true" /> if the disposition was successfully parsed; otherwise, <see langword="false" />.</returns>
590590
/// <param name="options">The parser options.</param>
591591
/// <param name="buffer">The input buffer.</param>
592592
/// <param name="startIndex">The starting index of the input buffer.</param>
@@ -614,7 +614,7 @@ public static bool TryParse (ParserOptions options, byte[] buffer, int startInde
614614
/// <remarks>
615615
/// Parses a Content-Disposition value from the supplied buffer starting at the specified index.
616616
/// </remarks>
617-
/// <returns><c>true</c> if the disposition was successfully parsed; otherwise, <c>false</c>.</returns>
617+
/// <returns><see langword="true" /> if the disposition was successfully parsed; otherwise, <see langword="false" />.</returns>
618618
/// <param name="buffer">The input buffer.</param>
619619
/// <param name="startIndex">The starting index of the input buffer.</param>
620620
/// <param name="disposition">The parsed disposition.</param>
@@ -635,7 +635,7 @@ public static bool TryParse (byte[] buffer, int startIndex, out ContentDispositi
635635
/// <remarks>
636636
/// Parses a Content-Disposition value from the specified buffer.
637637
/// </remarks>
638-
/// <returns><c>true</c> if the disposition was successfully parsed; otherwise, <c>false</c>.</returns>
638+
/// <returns><see langword="true" /> if the disposition was successfully parsed; otherwise, <see langword="false" />.</returns>
639639
/// <param name="options">The parser options.</param>
640640
/// <param name="buffer">The input buffer.</param>
641641
/// <param name="disposition">The parsed disposition.</param>
@@ -659,7 +659,7 @@ public static bool TryParse (ParserOptions options, byte[] buffer, out ContentDi
659659
/// <remarks>
660660
/// Parses a Content-Disposition value from the specified buffer.
661661
/// </remarks>
662-
/// <returns><c>true</c> if the disposition was successfully parsed; otherwise, <c>false</c>.</returns>
662+
/// <returns><see langword="true" /> if the disposition was successfully parsed; otherwise, <see langword="false" />.</returns>
663663
/// <param name="buffer">The input buffer.</param>
664664
/// <param name="disposition">The parsed disposition.</param>
665665
/// <exception cref="System.ArgumentNullException">
@@ -676,7 +676,7 @@ public static bool TryParse (byte[] buffer, out ContentDisposition disposition)
676676
/// <remarks>
677677
/// Parses a Content-Disposition value from the supplied text.
678678
/// </remarks>
679-
/// <returns><c>true</c> if the disposition was successfully parsed; otherwise, <c>false</c>.</returns>
679+
/// <returns><see langword="true" /> if the disposition was successfully parsed; otherwise, <see langword="false" />.</returns>
680680
/// <param name="options">The parser options.</param>
681681
/// <param name="text">The text to parse.</param>
682682
/// <param name="disposition">The parsed disposition.</param>
@@ -701,7 +701,7 @@ public static bool TryParse (ParserOptions options, string text, out ContentDisp
701701
/// <remarks>
702702
/// Parses a Content-Disposition value from the supplied text.
703703
/// </remarks>
704-
/// <returns><c>true</c> if the disposition was successfully parsed; otherwise, <c>false</c>.</returns>
704+
/// <returns><see langword="true" /> if the disposition was successfully parsed; otherwise, <see langword="false" />.</returns>
705705
/// <param name="text">The text to parse.</param>
706706
/// <param name="disposition">The parsed disposition.</param>
707707
/// <exception cref="System.ArgumentNullException">

‎MimeKit/ContentType.cs

+12-12
Original file line numberDiff line numberDiff line change
@@ -280,7 +280,7 @@ public ContentType Clone ()
280280
/// If the specified <paramref name="mediaType"/> or <paramref name="mediaSubtype"/>
281281
/// are <c>"*"</c>, they match anything.
282282
/// </remarks>
283-
/// <returns><c>true</c> if the <see cref="ContentType"/> matches the
283+
/// <returns><see langword="true" /> if the <see cref="ContentType"/> matches the
284284
/// provided media type and subtype.</returns>
285285
/// <param name="mediaType">The media type.</param>
286286
/// <param name="mediaSubtype">The media subtype.</param>
@@ -331,7 +331,7 @@ internal string Encode (FormatOptions options, Encoding charset)
331331
/// <returns>The serialized string.</returns>
332332
/// <param name="options">The formatting options.</param>
333333
/// <param name="charset">The charset to be used when encoding the parameter values.</param>
334-
/// <param name="encode">If set to <c>true</c>, the parameter values will be encoded.</param>
334+
/// <param name="encode">If set to <see langword="true" />, the parameter values will be encoded.</param>
335335
/// <exception cref="System.ArgumentNullException">
336336
/// <para><paramref name="options"/> is <see langword="null"/>.</para>
337337
/// <para>-or-</para>
@@ -371,7 +371,7 @@ public string ToString (FormatOptions options, Encoding charset, bool encode)
371371
/// </remarks>
372372
/// <returns>The serialized string.</returns>
373373
/// <param name="charset">The charset to be used when encoding the parameter values.</param>
374-
/// <param name="encode">If set to <c>true</c>, the parameter values will be encoded.</param>
374+
/// <param name="encode">If set to <see langword="true" />, the parameter values will be encoded.</param>
375375
/// <exception cref="System.ArgumentNullException">
376376
/// <paramref name="charset"/> is <see langword="null"/>.
377377
/// </exception>
@@ -388,7 +388,7 @@ public string ToString (Encoding charset, bool encode)
388388
/// the parameters as they would be encoded for transport.
389389
/// </remarks>
390390
/// <returns>The serialized string.</returns>
391-
/// <param name="encode">If set to <c>true</c>, the parameter values will be encoded.</param>
391+
/// <param name="encode">If set to <see langword="true" />, the parameter values will be encoded.</param>
392392
public string ToString (bool encode)
393393
{
394394
return ToString (FormatOptions.Default, Encoding.UTF8, encode);
@@ -523,7 +523,7 @@ internal static bool TryParse (ParserOptions options, byte[] text, ref int index
523523
/// Parses a Content-Type value from the supplied buffer starting at the given index
524524
/// and spanning across the specified number of bytes.
525525
/// </remarks>
526-
/// <returns><c>true</c> if the content type was successfully parsed; otherwise, <c>false</c>.</returns>
526+
/// <returns><see langword="true" /> if the content type was successfully parsed; otherwise, <see langword="false" />.</returns>
527527
/// <param name="options">The parser options.</param>
528528
/// <param name="buffer">The input buffer.</param>
529529
/// <param name="startIndex">The starting index of the input buffer.</param>
@@ -554,7 +554,7 @@ public static bool TryParse (ParserOptions options, byte[] buffer, int startInde
554554
/// Parses a Content-Type value from the supplied buffer starting at the given index
555555
/// and spanning across the specified number of bytes.
556556
/// </remarks>
557-
/// <returns><c>true</c> if the content type was successfully parsed; otherwise, <c>false</c>.</returns>
557+
/// <returns><see langword="true" /> if the content type was successfully parsed; otherwise, <see langword="false" />.</returns>
558558
/// <param name="buffer">The input buffer.</param>
559559
/// <param name="startIndex">The starting index of the input buffer.</param>
560560
/// <param name="length">The number of bytes in the input buffer to parse.</param>
@@ -577,7 +577,7 @@ public static bool TryParse (byte[] buffer, int startIndex, int length, out Cont
577577
/// <remarks>
578578
/// Parses a Content-Type value from the supplied buffer starting at the specified index.
579579
/// </remarks>
580-
/// <returns><c>true</c> if the content type was successfully parsed; otherwise, <c>false</c>.</returns>
580+
/// <returns><see langword="true" /> if the content type was successfully parsed; otherwise, <see langword="false" />.</returns>
581581
/// <param name="options">The parser options.</param>
582582
/// <param name="buffer">The input buffer.</param>
583583
/// <param name="startIndex">The starting index of the input buffer.</param>
@@ -605,7 +605,7 @@ public static bool TryParse (ParserOptions options, byte[] buffer, int startInde
605605
/// <remarks>
606606
/// Parses a Content-Type value from the supplied buffer starting at the specified index.
607607
/// </remarks>
608-
/// <returns><c>true</c> if the content type was successfully parsed; otherwise, <c>false</c>.</returns>
608+
/// <returns><see langword="true" /> if the content type was successfully parsed; otherwise, <see langword="false" />.</returns>
609609
/// <param name="buffer">The input buffer.</param>
610610
/// <param name="startIndex">The starting index of the input buffer.</param>
611611
/// <param name="type">The parsed content type.</param>
@@ -626,7 +626,7 @@ public static bool TryParse (byte[] buffer, int startIndex, out ContentType type
626626
/// <remarks>
627627
/// Parses a Content-Type value from the specified buffer.
628628
/// </remarks>
629-
/// <returns><c>true</c> if the content type was successfully parsed; otherwise, <c>false</c>.</returns>
629+
/// <returns><see langword="true" /> if the content type was successfully parsed; otherwise, <see langword="false" />.</returns>
630630
/// <param name="options">The parser options.</param>
631631
/// <param name="buffer">The input buffer.</param>
632632
/// <param name="type">The parsed content type.</param>
@@ -650,7 +650,7 @@ public static bool TryParse (ParserOptions options, byte[] buffer, out ContentTy
650650
/// <remarks>
651651
/// Parses a Content-Type value from the specified buffer.
652652
/// </remarks>
653-
/// <returns><c>true</c> if the content type was successfully parsed; otherwise, <c>false</c>.</returns>
653+
/// <returns><see langword="true" /> if the content type was successfully parsed; otherwise, <see langword="false" />.</returns>
654654
/// <param name="buffer">The input buffer.</param>
655655
/// <param name="type">The parsed content type.</param>
656656
/// <exception cref="System.ArgumentNullException">
@@ -667,7 +667,7 @@ public static bool TryParse (byte[] buffer, out ContentType type)
667667
/// <remarks>
668668
/// Parses a Content-Type value from the specified text.
669669
/// </remarks>
670-
/// <returns><c>true</c> if the content type was successfully parsed; otherwise, <c>false</c>.</returns>
670+
/// <returns><see langword="true" /> if the content type was successfully parsed; otherwise, <see langword="false" />.</returns>
671671
/// <param name="options">The parser options.</param>
672672
/// <param name="text">The text to parse.</param>
673673
/// <param name="type">The parsed content type.</param>
@@ -692,7 +692,7 @@ public static bool TryParse (ParserOptions options, string text, out ContentType
692692
/// <remarks>
693693
/// Parses a Content-Type value from the specified text.
694694
/// </remarks>
695-
/// <returns><c>true</c> if the content type was successfully parsed; otherwise, <c>false</c>.</returns>
695+
/// <returns><see langword="true" /> if the content type was successfully parsed; otherwise, <see langword="false" />.</returns>
696696
/// <param name="text">The text to parse.</param>
697697
/// <param name="type">The parsed content type.</param>
698698
/// <exception cref="System.ArgumentNullException">

‎MimeKit/Cryptography/AuthenticationResults.cs

+3-3
Original file line numberDiff line numberDiff line change
@@ -816,7 +816,7 @@ static bool TryParse (byte[] text, ref int index, int endIndex, bool throwOnErro
816816
/// Parses an Authentication-Results header value from the supplied buffer starting at the given index
817817
/// and spanning across the specified number of bytes.
818818
/// </remarks>
819-
/// <returns><c>true</c> if the authentication results were successfully parsed; otherwise, <c>false</c>.</returns>
819+
/// <returns><see langword="true" /> if the authentication results were successfully parsed; otherwise, <see langword="false" />.</returns>
820820
/// <param name="buffer">The input buffer.</param>
821821
/// <param name="startIndex">The starting index of the input buffer.</param>
822822
/// <param name="length">The number of bytes in the input buffer to parse.</param>
@@ -843,7 +843,7 @@ public static bool TryParse (byte[] buffer, int startIndex, int length, out Auth
843843
/// <remarks>
844844
/// Parses an Authentication-Results header value from the supplied buffer.
845845
/// </remarks>
846-
/// <returns><c>true</c> if the authentication results were successfully parsed; otherwise, <c>false</c>.</returns>
846+
/// <returns><see langword="true" /> if the authentication results were successfully parsed; otherwise, <see langword="false" />.</returns>
847847
/// <param name="buffer">The input buffer.</param>
848848
/// <param name="authres">The parsed authentication results.</param>
849849
/// <exception cref="System.ArgumentNullException">
@@ -1228,7 +1228,7 @@ public class AuthenticationMethodProperty
12281228
/// <param name="ptype">The property type.</param>
12291229
/// <param name="property">The name of the property.</param>
12301230
/// <param name="value">The value of the property.</param>
1231-
/// <param name="quoted"><c>true</c> if the property value was originally quoted; otherwise, <c>false</c>.</param>
1231+
/// <param name="quoted"><see langword="true" /> if the property value was originally quoted; otherwise, <see langword="false" />.</param>
12321232
/// <exception cref="System.ArgumentNullException">
12331233
/// <para><paramref name="ptype"/> is <see langword="null"/>.</para>
12341234
/// <para>-or-</para>

0 commit comments

Comments
 (0)