Minor code edits; etc.

Author: peteroupc

.github/workflows/codeql-analysis.yml

@@ -6,7 +6,7 @@
 #
 # ******** NOTE ********
 # We have attempted to detect the languages in your repository. Please check
-# the `language` matrix defined below to confirm you have the correct set of
+# the `language` matrix defined next to confirm you have the correct set of
 # supported CodeQL languages.
 #
 name: "CodeQL"

CBOR/PeterO/Cbor/CBORObject.cs

@@ -25,7 +25,7 @@ namespace PeterO.Cbor {
   /// <remarks>
   /// <para><b>Converting CBOR objects</b></para>
   /// <para>There are many ways to get a CBOR object, including from
-  /// bytes, objects, streams and JSON, as described below.</para>
+  /// bytes, objects, streams and JSON, as described later.</para>
   /// <para><b>To and from byte arrays:</b> The
   /// CBORObject.DecodeFromBytes method converts a byte array in CBOR
   /// format to a CBOR object. The EncodeToBytes method converts a CBOR
@@ -2792,8 +2792,8 @@ public static CBORObject FromObject(
     /// <item>Then, the method returns a CBOR map with each eligible
     /// getter's name or property name as each key, and with the
     /// corresponding value returned by that getter as that key's value.
-    /// Before adding a key-value pair to the map, the key's name is
-    /// adjusted according to the rules described in the <see
+    /// Before adding a key-value pair to the map, the key's name adjusts
+    /// according to the rules described in the <see
     /// cref='PeterO.Cbor.PODOptions'/> documentation. Note that for
     /// security reasons, certain types are not supported even if they
     /// contain eligible getters.</item>
@@ -5265,7 +5265,7 @@ public CBORObject AtJSONPointer(string pointer, CBORObject defaultValue) {
     /// <summary>Returns a copy of this object after applying the
     /// operations in a JSON patch, in the form of a CBOR object. JSON
     /// patches are specified in RFC 6902 and their format is summarized in
-    /// the remarks below.</summary>
+    /// the remarks given later.</summary>
     /// <param name='patch'>A JSON patch in the form of a CBOR object; it
     /// has the form summarized in the remarks.</param>
     /// <returns>The result of the patch operation.</returns>

CBOR/PeterO/Cbor/CharacterReader.cs

@@ -37,7 +37,7 @@ public CharacterReader(string str) : this(str, false, false) {
     // string.</param>
     // <param name='skipByteOrderMark'>If true and the first character in
     // the string is U+FEFF, skip that character.</param>
-    // <exception cref="ArgumentNullException">The parameter <paramref
+    // <exception cref='ArgumentNullException'>The parameter <paramref
     // name='str'/> is null.</exception>
     public CharacterReader(string str, bool skipByteOrderMark)
       : this(str, skipByteOrderMark, false) {
@@ -52,7 +52,7 @@ public CharacterReader(string str, bool skipByteOrderMark)
     // <param name='errorThrow'>When encountering invalid encoding, throw
     // an exception if this parameter is true, or replace it with U+FFFD
     // (replacement character) if this parameter is false.</param>
-    // <exception cref="ArgumentNullException">The parameter <paramref
+    // <exception cref='ArgumentNullException'>The parameter <paramref
     // name='str'/> is null.</exception>
     public CharacterReader(
       string str,
@@ -80,12 +80,12 @@ public CharacterReader(
     // <param name='length'>The length, in code units, of the desired
     // portion of <paramref name='str'/> (but not more than <paramref
     // name='str'/> 's length).</param>
-    // <exception cref="ArgumentException">Either &#x22;offset&#x22; or
+    // <exception cref='ArgumentException'>Either &#x22;offset&#x22; or
     // &#x22;length&#x22; is less than 0 or greater than
     // &#x22;str&#x22;&#x27;s length, or &#x22;str&#x22;&#x27;s length
     // minus &#x22;offset&#x22; is less than
     // &#x22;length&#x22;.</exception>
-    // <exception cref="ArgumentNullException">The parameter <paramref
+    // <exception cref='ArgumentNullException'>The parameter <paramref
     // name='str'/> is null.</exception>
     public CharacterReader(string str, int offset, int length)
       : this(str, offset, length, false, false) {
@@ -105,9 +105,9 @@ public CharacterReader(string str, int offset, int length)
     // <param name='errorThrow'>When encountering invalid encoding, throw
     // an exception if this parameter is true, or replace it with U+FFFD
     // (replacement character) if this parameter is false.</param>
-    // <exception cref="ArgumentNullException">The parameter <paramref
+    // <exception cref='ArgumentNullException'>The parameter <paramref
     // name='str'/> is null.</exception>
-    // <exception cref="ArgumentException">Either <paramref
+    // <exception cref='ArgumentException'>Either <paramref
     // name='offset'/> or <paramref name='length'/> is less than 0 or
     // greater than <paramref name='str'/> 's length, or <paramref
     // name='str'/> 's length minus <paramref name='offset'/> is less than
@@ -157,7 +157,7 @@ public CharacterReader(
     // first in the stream, and replace invalid byte sequences with
     // replacement characters (U+FFFD).</summary>
     // <param name='stream'>A readable data stream.</param>
-    // <exception cref="ArgumentNullException">The parameter <paramref
+    // <exception cref='ArgumentNullException'>The parameter <paramref
     // name='stream'/> is null.</exception>
     public CharacterReader(Stream stream) : this(stream, 0, false) {
     }
@@ -208,7 +208,7 @@ public CharacterReader(Stream stream, int mode, bool errorThrow)
     // <item>3: Detect UTF-16 using BOM, otherwise UTF-8.</item>
     // <item>4: Detect UTF-16/UTF-32 using BOM, otherwise UTF-8. (Tries to
     // detect UTF-32 first.)</item></list>.</param>
-    // <exception cref="ArgumentNullException">The parameter <paramref
+    // <exception cref='ArgumentNullException'>The parameter <paramref
     // name='stream'/> is null.</exception>
     public CharacterReader(Stream stream, int mode)
       : this(stream, mode, false, false) {
@@ -239,7 +239,7 @@ public CharacterReader(Stream stream, int mode)
     // (including when "mode" is 0) and this parameter is <c>true</c>,
     // won't skip the BOM character if it occurs at the start of the
     // stream.</param>
-    // <exception cref="ArgumentNullException">The parameter <paramref
+    // <exception cref='ArgumentNullException'>The parameter <paramref
     // name='stream'/> is null.</exception>
     public CharacterReader(
       Stream stream,
@@ -273,9 +273,9 @@ private interface IByteReader {
     // <returns>The number of code points read from the stream. This can
     // be less than the <paramref name='length'/> parameter if the end of
     // the stream is reached.</returns>
-    // <exception cref="ArgumentNullException">The parameter <paramref
+    // <exception cref='ArgumentNullException'>The parameter <paramref
     // name='chars'/> is null.</exception>
-    // <exception cref="ArgumentException">Either <paramref name='index'/>
+    // <exception cref='ArgumentException'>Either <paramref name='index'/>
     // or <paramref name='length'/> is less than 0 or greater than
     // <paramref name='chars'/> 's length, or <paramref name='chars'/> 's
     // length minus <paramref name='index'/> is less than <paramref

CBOR/docs.xml

@@ -1799,7 +1799,7 @@
             <remarks>
             <para><b>Converting CBOR objects</b></para>
             <para>There are many ways to get a CBOR object, including from
-            bytes, objects, streams and JSON, as described below.</para>
+            bytes, objects, streams and JSON, as described later.</para>
             <para><b>To and from byte arrays:</b> The
             CBORObject.DecodeFromBytes method converts a byte array in CBOR
             format to a CBOR object. The EncodeToBytes method converts a CBOR
@@ -1980,7 +1980,7 @@
             <summary>Returns a copy of this object after applying the
             operations in a JSON patch, in the form of a CBOR object. JSON
             patches are specified in RFC 6902 and their format is summarized in
-            the remarks below.</summary>
+            the remarks given later.</summary>
             <param name='patch'>A JSON patch in the form of a CBOR object; it
             has the form summarized in the remarks.</param>
             <returns>The result of the patch operation.</returns>
@@ -3983,8 +3983,7 @@
             <item>Then, the method returns a CBOR map with each eligible
             getter's name or property name as each key, and with the
             corresponding value returned by that getter as that key's value.
-            Before adding a key-value pair to the map, the key's name is
-            adjusted according to the rules described in the <see cref='PeterO.Cbor.PODOptions'/> documentation. Note that for
+            Before adding a key-value pair to the map, the key's name adjusts according to the rules described in the <see cref='PeterO.Cbor.PODOptions'/> documentation. Note that for
             security reasons, certain types are not supported even if they
             contain eligible getters.</item>
              </list>

docs/PeterO.Cbor.CBORObject.md

@@ -8,7 +8,7 @@ Represents an object in Concise Binary Object Representation (CBOR) and contains
 
 <b>Converting CBOR objects</b>
 
-There are many ways to get a CBOR object, including from bytes, objects, streams and JSON, as described below.
+There are many ways to get a CBOR object, including from bytes, objects, streams and JSON, as described later.
 
 <b>To and from byte arrays:</b> The CBORObject.DecodeFromBytes method converts a byte array in CBOR format to a CBOR object. The EncodeToBytes method converts a CBOR object to its corresponding byte array in CBOR format.
 
@@ -630,7 +630,7 @@ This object is not an array.
     public PeterO.Cbor.CBORObject ApplyJSONPatch(
         PeterO.Cbor.CBORObject patch);
 
-Returns a copy of this object after applying the operations in a JSON patch, in the form of a CBOR object. JSON patches are specified in RFC 6902 and their format is summarized in the remarks below.
+Returns a copy of this object after applying the operations in a JSON patch, in the form of a CBOR object. JSON patches are specified in RFC 6902 and their format is summarized in the remarks given later.
 
 <b>Remarks:</b> A JSON patch is an array with one or more maps. Each map has the following keys:
 
@@ -2527,7 +2527,7 @@ Generates a CBORObject from an arbitrary object, using the specified options to
 
  * (*) In the Java version, eligible getters are public, nonstatic methods starting with "get" or "is" (either word followed by a character other than a basic digit or lowercase letter, that is, other than "a" to "z" or "0" to "9"), that take no parameters and do not return void, except that methods named "getClass" are not eligible getters. In addition, public, nonstatic, nonfinal fields are also eligible getters. If a class has two otherwise eligible getters (methods and/or fields) of the form "isX" and "getX", where "X" is the same in both, or two such getters with the same name but different return type, they are not eligible getters.
 
- * Then, the method returns a CBOR map with each eligible getter's name or property name as each key, and with the corresponding value returned by that getter as that key's value. Before adding a key-value pair to the map, the key's name is adjusted according to the rules described in the [PeterO.Cbor.PODOptions](PeterO.Cbor.PODOptions.md) documentation. Note that for security reasons, certain types are not supported even if they contain eligible getters.
+ * Then, the method returns a CBOR map with each eligible getter's name or property name as each key, and with the corresponding value returned by that getter as that key's value. Before adding a key-value pair to the map, the key's name adjusts according to the rules described in the [PeterO.Cbor.PODOptions](PeterO.Cbor.PODOptions.md) documentation. Note that for security reasons, certain types are not supported even if they contain eligible getters.
 
 <b>REMARK:</b> .NET enumeration (  `Enum`  ) constants could also have been converted to text strings with  `ToString()`  , but that method will return multiple names if the specified Enum object is a combination of Enum objects (for example if the object is  `FileAccess.Read | FileAccess.Write`  ). More generally, if Enums are converted to text strings, constants from Enum types with the  `Flags`  attribute, and constants from the same Enum type that share an underlying value, should not be passed to this method.