Skip to content

Commit

Permalink
Edit documentation; minor code edits
Browse files Browse the repository at this point in the history
  • Loading branch information
peteroupc committed Jan 17, 2025
1 parent 50b1c31 commit 897826f
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 21 deletions.
6 changes: 3 additions & 3 deletions CBOR/PeterO/Cbor/CBOREncodeOptions.cs
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ public CBOREncodeOptions(
/// The following is an example of this parameter:
/// <c>allowduplicatekeys=true;ctap2Canonical=true</c>. The key can be
/// any one of the following where the letters can be any combination
/// of basic uppercase and/or basic lowercase letters:
/// of basic uppercase and basic lowercase letters:
/// <c>allowduplicatekeys</c>, <c>ctap2canonical</c>,
/// <c>resolvereferences</c>, <c>useindeflengthstrings</c>,
/// <c>allowempty</c>, <c>float64</c>, <c>keepkeyorder</c>. Keys
Expand All @@ -87,8 +87,8 @@ public CBOREncodeOptions(
/// value given for the last such key is used. The four keys just given
/// can have a value of <c>1</c>, <c>true</c>, <c>yes</c>, or
/// <c>on</c> (where the letters can be any combination of basic
/// uppercase and/or basic lowercase letters), which means true, and
/// any other value meaning false. For example,
/// uppercase and basic lowercase letters), which means true, and any
/// other value meaning false. For example,
/// <c>allowduplicatekeys=Yes</c> and <c>allowduplicatekeys=1</c> both
/// set the <c>AllowDuplicateKeys</c> property to true. In the future,
/// this class may allow other keys to store other kinds of values, not
Expand Down
32 changes: 16 additions & 16 deletions CBOR/PeterO/Cbor/CBORObject.cs
Original file line number Diff line number Diff line change
Expand Up @@ -2552,8 +2552,8 @@ public static CBORObject FromObject(long[] array) {
/// this method (such as <c>int</c> or <c>String</c> ) and/or to
/// plain-old-data types (POCO or POJO types) within the control of the
/// application. If the plain-old-data type references other data
/// types, those types should likewise meet either criterion
/// above.</para>.</param>
/// types, those types should likewise meet either criterion given
/// earlier.</para>.</param>
/// <returns>A CBOR object corresponding to the given object. Returns
/// CBORObject.Null if the object is null.</returns>
[RequiresUnreferencedCode("Do not use in AOT or reflection-free contexts.")]
Expand All @@ -2573,8 +2573,8 @@ public static CBORObject FromObject(object obj) {
/// this method (such as <c>int</c> or <c>String</c> ) and/or to
/// plain-old-data types (POCO or POJO types) within the control of the
/// application. If the plain-old-data type references other data
/// types, those types should likewise meet either criterion
/// above.</para>.</param>
/// types, those types should likewise meet either criterion given
/// earlier.</para>.</param>
/// <param name='options'>An object containing options to control how
/// certain objects are converted to CBOR objects.</param>
/// <returns>A CBOR object corresponding to the given object. Returns
Expand All @@ -2600,8 +2600,8 @@ public static CBORObject FromObject(
/// this method (such as <c>int</c> or <c>String</c> ) and/or to
/// plain-old-data types (POCO or POJO types) within the control of the
/// application. If the plain-old-data type references other data
/// types, those types should likewise meet either criterion
/// above.</para>.</param>
/// types, those types should likewise meet either criterion given
/// earlier.</para>.</param>
/// <param name='mapper'>An object containing optional converters to
/// convert objects of certain types to CBOR objects.</param>
/// <returns>A CBOR object corresponding to the given object. Returns
Expand Down Expand Up @@ -2800,8 +2800,8 @@ public static CBORObject FromObject(
/// ) and/or to
/// plain-old-data types (POCO or POJO types) within the control of the
/// application. If the plain-old-data type references other data
/// types, those types should likewise meet either criterion
/// above.</para>
/// types, those types should likewise meet either criterion given
/// earlier.</para>
/// .</param>
/// <param name='mapper'>An object containing optional converters to
/// convert objects of certain types to CBOR objects. Can be
Expand Down Expand Up @@ -3055,8 +3055,8 @@ public CBORObject WithTag(EInteger bigintTag) {
/// this method (such as <c>int</c> or <c>String</c> ) and/or to
/// plain-old-data types (POCO or POJO types) within the control of the
/// application. If the plain-old-data type references other data
/// types, those types should likewise meet either criterion
/// above.</para>.</param>
/// types, those types should likewise meet either criterion given
/// earlier.</para>.</param>
/// <param name='bigintTag'>Tag number. The tag number 55799 can be
/// used to mark a "self-described CBOR" object. This document does not
/// attempt to list all CBOR tags and their meanings. An up-to-date
Expand Down Expand Up @@ -3133,8 +3133,8 @@ public CBORObject WithTag(int smallTag) {
/// this method (such as <c>int</c> or <c>String</c> ) and/or to
/// plain-old-data types (POCO or POJO types) within the control of the
/// application. If the plain-old-data type references other data
/// types, those types should likewise meet either criterion
/// above.</para>.</param>
/// types, those types should likewise meet either criterion given
/// earlier.</para>.</param>
/// <param name='smallTag'>A 32-bit integer that specifies a tag
/// number. The tag number 55799 can be used to mark a "self-described
/// CBOR" object. This document does not attempt to list all CBOR tags
Expand Down Expand Up @@ -4242,8 +4242,8 @@ public static void Write(object objValue, Stream stream) {
/// this method (such as <c>int</c> or <c>String</c> ) and/or to
/// plain-old-data types (POCO or POJO types) within the control of the
/// application. If the plain-old-data type references other data
/// types, those types should likewise meet either criterion
/// above.</para>.</param>
/// types, those types should likewise meet either criterion given
/// earlier.</para>.</param>
/// <param name='output'>A writable data stream.</param>
/// <param name='options'>CBOR options for encoding the CBOR object to
/// bytes.</param>
Expand Down Expand Up @@ -4311,8 +4311,8 @@ public static void Write(
/// this method (such as <c>int</c> or <c>String</c> ) and/or to
/// plain-old-data types (POCO or POJO types) within the control of the
/// application. If the plain-old-data type references other data
/// types, those types should likewise meet either criterion
/// above.</para>.</param>
/// types, those types should likewise meet either criterion given
/// earlier.</para>.</param>
/// <param name='outputStream'>A writable data stream.</param>
/// <exception cref='ArgumentNullException'>The parameter <paramref
/// name='outputStream'/> is null.</exception>
Expand Down
2 changes: 1 addition & 1 deletion CBOR/PeterO/Cbor/JSONOptions.cs
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ public JSONOptions() : this(String.Empty) {
/// The following is an example of this parameter:
/// <c>writebasic=false;replacesurrogates=true</c>. The key can be any
/// one of the following where the letters can be any combination of
/// basic uppercase and/or basic lowercase letters:
/// basic uppercase and basic lowercase letters:
/// <c>replacesurrogates</c>, <c>allowduplicatekeys</c>,
/// <c>preservenegativezero</c>, <c>numberconversion</c>,
/// <c>writebasic</c>, <c>keepkeyorder</c>. Other keys are ignored in
Expand Down
2 changes: 1 addition & 1 deletion CBOR/PeterO/Cbor/PODOptions.cs
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ public PODOptions(bool removeIsPrefix, bool useCamelCase) {
/// end with whitespace. The string can be empty, but cannot be null.
/// The following is an example of this parameter:
/// <c>usecamelcase=true</c>. The key can be any one of the following
/// where the letters can be any combination of basic uppercase and/or
/// where the letters can be any combination of basic uppercase and
/// basic lowercase letters: <c>usecamelcase</c>. Other keys are
/// ignored in this version of the CBOR library. (Keys are compared
/// using a basic case-insensitive comparison, in which two strings are
Expand Down

0 comments on commit 897826f

Please sign in to comment.