Skip to content

Commit

Permalink
Use <see langword="x"/> instead of <c>x</c>
Browse files Browse the repository at this point in the history
* 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>
  • Loading branch information
jstedfast committed Jan 11, 2025
1 parent 8520ff9 commit 0e5d128
Show file tree
Hide file tree
Showing 110 changed files with 572 additions and 572 deletions.
14 changes: 7 additions & 7 deletions MimeKit/AttachmentCollection.cs
Original file line number Diff line number Diff line change
Expand Up @@ -57,10 +57,10 @@ public class AttachmentCollection : IList<MimeEntity>
/// </summary>
/// <remarks>
/// <para>Creates a new <see cref="AttachmentCollection"/>.</para>
/// <para>If <paramref name="linkedResources"/> is <c>true</c>, then the attachments
/// <para>If <paramref name="linkedResources"/> is <see langword="true" />, then the attachments
/// are treated as if they are linked to another <see cref="MimePart"/>.</para>
/// </remarks>
/// <param name="linkedResources">If set to <c>true</c>; the attachments are treated as linked resources.</param>
/// <param name="linkedResources">If set to <see langword="true" />; the attachments are treated as linked resources.</param>
public AttachmentCollection (bool linkedResources)
{
attachments = new List<MimeEntity> ();
Expand Down Expand Up @@ -96,7 +96,7 @@ public int Count {
/// <remarks>
/// A <see cref="AttachmentCollection"/> is never read-only.
/// </remarks>
/// <value><c>true</c> if the collection is read only; otherwise, <c>false</c>.</value>
/// <value><see langword="true" /> if the collection is read only; otherwise, <see langword="false" />.</value>
public bool IsReadOnly {
get { return false; }
}
Expand Down Expand Up @@ -848,7 +848,7 @@ public void Clear ()
/// <remarks>
/// Removes all attachments from the collection, optionally disposing them in the process.
/// </remarks>
/// <param name="dispose"><c>true</c> if all the attachments should be disposed; otherwise, <c>false</c>.</param>
/// <param name="dispose"><see langword="true" /> if all the attachments should be disposed; otherwise, <see langword="false" />.</param>
public void Clear (bool dispose)
{
if (dispose) {
Expand All @@ -865,8 +865,8 @@ public void Clear (bool dispose)
/// <remarks>
/// Determines whether the collection contains the specified attachment.
/// </remarks>
/// <returns><value>true</value> if the specified attachment exists;
/// otherwise <value>false</value>.</returns>
/// <returns><see langword="true" /> if the specified attachment exists;
/// otherwise, <see langword="false" />.</returns>
/// <param name="attachment">The attachment.</param>
/// <exception cref="System.ArgumentNullException">
/// <paramref name="attachment"/> is <see langword="null"/>.
Expand Down Expand Up @@ -955,7 +955,7 @@ public void Insert (int index, MimeEntity attachment)
/// <remarks>
/// Removes the specified attachment.
/// </remarks>
/// <returns><value>true</value> if the attachment was removed; otherwise <value>false</value>.</returns>
/// <returns><see langword="true" /> if the attachment was removed; otherwise, <see langword="false" />.</returns>
/// <param name="attachment">The attachment.</param>
/// <exception cref="System.ArgumentNullException">
/// <paramref name="attachment"/> is <see langword="null"/>.
Expand Down
24 changes: 12 additions & 12 deletions MimeKit/ContentDisposition.cs
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@ public string Disposition {
/// <remarks>
/// A convenience property to determine if the entity should be considered an attachment or not.
/// </remarks>
/// <value><c>true</c> if the <see cref="MimePart"/> is an attachment; otherwise, <c>false</c>.</value>
/// <value><see langword="true" /> if the <see cref="MimePart"/> is an attachment; otherwise, <see langword="false" />.</value>
public bool IsAttachment {
get { return disposition.Equals (Attachment, StringComparison.OrdinalIgnoreCase); }
set { disposition = value ? Attachment : Inline; }
Expand Down Expand Up @@ -356,7 +356,7 @@ internal string Encode (FormatOptions options, Encoding charset)
/// <returns>The serialized string.</returns>
/// <param name="options">The formatting options.</param>
/// <param name="charset">The charset to be used when encoding the parameter values.</param>
/// <param name="encode">If set to <c>true</c>, the parameter values will be encoded.</param>
/// <param name="encode">If set to <see langword="true" />, the parameter values will be encoded.</param>
/// <exception cref="System.ArgumentNullException">
/// <para><paramref name="options"/> is <see langword="null"/>.</para>
/// <para>-or-</para>
Expand Down Expand Up @@ -394,7 +394,7 @@ public string ToString (FormatOptions options, Encoding charset, bool encode)
/// </remarks>
/// <returns>The serialized string.</returns>
/// <param name="charset">The charset to be used when encoding the parameter values.</param>
/// <param name="encode">If set to <c>true</c>, the parameter values will be encoded.</param>
/// <param name="encode">If set to <see langword="true" />, the parameter values will be encoded.</param>
/// <exception cref="System.ArgumentNullException">
/// <paramref name="charset"/> is <see langword="null"/>.
/// </exception>
Expand All @@ -411,7 +411,7 @@ public string ToString (Encoding charset, bool encode)
/// optionally encoding the parameters as they would be encoded for transport.
/// </remarks>
/// <returns>The serialized string.</returns>
/// <param name="encode">If set to <c>true</c>, the parameter values will be encoded.</param>
/// <param name="encode">If set to <see langword="true" />, the parameter values will be encoded.</param>
public string ToString (bool encode)
{
return ToString (FormatOptions.Default, Encoding.UTF8, encode);
Expand Down Expand Up @@ -532,7 +532,7 @@ internal static bool TryParse (ParserOptions options, byte[] text, ref int index
/// Parses a Content-Disposition value from the supplied buffer starting at the given index
/// and spanning across the specified number of bytes.
/// </remarks>
/// <returns><c>true</c> if the disposition was successfully parsed; otherwise, <c>false</c>.</returns>
/// <returns><see langword="true" /> if the disposition was successfully parsed; otherwise, <see langword="false" />.</returns>
/// <param name="options">The parser options.</param>
/// <param name="buffer">The input buffer.</param>
/// <param name="startIndex">The starting index of the input buffer.</param>
Expand Down Expand Up @@ -563,7 +563,7 @@ public static bool TryParse (ParserOptions options, byte[] buffer, int startInde
/// Parses a Content-Disposition value from the supplied buffer starting at the given index
/// and spanning across the specified number of bytes.
/// </remarks>
/// <returns><c>true</c> if the disposition was successfully parsed; otherwise, <c>false</c>.</returns>
/// <returns><see langword="true" /> if the disposition was successfully parsed; otherwise, <see langword="false" />.</returns>
/// <param name="buffer">The input buffer.</param>
/// <param name="startIndex">The starting index of the input buffer.</param>
/// <param name="length">The number of bytes in the input buffer to parse.</param>
Expand All @@ -586,7 +586,7 @@ public static bool TryParse (byte[] buffer, int startIndex, int length, out Cont
/// <remarks>
/// Parses a Content-Disposition value from the supplied buffer starting at the specified index.
/// </remarks>
/// <returns><c>true</c> if the disposition was successfully parsed; otherwise, <c>false</c>.</returns>
/// <returns><see langword="true" /> if the disposition was successfully parsed; otherwise, <see langword="false" />.</returns>
/// <param name="options">The parser options.</param>
/// <param name="buffer">The input buffer.</param>
/// <param name="startIndex">The starting index of the input buffer.</param>
Expand Down Expand Up @@ -614,7 +614,7 @@ public static bool TryParse (ParserOptions options, byte[] buffer, int startInde
/// <remarks>
/// Parses a Content-Disposition value from the supplied buffer starting at the specified index.
/// </remarks>
/// <returns><c>true</c> if the disposition was successfully parsed; otherwise, <c>false</c>.</returns>
/// <returns><see langword="true" /> if the disposition was successfully parsed; otherwise, <see langword="false" />.</returns>
/// <param name="buffer">The input buffer.</param>
/// <param name="startIndex">The starting index of the input buffer.</param>
/// <param name="disposition">The parsed disposition.</param>
Expand All @@ -635,7 +635,7 @@ public static bool TryParse (byte[] buffer, int startIndex, out ContentDispositi
/// <remarks>
/// Parses a Content-Disposition value from the specified buffer.
/// </remarks>
/// <returns><c>true</c> if the disposition was successfully parsed; otherwise, <c>false</c>.</returns>
/// <returns><see langword="true" /> if the disposition was successfully parsed; otherwise, <see langword="false" />.</returns>
/// <param name="options">The parser options.</param>
/// <param name="buffer">The input buffer.</param>
/// <param name="disposition">The parsed disposition.</param>
Expand All @@ -659,7 +659,7 @@ public static bool TryParse (ParserOptions options, byte[] buffer, out ContentDi
/// <remarks>
/// Parses a Content-Disposition value from the specified buffer.
/// </remarks>
/// <returns><c>true</c> if the disposition was successfully parsed; otherwise, <c>false</c>.</returns>
/// <returns><see langword="true" /> if the disposition was successfully parsed; otherwise, <see langword="false" />.</returns>
/// <param name="buffer">The input buffer.</param>
/// <param name="disposition">The parsed disposition.</param>
/// <exception cref="System.ArgumentNullException">
Expand All @@ -676,7 +676,7 @@ public static bool TryParse (byte[] buffer, out ContentDisposition disposition)
/// <remarks>
/// Parses a Content-Disposition value from the supplied text.
/// </remarks>
/// <returns><c>true</c> if the disposition was successfully parsed; otherwise, <c>false</c>.</returns>
/// <returns><see langword="true" /> if the disposition was successfully parsed; otherwise, <see langword="false" />.</returns>
/// <param name="options">The parser options.</param>
/// <param name="text">The text to parse.</param>
/// <param name="disposition">The parsed disposition.</param>
Expand All @@ -701,7 +701,7 @@ public static bool TryParse (ParserOptions options, string text, out ContentDisp
/// <remarks>
/// Parses a Content-Disposition value from the supplied text.
/// </remarks>
/// <returns><c>true</c> if the disposition was successfully parsed; otherwise, <c>false</c>.</returns>
/// <returns><see langword="true" /> if the disposition was successfully parsed; otherwise, <see langword="false" />.</returns>
/// <param name="text">The text to parse.</param>
/// <param name="disposition">The parsed disposition.</param>
/// <exception cref="System.ArgumentNullException">
Expand Down
24 changes: 12 additions & 12 deletions MimeKit/ContentType.cs
Original file line number Diff line number Diff line change
Expand Up @@ -280,7 +280,7 @@ public ContentType Clone ()
/// If the specified <paramref name="mediaType"/> or <paramref name="mediaSubtype"/>
/// are <c>"*"</c>, they match anything.
/// </remarks>
/// <returns><c>true</c> if the <see cref="ContentType"/> matches the
/// <returns><see langword="true" /> if the <see cref="ContentType"/> matches the
/// provided media type and subtype.</returns>
/// <param name="mediaType">The media type.</param>
/// <param name="mediaSubtype">The media subtype.</param>
Expand Down Expand Up @@ -331,7 +331,7 @@ internal string Encode (FormatOptions options, Encoding charset)
/// <returns>The serialized string.</returns>
/// <param name="options">The formatting options.</param>
/// <param name="charset">The charset to be used when encoding the parameter values.</param>
/// <param name="encode">If set to <c>true</c>, the parameter values will be encoded.</param>
/// <param name="encode">If set to <see langword="true" />, the parameter values will be encoded.</param>
/// <exception cref="System.ArgumentNullException">
/// <para><paramref name="options"/> is <see langword="null"/>.</para>
/// <para>-or-</para>
Expand Down Expand Up @@ -371,7 +371,7 @@ public string ToString (FormatOptions options, Encoding charset, bool encode)
/// </remarks>
/// <returns>The serialized string.</returns>
/// <param name="charset">The charset to be used when encoding the parameter values.</param>
/// <param name="encode">If set to <c>true</c>, the parameter values will be encoded.</param>
/// <param name="encode">If set to <see langword="true" />, the parameter values will be encoded.</param>
/// <exception cref="System.ArgumentNullException">
/// <paramref name="charset"/> is <see langword="null"/>.
/// </exception>
Expand All @@ -388,7 +388,7 @@ public string ToString (Encoding charset, bool encode)
/// the parameters as they would be encoded for transport.
/// </remarks>
/// <returns>The serialized string.</returns>
/// <param name="encode">If set to <c>true</c>, the parameter values will be encoded.</param>
/// <param name="encode">If set to <see langword="true" />, the parameter values will be encoded.</param>
public string ToString (bool encode)
{
return ToString (FormatOptions.Default, Encoding.UTF8, encode);
Expand Down Expand Up @@ -523,7 +523,7 @@ internal static bool TryParse (ParserOptions options, byte[] text, ref int index
/// Parses a Content-Type value from the supplied buffer starting at the given index
/// and spanning across the specified number of bytes.
/// </remarks>
/// <returns><c>true</c> if the content type was successfully parsed; otherwise, <c>false</c>.</returns>
/// <returns><see langword="true" /> if the content type was successfully parsed; otherwise, <see langword="false" />.</returns>
/// <param name="options">The parser options.</param>
/// <param name="buffer">The input buffer.</param>
/// <param name="startIndex">The starting index of the input buffer.</param>
Expand Down Expand Up @@ -554,7 +554,7 @@ public static bool TryParse (ParserOptions options, byte[] buffer, int startInde
/// Parses a Content-Type value from the supplied buffer starting at the given index
/// and spanning across the specified number of bytes.
/// </remarks>
/// <returns><c>true</c> if the content type was successfully parsed; otherwise, <c>false</c>.</returns>
/// <returns><see langword="true" /> if the content type was successfully parsed; otherwise, <see langword="false" />.</returns>
/// <param name="buffer">The input buffer.</param>
/// <param name="startIndex">The starting index of the input buffer.</param>
/// <param name="length">The number of bytes in the input buffer to parse.</param>
Expand All @@ -577,7 +577,7 @@ public static bool TryParse (byte[] buffer, int startIndex, int length, out Cont
/// <remarks>
/// Parses a Content-Type value from the supplied buffer starting at the specified index.
/// </remarks>
/// <returns><c>true</c> if the content type was successfully parsed; otherwise, <c>false</c>.</returns>
/// <returns><see langword="true" /> if the content type was successfully parsed; otherwise, <see langword="false" />.</returns>
/// <param name="options">The parser options.</param>
/// <param name="buffer">The input buffer.</param>
/// <param name="startIndex">The starting index of the input buffer.</param>
Expand Down Expand Up @@ -605,7 +605,7 @@ public static bool TryParse (ParserOptions options, byte[] buffer, int startInde
/// <remarks>
/// Parses a Content-Type value from the supplied buffer starting at the specified index.
/// </remarks>
/// <returns><c>true</c> if the content type was successfully parsed; otherwise, <c>false</c>.</returns>
/// <returns><see langword="true" /> if the content type was successfully parsed; otherwise, <see langword="false" />.</returns>
/// <param name="buffer">The input buffer.</param>
/// <param name="startIndex">The starting index of the input buffer.</param>
/// <param name="type">The parsed content type.</param>
Expand All @@ -626,7 +626,7 @@ public static bool TryParse (byte[] buffer, int startIndex, out ContentType type
/// <remarks>
/// Parses a Content-Type value from the specified buffer.
/// </remarks>
/// <returns><c>true</c> if the content type was successfully parsed; otherwise, <c>false</c>.</returns>
/// <returns><see langword="true" /> if the content type was successfully parsed; otherwise, <see langword="false" />.</returns>
/// <param name="options">The parser options.</param>
/// <param name="buffer">The input buffer.</param>
/// <param name="type">The parsed content type.</param>
Expand All @@ -650,7 +650,7 @@ public static bool TryParse (ParserOptions options, byte[] buffer, out ContentTy
/// <remarks>
/// Parses a Content-Type value from the specified buffer.
/// </remarks>
/// <returns><c>true</c> if the content type was successfully parsed; otherwise, <c>false</c>.</returns>
/// <returns><see langword="true" /> if the content type was successfully parsed; otherwise, <see langword="false" />.</returns>
/// <param name="buffer">The input buffer.</param>
/// <param name="type">The parsed content type.</param>
/// <exception cref="System.ArgumentNullException">
Expand All @@ -667,7 +667,7 @@ public static bool TryParse (byte[] buffer, out ContentType type)
/// <remarks>
/// Parses a Content-Type value from the specified text.
/// </remarks>
/// <returns><c>true</c> if the content type was successfully parsed; otherwise, <c>false</c>.</returns>
/// <returns><see langword="true" /> if the content type was successfully parsed; otherwise, <see langword="false" />.</returns>
/// <param name="options">The parser options.</param>
/// <param name="text">The text to parse.</param>
/// <param name="type">The parsed content type.</param>
Expand All @@ -692,7 +692,7 @@ public static bool TryParse (ParserOptions options, string text, out ContentType
/// <remarks>
/// Parses a Content-Type value from the specified text.
/// </remarks>
/// <returns><c>true</c> if the content type was successfully parsed; otherwise, <c>false</c>.</returns>
/// <returns><see langword="true" /> if the content type was successfully parsed; otherwise, <see langword="false" />.</returns>
/// <param name="text">The text to parse.</param>
/// <param name="type">The parsed content type.</param>
/// <exception cref="System.ArgumentNullException">
Expand Down
6 changes: 3 additions & 3 deletions MimeKit/Cryptography/AuthenticationResults.cs
Original file line number Diff line number Diff line change
Expand Up @@ -816,7 +816,7 @@ static bool TryParse (byte[] text, ref int index, int endIndex, bool throwOnErro
/// Parses an Authentication-Results header value from the supplied buffer starting at the given index
/// and spanning across the specified number of bytes.
/// </remarks>
/// <returns><c>true</c> if the authentication results were successfully parsed; otherwise, <c>false</c>.</returns>
/// <returns><see langword="true" /> if the authentication results were successfully parsed; otherwise, <see langword="false" />.</returns>
/// <param name="buffer">The input buffer.</param>
/// <param name="startIndex">The starting index of the input buffer.</param>
/// <param name="length">The number of bytes in the input buffer to parse.</param>
Expand All @@ -843,7 +843,7 @@ public static bool TryParse (byte[] buffer, int startIndex, int length, out Auth
/// <remarks>
/// Parses an Authentication-Results header value from the supplied buffer.
/// </remarks>
/// <returns><c>true</c> if the authentication results were successfully parsed; otherwise, <c>false</c>.</returns>
/// <returns><see langword="true" /> if the authentication results were successfully parsed; otherwise, <see langword="false" />.</returns>
/// <param name="buffer">The input buffer.</param>
/// <param name="authres">The parsed authentication results.</param>
/// <exception cref="System.ArgumentNullException">
Expand Down Expand Up @@ -1228,7 +1228,7 @@ public class AuthenticationMethodProperty
/// <param name="ptype">The property type.</param>
/// <param name="property">The name of the property.</param>
/// <param name="value">The value of the property.</param>
/// <param name="quoted"><c>true</c> if the property value was originally quoted; otherwise, <c>false</c>.</param>
/// <param name="quoted"><see langword="true" /> if the property value was originally quoted; otherwise, <see langword="false" />.</param>
/// <exception cref="System.ArgumentNullException">
/// <para><paramref name="ptype"/> is <see langword="null"/>.</para>
/// <para>-or-</para>
Expand Down
Loading

0 comments on commit 0e5d128

Please sign in to comment.