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 f54c53f commit c62bdd1
Show file tree
Hide file tree
Showing 143 changed files with 2,023 additions and 2,023 deletions.
10 changes: 5 additions & 5 deletions MailKit/AccessControl.cs
Original file line number Diff line number Diff line change
Expand Up @@ -50,9 +50,9 @@ public class AccessControl
/// <param name="name">The identifier name.</param>
/// <param name="rights">The access rights.</param>
/// <exception cref="System.ArgumentNullException">
/// <para><paramref name="name"/> is <c>null</c>.</para>
/// <para><paramref name="name"/> is <see langword="null" />.</para>
/// <para>-or-</para>
/// <para><paramref name="rights"/> is <c>null</c>.</para>
/// <para><paramref name="rights"/> is <see langword="null" />.</para>
/// </exception>
public AccessControl (string name, IEnumerable<AccessRight> rights)
{
Expand All @@ -73,9 +73,9 @@ public AccessControl (string name, IEnumerable<AccessRight> rights)
/// <param name="name">The identifier name.</param>
/// <param name="rights">The access rights.</param>
/// <exception cref="System.ArgumentNullException">
/// <para><paramref name="name"/> is <c>null</c>.</para>
/// <para><paramref name="name"/> is <see langword="null" />.</para>
/// <para>-or-</para>
/// <para><paramref name="rights"/> is <c>null</c>.</para>
/// <para><paramref name="rights"/> is <see langword="null" />.</para>
/// </exception>
public AccessControl (string name, string rights)
{
Expand All @@ -95,7 +95,7 @@ public AccessControl (string name, string rights)
/// </remarks>
/// <param name="name">The identifier name.</param>
/// <exception cref="System.ArgumentNullException">
/// <paramref name="name"/> is <c>null</c>.
/// <paramref name="name"/> is <see langword="null" />.
/// </exception>
public AccessControl (string name)
{
Expand Down
2 changes: 1 addition & 1 deletion MailKit/AccessControlList.cs
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ public class AccessControlList : List<AccessControl>
/// </remarks>
/// <param name="controls">The list of access controls.</param>
/// <exception cref="System.ArgumentNullException">
/// <paramref name="controls"/> is <c>null</c>.
/// <paramref name="controls"/> is <see langword="null" />.
/// </exception>
public AccessControlList (IEnumerable<AccessControl> controls) : base (controls)
{
Expand Down
12 changes: 6 additions & 6 deletions MailKit/AccessRight.cs
Original file line number Diff line number Diff line change
Expand Up @@ -154,8 +154,8 @@ public AccessRight (char right)
/// Determines whether the specified <see cref="MailKit.AccessRight"/> is equal to the current <see cref="MailKit.AccessRight"/>.
/// </remarks>
/// <param name="other">The <see cref="MailKit.AccessRight"/> to compare with the current <see cref="MailKit.AccessRight"/>.</param>
/// <returns><c>true</c> if the specified <see cref="MailKit.AccessRight"/> is equal to the current
/// <see cref="MailKit.AccessRight"/>; otherwise, <c>false</c>.</returns>
/// <returns><see langword="true" /> if the specified <see cref="MailKit.AccessRight"/> is equal to the current
/// <see cref="MailKit.AccessRight"/>; otherwise, <see langword="false" />.</returns>
public bool Equals (AccessRight other)
{
return other.Right == Right;
Expand All @@ -169,7 +169,7 @@ public bool Equals (AccessRight other)
/// <remarks>
/// Determines whether two access rights are equal.
/// </remarks>
/// <returns><c>true</c> if <paramref name="right1"/> and <paramref name="right2"/> are equal; otherwise, <c>false</c>.</returns>
/// <returns><see langword="true" /> if <paramref name="right1"/> and <paramref name="right2"/> are equal; otherwise, <see langword="false" />.</returns>
/// <param name="right1">The first access right to compare.</param>
/// <param name="right2">The second access right to compare.</param>
public static bool operator == (AccessRight right1, AccessRight right2)
Expand All @@ -183,7 +183,7 @@ public bool Equals (AccessRight other)
/// <remarks>
/// Determines whether two access rights are not equal.
/// </remarks>
/// <returns><c>true</c> if <paramref name="right1"/> and <paramref name="right2"/> are not equal; otherwise, <c>false</c>.</returns>
/// <returns><see langword="true" /> if <paramref name="right1"/> and <paramref name="right2"/> are not equal; otherwise, <see langword="false" />.</returns>
/// <param name="right1">The first access right to compare.</param>
/// <param name="right2">The second access right to compare.</param>
public static bool operator != (AccessRight right1, AccessRight right2)
Expand All @@ -198,8 +198,8 @@ public bool Equals (AccessRight other)
/// Determines whether the specified <see cref="System.Object"/> is equal to the current <see cref="MailKit.AccessRight"/>.
/// </remarks>
/// <param name="obj">The <see cref="System.Object"/> to compare with the current <see cref="MailKit.AccessRight"/>.</param>
/// <returns><c>true</c> if the specified <see cref="System.Object"/> is equal to the current <see cref="MailKit.AccessRight"/>;
/// otherwise, <c>false</c>.</returns>
/// <returns><see langword="true" /> if the specified <see cref="System.Object"/> is equal to the current <see cref="MailKit.AccessRight"/>;
/// otherwise, <see langword="false" />.</returns>
public override bool Equals (object obj)
{
return obj is AccessRight right && right.Right == Right;
Expand Down
20 changes: 10 additions & 10 deletions MailKit/AccessRights.cs
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ public class AccessRights : ICollection<AccessRight>
/// </remarks>
/// <param name="rights">The access rights.</param>
/// <exception cref="System.ArgumentNullException">
/// <paramref name="rights"/> is <c>null</c>.
/// <paramref name="rights"/> is <see langword="null" />.
/// </exception>
public AccessRights (IEnumerable<AccessRight> rights)
{
Expand All @@ -62,7 +62,7 @@ public AccessRights (IEnumerable<AccessRight> rights)
/// </remarks>
/// <param name="rights">The access rights.</param>
/// <exception cref="System.ArgumentNullException">
/// <paramref name="rights"/> is <c>null</c>.
/// <paramref name="rights"/> is <see langword="null" />.
/// </exception>
public AccessRights (string rights)
{
Expand Down Expand Up @@ -96,7 +96,7 @@ public int Count {
/// <remarks>
/// Gets whether or not this set of access rights is read only.
/// </remarks>
/// <value><c>true</c> if this collection is read only; otherwise, <c>false</c>.</value>
/// <value><see langword="true" /> if this collection is read only; otherwise, <see langword="false" />.</value>
public bool IsReadOnly {
get { return false; }
}
Expand All @@ -119,7 +119,7 @@ void ICollection<AccessRight>.Add (AccessRight right)
/// <remarks>
/// Adds the specified access right if it is not already included.
/// </remarks>
/// <returns><c>true</c> if the right was added; otherwise, <c>false</c>.</returns>
/// <returns><see langword="true" /> if the right was added; otherwise, <see langword="false" />.</returns>
/// <param name="right">The access right.</param>
public bool Add (AccessRight right)
{
Expand All @@ -137,7 +137,7 @@ public bool Add (AccessRight right)
/// <remarks>
/// Adds the right specified by the given character.
/// </remarks>
/// <returns><c>true</c> if the right was added; otherwise, <c>false</c>.</returns>
/// <returns><see langword="true" /> if the right was added; otherwise, <see langword="false" />.</returns>
/// <param name="right">The right.</param>
public bool Add (char right)
{
Expand All @@ -152,7 +152,7 @@ public bool Add (char right)
/// </remarks>
/// <param name="rights">The rights.</param>
/// <exception cref="System.ArgumentNullException">
/// <paramref name="rights"/> is <c>null</c>.
/// <paramref name="rights"/> is <see langword="null" />.
/// </exception>
public void AddRange (string rights)
{
Expand All @@ -171,7 +171,7 @@ public void AddRange (string rights)
/// </remarks>
/// <param name="rights">The rights.</param>
/// <exception cref="System.ArgumentNullException">
/// <paramref name="rights"/> is <c>null</c>.
/// <paramref name="rights"/> is <see langword="null" />.
/// </exception>
public void AddRange (IEnumerable<AccessRight> rights)
{
Expand Down Expand Up @@ -199,7 +199,7 @@ public void Clear ()
/// <remarks>
/// Determines whether or not the set of access rights already contains the specified right
/// </remarks>
/// <returns><value>true</value> if the specified right exists; otherwise <value>false</value>.</returns>
/// <returns><see langword="true" /> if the specified right exists; otherwise, <see langword="false" />.</returns>
/// <param name="right">The access right.</param>
public bool Contains (AccessRight right)
{
Expand All @@ -216,7 +216,7 @@ public bool Contains (AccessRight right)
/// <param name="array">The array.</param>
/// <param name="arrayIndex">The array index.</param>
/// <exception cref="System.ArgumentNullException">
/// <paramref name="array"/> is <c>null</c>.
/// <paramref name="array"/> is <see langword="null" />.
/// </exception>
/// <exception cref="System.ArgumentOutOfRangeException">
/// <paramref name="arrayIndex"/> is out of range.
Expand All @@ -238,7 +238,7 @@ public void CopyTo (AccessRight[] array, int arrayIndex)
/// <remarks>
/// Removes the specified access right.
/// </remarks>
/// <returns><value>true</value> if the access right was removed; otherwise <value>false</value>.</returns>
/// <returns><see langword="true" /> if the access right was removed; otherwise, <see langword="false" />.</returns>
/// <param name="right">The access right.</param>
public bool Remove (AccessRight right)
{
Expand Down
2 changes: 1 addition & 1 deletion MailKit/AlertEventArgs.cs
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ public class AlertEventArgs : EventArgs
/// </remarks>
/// <param name="message">The alert message.</param>
/// <exception cref="System.ArgumentNullException">
/// <paramref name="message"/> is <c>null</c>.
/// <paramref name="message"/> is <see langword="null" />.
/// </exception>
public AlertEventArgs (string message)
{
Expand Down
2 changes: 1 addition & 1 deletion MailKit/Annotation.cs
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ public class Annotation
/// </remarks>
/// <param name="entry">The annotation entry.</param>
/// <exception cref="System.ArgumentNullException">
/// <paramref name="entry"/> is <c>null</c>.
/// <paramref name="entry"/> is <see langword="null" />.
/// </exception>
public Annotation (AnnotationEntry entry)
{
Expand Down
14 changes: 7 additions & 7 deletions MailKit/AnnotationAttribute.cs
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ public class AnnotationAttribute : IEquatable<AnnotationAttribute>
/// </remarks>
/// <param name="specifier">The annotation attribute specifier.</param>
/// <exception cref="System.ArgumentNullException">
/// <paramref name="specifier"/> is <c>null</c>.
/// <paramref name="specifier"/> is <see langword="null" />.
/// </exception>
/// <exception cref="System.ArgumentException">
/// <paramref name="specifier"/> contains illegal characters.
Expand Down Expand Up @@ -179,8 +179,8 @@ public string Specifier {
/// Determines whether the specified <see cref="MailKit.AnnotationAttribute"/> is equal to the current <see cref="MailKit.AnnotationAttribute"/>.
/// </remarks>
/// <param name="other">The <see cref="MailKit.AnnotationAttribute"/> to compare with the current <see cref="MailKit.AnnotationAttribute"/>.</param>
/// <returns><c>true</c> if the specified <see cref="MailKit.AnnotationAttribute"/> is equal to the current
/// <see cref="MailKit.AnnotationAttribute"/>; otherwise, <c>false</c>.</returns>
/// <returns><see langword="true" /> if the specified <see cref="MailKit.AnnotationAttribute"/> is equal to the current
/// <see cref="MailKit.AnnotationAttribute"/>; otherwise, <see langword="false" />.</returns>
public bool Equals (AnnotationAttribute other)
{
return other?.Specifier == Specifier;
Expand All @@ -194,7 +194,7 @@ public bool Equals (AnnotationAttribute other)
/// <remarks>
/// Determines whether two annotation attributes are equal.
/// </remarks>
/// <returns><c>true</c> if <paramref name="attr1"/> and <paramref name="attr2"/> are equal; otherwise, <c>false</c>.</returns>
/// <returns><see langword="true" /> if <paramref name="attr1"/> and <paramref name="attr2"/> are equal; otherwise, <see langword="false" />.</returns>
/// <param name="attr1">The first annotation attribute to compare.</param>
/// <param name="attr2">The second annotation attribute to compare.</param>
public static bool operator == (AnnotationAttribute attr1, AnnotationAttribute attr2)
Expand All @@ -208,7 +208,7 @@ public bool Equals (AnnotationAttribute other)
/// <remarks>
/// Determines whether two annotation attributes are not equal.
/// </remarks>
/// <returns><c>true</c> if <paramref name="attr1"/> and <paramref name="attr2"/> are not equal; otherwise, <c>false</c>.</returns>
/// <returns><see langword="true" /> if <paramref name="attr1"/> and <paramref name="attr2"/> are not equal; otherwise, <see langword="false" />.</returns>
/// <param name="attr1">The first annotation attribute to compare.</param>
/// <param name="attr2">The second annotation attribute to compare.</param>
public static bool operator != (AnnotationAttribute attr1, AnnotationAttribute attr2)
Expand All @@ -223,8 +223,8 @@ public bool Equals (AnnotationAttribute other)
/// Determines whether the specified <see cref="System.Object"/> is equal to the current <see cref="MailKit.AnnotationAttribute"/>.
/// </remarks>
/// <param name="obj">The <see cref="System.Object"/> to compare with the current <see cref="MailKit.AnnotationAttribute"/>.</param>
/// <returns><c>true</c> if the specified <see cref="System.Object"/> is equal to the current
/// <see cref="MailKit.AnnotationAttribute"/>; otherwise, <c>false</c>.</returns>
/// <returns><see langword="true" /> if the specified <see cref="System.Object"/> is equal to the current
/// <see cref="MailKit.AnnotationAttribute"/>; otherwise, <see langword="false" />.</returns>
public override bool Equals (object obj)
{
return obj is AnnotationAttribute attribute && attribute.Specifier == Specifier;
Expand Down
24 changes: 12 additions & 12 deletions MailKit/AnnotationEntry.cs
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,7 @@ static void ValidatePartSpecifier (string partSpecifier)
/// <param name="path">The annotation entry path.</param>
/// <param name="scope">The scope of the annotation.</param>
/// <exception cref="System.ArgumentNullException">
/// <paramref name="path"/> is <c>null</c>.
/// <paramref name="path"/> is <see langword="null" />.
/// </exception>
/// <exception cref="System.ArgumentException">
/// <paramref name="path"/> is invalid.
Expand Down Expand Up @@ -214,9 +214,9 @@ public AnnotationEntry (string path, AnnotationScope scope = AnnotationScope.Bot
/// <param name="path">The annotation entry path.</param>
/// <param name="scope">The scope of the annotation.</param>
/// <exception cref="System.ArgumentNullException">
/// <para><paramref name="partSpecifier"/> is <c>null</c>.</para>
/// <para><paramref name="partSpecifier"/> is <see langword="null" />.</para>
/// <para>-or-</para>
/// <para><paramref name="path"/> is <c>null</c>.</para>
/// <para><paramref name="path"/> is <see langword="null" />.</para>
/// </exception>
/// <exception cref="System.ArgumentException">
/// <para><paramref name="partSpecifier"/> is invalid.</para>
Expand Down Expand Up @@ -248,9 +248,9 @@ public AnnotationEntry (string partSpecifier, string path, AnnotationScope scope
/// <param name="path">The annotation entry path.</param>
/// <param name="scope">The scope of the annotation.</param>
/// <exception cref="System.ArgumentNullException">
/// <para><paramref name="part"/> is <c>null</c>.</para>
/// <para><paramref name="part"/> is <see langword="null" />.</para>
/// <para>-or-</para>
/// <para><paramref name="path"/> is <c>null</c>.</para>
/// <para><paramref name="path"/> is <see langword="null" />.</para>
/// </exception>
/// <exception cref="System.ArgumentException">
/// <paramref name="path"/> is invalid.
Expand Down Expand Up @@ -325,8 +325,8 @@ public AnnotationScope Scope {
/// Determines whether the specified <see cref="MailKit.AnnotationEntry"/> is equal to the current <see cref="MailKit.AnnotationEntry"/>.
/// </remarks>
/// <param name="other">The <see cref="MailKit.AnnotationEntry"/> to compare with the current <see cref="MailKit.AnnotationEntry"/>.</param>
/// <returns><c>true</c> if the specified <see cref="MailKit.AnnotationEntry"/> is equal to the current
/// <see cref="MailKit.AnnotationEntry"/>; otherwise, <c>false</c>.</returns>
/// <returns><see langword="true" /> if the specified <see cref="MailKit.AnnotationEntry"/> is equal to the current
/// <see cref="MailKit.AnnotationEntry"/>; otherwise, <see langword="false" />.</returns>
public bool Equals (AnnotationEntry other)
{
return other?.Entry == Entry;
Expand All @@ -340,7 +340,7 @@ public bool Equals (AnnotationEntry other)
/// <remarks>
/// Determines whether two annotation entries are equal.
/// </remarks>
/// <returns><c>true</c> if <paramref name="entry1"/> and <paramref name="entry2"/> are equal; otherwise, <c>false</c>.</returns>
/// <returns><see langword="true" /> if <paramref name="entry1"/> and <paramref name="entry2"/> are equal; otherwise, <see langword="false" />.</returns>
/// <param name="entry1">The first annotation entry to compare.</param>
/// <param name="entry2">The second annotation entry to compare.</param>
public static bool operator == (AnnotationEntry entry1, AnnotationEntry entry2)
Expand All @@ -354,7 +354,7 @@ public bool Equals (AnnotationEntry other)
/// <remarks>
/// Determines whether two annotation entries are not equal.
/// </remarks>
/// <returns><c>true</c> if <paramref name="entry1"/> and <paramref name="entry2"/> are not equal; otherwise, <c>false</c>.</returns>
/// <returns><see langword="true" /> if <paramref name="entry1"/> and <paramref name="entry2"/> are not equal; otherwise, <see langword="false" />.</returns>
/// <param name="entry1">The first annotation entry to compare.</param>
/// <param name="entry2">The second annotation entry to compare.</param>
public static bool operator != (AnnotationEntry entry1, AnnotationEntry entry2)
Expand All @@ -369,8 +369,8 @@ public bool Equals (AnnotationEntry other)
/// Determines whether the specified <see cref="System.Object"/> is equal to the current <see cref="MailKit.AnnotationEntry"/>.
/// </remarks>
/// <param name="obj">The <see cref="System.Object"/> to compare with the current <see cref="MailKit.AnnotationEntry"/>.</param>
/// <returns><c>true</c> if the specified <see cref="System.Object"/> is equal to the current
/// <see cref="MailKit.AnnotationEntry"/>; otherwise, <c>false</c>.</returns>
/// <returns><see langword="true" /> if the specified <see cref="System.Object"/> is equal to the current
/// <see cref="MailKit.AnnotationEntry"/>; otherwise, <see langword="false" />.</returns>
public override bool Equals (object obj)
{
return obj is AnnotationEntry entry && entry.Entry == Entry;
Expand Down Expand Up @@ -409,7 +409,7 @@ public override string ToString ()
/// <param name="entry">The annotation entry.</param>
/// <returns>The parsed annotation entry.</returns>
/// <exception cref="System.ArgumentNullException">
/// <paramref name="entry"/> is <c>null</c>.
/// <paramref name="entry"/> is <see langword="null" />.
/// </exception>
/// <exception cref="System.FormatException">
/// <paramref name="entry"/> does not conform to the annotation entry syntax.
Expand Down
2 changes: 1 addition & 1 deletion MailKit/AnnotationsChangedEventArgs.cs
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ internal AnnotationsChangedEventArgs (int index) : base (index)
/// <param name="index">The message index.</param>
/// <param name="annotations">The annotations that changed.</param>
/// <exception cref="System.ArgumentNullException">
/// <paramref name="annotations"/> is <c>null</c>.
/// <paramref name="annotations"/> is <see langword="null" />.
/// </exception>
public AnnotationsChangedEventArgs (int index, IEnumerable<Annotation> annotations) : base (index)
{
Expand Down
Loading

0 comments on commit c62bdd1

Please sign in to comment.