Use correct doc dialect for true and false
authorJérémie Laval <jeremie.laval@gmail.com>
Mon, 10 Jan 2011 18:42:39 +0000 (18:42 +0000)
committerJérémie Laval <jeremie.laval@gmail.com>
Thu, 13 Jan 2011 15:38:42 +0000 (15:38 +0000)
mcs/class/Mono.Parallel/Documentation/en/Mono.Collections.Concurrent/ConcurrentOrderedList`1.xml
mcs/class/Mono.Parallel/Documentation/en/Mono.Collections.Concurrent/ConcurrentSkipList`1.xml
mcs/class/Mono.Parallel/Documentation/en/Mono.Threading/CSnzi.xml
mcs/class/Mono.Parallel/Documentation/en/Mono.Threading/Snzi.xml
mcs/class/Mono.Parallel/Documentation/en/Mono.Threading/SpinLockWrapper.xml

index 337ccece5d40c1c25f090809e2eb33b4c5c21090..aa509279b782fb0748f3b93c5c860792801a91aa 100644 (file)
       <Docs>
         <param name="data">The data to locate in the list.</param>
         <summary>Checks if the supplied element is in the ConcurrentOrderedList.</summary>
-        <returns>true if the item is found, false otherwise.</returns>
+        <returns>
+          <see langword="true" /> if the item is found, <see langword="false" /> otherwise.</returns>
         <remarks />
       </Docs>
     </Member>
       <Docs>
         <param name="key">Hash value to check.</param>
         <summary>Checks if the supplied hash corresponds to an element in the ConcurrentOrderedList.</summary>
-        <returns>true if an item corresponding to the given hash is found, false otherwise.</returns>
+        <returns>
+          <see langword="true" /> if an item corresponding to the given hash is found, <see langword="false" /> otherwise.</returns>
         <remarks>A call to <see cref="M:ConcurrentOrderedList&lt;T&gt;.Contains()" /> is equivalent to calling this method using the <see cref="T:System.Collections.Generic.IEqualityComparer&lt;T&gt;.GetHashCode(T)" /> method with <see cref="P:ConcurrentOrderedList&lt;T&gt;.Comparer" />.</remarks>
       </Docs>
     </Member>
       <Docs>
         <param name="data">Data to add in the collection.</param>
         <summary>Try to add an element to the collection.</summary>
-        <returns>True if the insertion was successful, false otherwise.</returns>
+        <returns>True if the insertion was successful, <see langword="false" /> otherwise.</returns>
         <remarks>This method add the supplied element only if there is no other element with an identical hash already in the list.</remarks>
       </Docs>
     </Member>
index 4623927de5f9767a4e402eae57fd58742d08c280..f71e0766b543055e2420de1099dd1651249078e9 100644 (file)
@@ -86,7 +86,8 @@
       <Docs>
         <param name="value">To be added.</param>
         <summary>Test if an element is in the collection</summary>
-        <returns>true if the element supplied was found, false otherwise</returns>
+        <returns>
+          <see langword="true" /> if the element supplied was found, <see langword="false" /> otherwise</returns>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
       <Docs>
         <param name="hash">Hash value to check.</param>
         <summary>Checks if the supplied hash corresponds to an element in the ConcurrentOrderedList.</summary>
-        <returns>true if an item corresponding to the given hash is found, false otherwise.</returns>
+        <returns>
+          <see langword="true" /> if an item corresponding to the given hash is found, <see langword="false" /> otherwise.</returns>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
         <param name="hash">Hash value to check.</param>
         <param name="value">Will be set to the element corresponding to the provided hash if it was found.</param>
         <summary>Check if an element with the provided hash exists in the list and provide it.</summary>
-        <returns>true if an element with the provided hash was found and if value point to it, false otherwise.</returns>
+        <returns>
+          <see langword="true" /> if an element with the provided hash was found and if value point to it, <see langword="false" /> otherwise.</returns>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
index 6db48538ee3046c4c3c9dae0e2dad3365f6d32c2..b262a3f1a8969e3b4db6898981f92d06aaf77182 100644 (file)
@@ -57,7 +57,7 @@
       <Parameters />
       <Docs>
         <summary>Close the CSnzi object to subsequent Arrive or Depart action until <see cref="M:Mono.Threading.CSnzi.Open()" /> is called.</summary>
-        <returns>True if the state of the CSnzi was zero or if it was already closed, false otherwise.</returns>
+        <returns>True if the state of the CSnzi was zero or if it was already closed, <see langword="false" /> otherwise.</returns>
         <remarks />
       </Docs>
     </Member>
@@ -77,7 +77,7 @@
       <Docs>
         <param name="node">The node to execute the decrement operation on.</param>
         <summary>Decrement the state of the CSnzi object.</summary>
-        <returns>True if the CSnzi is open and its state is zero, false otherwise.</returns>
+        <returns>True if the CSnzi is open and its state is zero, <see langword="false" /> otherwise.</returns>
         <remarks>Node argument must have been returned by a prior <see cref="M:Mono.Threading.CSnzi.Arrive()" /> call.</remarks>
       </Docs>
     </Member>
index 3c4673788f50c1e90801d81da46c75fc4593144a..a159b2f9b163d48148035c80730dde0946789662 100644 (file)
@@ -71,7 +71,7 @@
       </ReturnValue>
       <Docs>
         <summary>Query if Snzi is has a zero value or not.</summary>
-        <value>True if Snzi is zero, false otherwise.</value>
+        <value>True if Snzi is zero, <see langword="false" /> otherwise.</value>
         <remarks />
       </Docs>
     </Member>
index 37b5665139a30ce0e984bee19528380681131dc1..2c0703bd92a738d9f02b4e302dc15cf1bb369898 100644 (file)
@@ -38,7 +38,8 @@
         <Parameter Name="enableTracking" Type="System.Boolean" />
       </Parameters>
       <Docs>
-        <param name="enableTracking">true to enable thread tracking, false otherwise.</param>
+        <param name="enableTracking">
+          <see langword="true" /> to enable thread tracking, <see langword="false" /> otherwise.</param>
         <summary>Initialize underlying <see cref="T:System.Threading.SpinLock" /> with provided value.</summary>
         <remarks />
       </Docs>