Merge pull request #917 from discosultan/master

Unify the usage of <c> tags for true/false values in XML docs

Src/Newtonsoft.Json/Bson/BsonReader.cs

@@ -178,7 +178,7 @@ namespace Newtonsoft.Json.Bson
         /// Reads the next JSON token from the stream.
         /// </summary>
         /// <returns>
-        /// true if the next token was read successfully; false if there are no more tokens to read.
+        /// <c>true</c> if the next token was read successfully; <c>false</c> if there are no more tokens to read.
         /// </returns>
         public override bool Read()
         {

Src/Newtonsoft.Json/Converters/XmlNodeConverter.cs

@@ -2004,7 +2004,7 @@ namespace Newtonsoft.Json.Converters
         /// </summary>
         /// <param name="attributeName">Attribute name to test.</param>
         /// <param name="prefix">The attribute name prefix if it has one, otherwise an empty string.</param>
-        /// <returns>True if attribute name is for a namespace attribute, otherwise false.</returns>
+        /// <returns><c>true</c> if attribute name is for a namespace attribute, otherwise <c>false</c>.</returns>
         private bool IsNamespaceAttribute(string attributeName, out string prefix)
         {
             if (attributeName.StartsWith("xmlns", StringComparison.Ordinal))

Src/Newtonsoft.Json/JsonReader.cs

@@ -407,7 +407,7 @@ namespace Newtonsoft.Json
         /// <summary>
         /// Reads the next JSON token from the stream.
         /// </summary>
-        /// <returns>true if the next token was read successfully; false if there are no more tokens to read.</returns>
+        /// <returns><c>true</c> if the next token was read successfully; <c>false</c> if there are no more tokens to read.</returns>
         public abstract bool Read();
 
         /// <summary>

Src/Newtonsoft.Json/JsonTextReader.cs

@@ -362,7 +362,7 @@ namespace Newtonsoft.Json
         /// Reads the next JSON token from the stream.
         /// </summary>
         /// <returns>
-        /// true if the next token was read successfully; false if there are no more tokens to read.
+        /// <c>true</c> if the next token was read successfully; <c>false</c> if there are no more tokens to read.
         /// </returns>
         public override bool Read()
         {

Src/Newtonsoft.Json/JsonValidatingReader.cs

@@ -495,7 +495,7 @@ namespace Newtonsoft.Json
         /// Reads the next JSON token from the stream.
         /// </summary>
         /// <returns>
-        /// true if the next token was read successfully; false if there are no more tokens to read.
+        /// <c>true</c> if the next token was read successfully; <c>false</c> if there are no more tokens to read.
         /// </returns>
         public override bool Read()
         {

Src/Newtonsoft.Json/Linq/JObject.cs

@@ -528,7 +528,7 @@ namespace Newtonsoft.Json.Linq
         /// <param name="propertyName">Name of the property.</param>
         /// <param name="value">The value.</param>
         /// <param name="comparison">One of the enumeration values that specifies how the strings will be compared.</param>
-        /// <returns>true if a value was successfully retrieved; otherwise, false.</returns>
+        /// <returns><c>true</c> if a value was successfully retrieved; otherwise, <c>false</c>.</returns>
         public bool TryGetValue(string propertyName, StringComparison comparison, out JToken value)
         {
             value = GetValue(propertyName, comparison);
@@ -561,7 +561,7 @@ namespace Newtonsoft.Json.Linq
         /// Removes the property with the specified name.
         /// </summary>
         /// <param name="propertyName">Name of the property.</param>
-        /// <returns>true if item was successfully removed; otherwise, false.</returns>
+        /// <returns><c>true</c> if item was successfully removed; otherwise, <c>false</c>.</returns>
         public bool Remove(string propertyName)
         {
             JProperty property = Property(propertyName);
@@ -579,7 +579,7 @@ namespace Newtonsoft.Json.Linq
         /// </summary>
         /// <param name="propertyName">Name of the property.</param>
         /// <param name="value">The value.</param>
-        /// <returns>true if a value was successfully retrieved; otherwise, false.</returns>
+        /// <returns><c>true</c> if a value was successfully retrieved; otherwise, <c>false</c>.</returns>
         public bool TryGetValue(string propertyName, out JToken value)
         {
             JProperty property = Property(propertyName);

Src/Newtonsoft.Json/Linq/JPropertyDescriptor.cs

@@ -52,10 +52,9 @@ namespace Newtonsoft.Json.Linq
         /// When overridden in a derived class, returns whether resetting an object changes its value.
         /// </summary>
         /// <returns>
-        /// true if resetting the component changes its value; otherwise, false.
+        /// <c>true</c> if resetting the component changes its value; otherwise, <c>false</c>.
         /// </returns>
-        /// <param name="component">The component to test for reset capability. 
-        ///                 </param>
+        /// <param name="component">The component to test for reset capability.</param>
         public override bool CanResetValue(object component)
         {
             return false;
@@ -102,10 +101,9 @@ namespace Newtonsoft.Json.Linq
         /// When overridden in a derived class, determines a value indicating whether the value of this property needs to be persisted.
         /// </summary>
         /// <returns>
-        /// true if the property should be persisted; otherwise, false.
+        /// <c>true</c> if the property should be persisted; otherwise, <c>false</c>.
         /// </returns>
-        /// <param name="component">The component with the property to be examined for persistence. 
-        ///                 </param>
+        /// <param name="component">The component with the property to be examined for persistence.</param>
         public override bool ShouldSerializeValue(object component)
         {
             return false;
@@ -126,7 +124,7 @@ namespace Newtonsoft.Json.Linq
         /// When overridden in a derived class, gets a value indicating whether this property is read-only.
         /// </summary>
         /// <returns>
-        /// true if the property is read-only; otherwise, false.
+        /// <c>true</c> if the property is read-only; otherwise, <c>false</c>.
         /// </returns>
         public override bool IsReadOnly
         {

Src/Newtonsoft.Json/Linq/JToken.cs

@@ -152,7 +152,7 @@ namespace Newtonsoft.Json.Linq
         /// </summary>
         /// <param name="t1">The first <see cref="JToken"/> to compare.</param>
         /// <param name="t2">The second <see cref="JToken"/> to compare.</param>
-        /// <returns>true if the tokens are equal; otherwise false.</returns>
+        /// <returns><c>true</c> if the tokens are equal; otherwise <c>false</c>.</returns>
         public static bool DeepEquals(JToken t1, JToken t2)
         {
             return (t1 == t2 || (t1 != null && t2 != null && t1.DeepEquals(t2)));

Src/Newtonsoft.Json/Linq/JTokenEqualityComparer.cs

@@ -38,7 +38,7 @@ namespace Newtonsoft.Json.Linq
         /// <param name="x">The first object of type <see cref="JToken"/> to compare.</param>
         /// <param name="y">The second object of type <see cref="JToken"/> to compare.</param>
         /// <returns>
-        /// true if the specified objects are equal; otherwise, false.
+        /// <c>true</c> if the specified objects are equal; otherwise, <c>false</c>.
         /// </returns>
         public bool Equals(JToken x, JToken y)
         {

Src/Newtonsoft.Json/Linq/JTokenReader.cs

@@ -68,7 +68,7 @@ namespace Newtonsoft.Json.Linq
         /// Reads the next JSON token from the stream.
         /// </summary>
         /// <returns>
-        /// true if the next token was read successfully; false if there are no more tokens to read.
+        /// <c>true</c> if the next token was read successfully; <c>false</c> if there are no more tokens to read.
         /// </returns>
         public override bool Read()
         {

Src/Newtonsoft.Json/Linq/JValue.cs

@@ -849,7 +849,7 @@ namespace Newtonsoft.Json.Linq
         /// Indicates whether the current object is equal to another object of the same type.
         /// </summary>
         /// <returns>
-        /// true if the current object is equal to the <paramref name="other"/> parameter; otherwise, false.
+        /// <c>true</c> if the current object is equal to the <paramref name="other"/> parameter; otherwise, <c>false</c>.
         /// </returns>
         /// <param name="other">An object to compare with this object.</param>
         public bool Equals(JValue other)
@@ -867,7 +867,7 @@ namespace Newtonsoft.Json.Linq
         /// </summary>
         /// <param name="obj">The <see cref="T:System.Object"/> to compare with the current <see cref="T:System.Object"/>.</param>
         /// <returns>
-        /// true if the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Object"/>; otherwise, false.
+        /// <c>true</c> if the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Object"/>; otherwise, <c>false</c>.
         /// </returns>
         /// <exception cref="T:System.NullReferenceException">
         /// The <paramref name="obj"/> parameter is null.