Skip to content

Commit

Permalink
edit documentation, generally for style
Browse files Browse the repository at this point in the history
  • Loading branch information
@peteroupc
peteroupc committed Dec 24, 2024
1 parent f482b55 commit 7dabb5c
Show file tree
Hide file tree
Showing 13 changed files with 110 additions and 110 deletions.
18 changes: 9 additions & 9 deletions CBOR/PeterO/Cbor/CBOREncodeOptions.cs
View file
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 upper-case and/or basic lower-case letters:
/// of basic uppercase and/or 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 @@ -81,14 +81,14 @@ public CBOREncodeOptions(
/// library. The key <c>keepkeyorder</c> was introduced in version 4.5
/// of this library.(Keys are compared using a basic case-insensitive
/// comparison, in which two strings are equal if they match after
/// converting the basic upper-case letters A to Z (U+0041 to U+005A)
/// in both strings to basic lower-case letters.) If two or more
/// key/value pairs have equal keys (in a basic case-insensitive
/// comparison), the 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 upper-case and/or basic lower-case letters), which means
/// true, and any other value meaning false. For example,
/// converting the basic uppercase letters A to Z (U+0041 to U+005A) in
/// both strings to basic lowercase letters.) If two or more key/value
/// pairs have equal keys (in a basic case-insensitive comparison), the
/// 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,
/// <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
28 changes: 14 additions & 14 deletions CBOR/PeterO/Cbor/CBORObject.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1188,7 +1188,7 @@ public static CBORObject FromJSONString(
/// ) or a plain-old-data type (POCO or POJO type) within
/// the control of the application. If the plain-old-data type
/// references other data types, those types should likewise meet
/// either criterion above.</param>
/// either criterion given earlier.</param>
/// <returns>The converted object.</returns>
/// <exception cref='PeterO.Cbor.CBORException'>The given type
/// <paramref name='t'/> , or this object's CBOR type, is not
Expand Down Expand Up @@ -1235,7 +1235,7 @@ public object ToObject(Type t) {
/// <c>String</c> ) or a plain-old-data type (POCO or POJO type) within
/// the control of the application. If the plain-old-data type
/// references other data types, those types should likewise meet
/// either criterion above.</param>
/// either criterion given earlier.</param>
/// <param name='mapper'>This parameter controls which data types are
/// eligible for Plain-Old-Data deserialization and includes custom
/// converters from CBOR objects to certain data types.</param>
Expand Down Expand Up @@ -1267,7 +1267,7 @@ public object ToObject(Type t, CBORTypeMapper mapper) {
/// <c>String</c> ) or a plain-old-data type (POCO or POJO type) within
/// the control of the application. If the plain-old-data type
/// references other data types, those types should likewise meet
/// either criterion above.</param>
/// either criterion given earlier.</param>
/// <param name='options'>Specifies options for controlling
/// deserialization of CBOR objects.</param>
/// <returns>The converted object.</returns>
Expand Down Expand Up @@ -1546,7 +1546,7 @@ public object ToObject(Type t, PODOptions options) {
/// ignored.</item>
/// <item>(*) In the Java version, eligible setters are
/// public, nonstatic methods starting with "set" followed by a
/// character other than a basic digit or lower-case letter, that is,
/// character other than a basic digit or lowercase letter, that is,
/// other than "a" to "z" or "0" to "9", that take one parameter. The
/// class containing an eligible setter must have a public, nonstatic
/// method with the same name, but starting with "get" or "is" rather
Expand Down Expand Up @@ -1581,7 +1581,7 @@ public object ToObject(Type t, PODOptions options) {
/// , or a plain-old-data type (POCO or POJO type) within
/// the control of the application. If the plain-old-data type
/// references other data types, those types should likewise meet
/// either criterion above.</param>
/// either criterion given earlier.</param>
/// <param name='mapper'>This parameter controls which data types are
/// eligible for Plain-Old-Data deserialization and includes custom
/// converters from CBOR objects to certain data types. Can be
Expand Down Expand Up @@ -1650,7 +1650,7 @@ public object ToObject(Type t, CBORTypeMapper mapper, PODOptions
/// <c>String</c>, or a plain-old-data type (POCO or POJO type) within
/// the control of the application. If the plain-old-data type
/// references other data types, those types should likewise meet
/// either criterion above.</param>
/// either criterion given earlier.</param>
/// <param name='mapper'>This parameter controls which data types are
/// eligible for Plain-Old-Data deserialization and includes custom
/// converters from CBOR objects to certain data types. Can be
Expand Down Expand Up @@ -1705,7 +1705,7 @@ public static object DecodeObjectFromBytes(
/// <c>String</c>, or a plain-old-data type (POCO or POJO type) within
/// the control of the application. If the plain-old-data type
/// references other data types, those types should likewise meet
/// either criterion above.</param>
/// either criterion given earlier.</param>
/// <returns>An object of the given type decoded from the given byte
/// array. Returns null (as opposed to CBORObject.Null) if <paramref
/// name='data'/> is empty and the AllowEmpty property is set on the
Expand Down Expand Up @@ -1744,7 +1744,7 @@ public static object DecodeObjectFromBytes(
/// <c>String</c>, or a plain-old-data type (POCO or POJO type) within
/// the control of the application. If the plain-old-data type
/// references other data types, those types should likewise meet
/// either criterion above.</param>
/// either criterion given earlier.</param>
/// <param name='mapper'>This parameter controls which data types are
/// eligible for Plain-Old-Data deserialization and includes custom
/// converters from CBOR objects to certain data types. Can be
Expand Down Expand Up @@ -1791,7 +1791,7 @@ public static object DecodeObjectFromBytes(
/// <c>String</c>, or a plain-old-data type (POCO or POJO type) within
/// the control of the application. If the plain-old-data type
/// references other data types, those types should likewise meet
/// either criterion above.</param>
/// either criterion given earlier.</param>
/// <returns>An object of the given type decoded from the given byte
/// array. Returns null (as opposed to CBORObject.Null) if <paramref
/// name='data'/> is empty and the AllowEmpty property is set on the
Expand Down Expand Up @@ -2759,7 +2759,7 @@ public static CBORObject FromObject(
/// <item>(*) 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 lower-case letter, that is, other than
/// 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
Expand Down Expand Up @@ -5245,7 +5245,7 @@ public CBORObject AtJSONPointer(string pointer, CBORObject defaultValue) {
/// <list>
/// <item>"op" - Required. This key's value is the patch operation and
/// must be "add", "remove", "move", "copy", "test", or "replace", in
/// basic lower case letters and no other case combination.</item>
/// basic lowercase letters and no other case combination.</item>
/// <item>"value" - Required if the operation is "add", "replace", or
/// "test" and specifies the item to add (insert), or that will replace
/// the existing item, or to check an existing item for equality,
Expand Down Expand Up @@ -7687,7 +7687,7 @@ private static void WriteStreamedString(string str, Stream stream) {
} else if (c <= 0x7ff) {
if (byteIndex + 2 > StreamedStringBufferLength) {
// Write bytes retrieved so far - the next two bytes
// would exceed the length, and the CBOR spec forbids
// would exceed the length, and the CBOR specification forbids
// splitting characters when generating text strings
if (!streaming) {
stream.WriteByte(0x7f);
Expand All @@ -7712,7 +7712,7 @@ private static void WriteStreamedString(string str, Stream stream) {
if (c <= 0xffff) {
if (byteIndex + 3 > StreamedStringBufferLength) {
// Write bytes retrieved so far - the next three bytes
// would exceed the length, and the CBOR spec forbids
// would exceed the length, and the CBOR specification forbids
// splitting characters when generating text strings
if (!streaming) {
stream.WriteByte(0x7f);
Expand All @@ -7728,7 +7728,7 @@ private static void WriteStreamedString(string str, Stream stream) {
} else {
if (byteIndex + 4 > StreamedStringBufferLength) {
// Write bytes retrieved so far - the next four bytes
// would exceed the length, and the CBOR spec forbids
// would exceed the length, and the CBOR specification forbids
// splitting characters when generating text strings
if (!streaming) {
stream.WriteByte(0x7f);
Expand Down
16 changes: 8 additions & 8 deletions CBOR/PeterO/Cbor/CBORObjectExtra.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -374,7 +374,7 @@ public static CBORObject FromCBORObjectAndTag(CBORObject o, ulong tag) {
/// (such as <c>int</c> or <c>String</c> ) or a plain-old-data type
/// (POCO or POJO type) within the control of the application. If the
/// plain-old-data type references other data types, those types should
/// likewise meet either criterion above.</typeparam>
/// likewise meet either criterion given earlier.</typeparam>
/// <returns>The converted object.</returns>
/// <exception cref='NotSupportedException'>The given type "T", or this
/// object's CBOR type, is not supported.</exception>
Expand All @@ -399,7 +399,7 @@ public T ToObject<T>() {
/// (such as <c>int</c> or <c>String</c> ) or a plain-old-data type
/// (POCO or POJO type) within the control of the application. If the
/// plain-old-data type references other data types, those types should
/// likewise meet either criterion above.</typeparam>
/// likewise meet either criterion given earlier.</typeparam>
/// <returns>The converted object.</returns>
/// <exception cref='NotSupportedException'>The given type "T", or this
/// object's CBOR type, is not supported.</exception>
Expand All @@ -423,7 +423,7 @@ public T ToObject<T>(CBORTypeMapper mapper) {
/// (such as <c>int</c> or <c>String</c> ) or a plain-old-data type
/// (POCO or POJO type) within the control of the application. If the
/// plain-old-data type references other data types, those types should
/// likewise meet either criterion above.</typeparam>
/// likewise meet either criterion given earlier.</typeparam>
/// <returns>The converted object.</returns>
/// <exception cref='NotSupportedException'>The given type "T", or this
/// object's CBOR type, is not supported.</exception>
Expand All @@ -450,7 +450,7 @@ public T ToObject<T>(PODOptions options) {
/// (such as <c>int</c> or <c>String</c> ) or a plain-old-data type
/// (POCO or POJO type) within the control of the application. If the
/// plain-old-data type references other data types, those types should
/// likewise meet either criterion above.</typeparam>
/// likewise meet either criterion given earlier.</typeparam>
/// <returns>The converted object.</returns>
/// <exception cref='NotSupportedException'>The given type "T", or this
/// object's CBOR type, is not supported.</exception>
Expand Down Expand Up @@ -485,7 +485,7 @@ public T ToObject<T>(CBORTypeMapper mapper, PODOptions options) {
/// <c>int</c> or <c>String</c>, or a plain-old-data type (POCO or
/// POJO type) within the control of the application. If the
/// plain-old-data type references other data types, those types should
/// likewise meet either criterion above.</typeparam>
/// likewise meet either criterion given earlier.</typeparam>
/// <returns>An object of the given type decoded from the given byte
/// array. Returns null (as opposed to CBORObject.Null) if <paramref
/// name='data'/> is empty and the AllowEmpty property is set on the
Expand Down Expand Up @@ -530,7 +530,7 @@ public static T DecodeObjectFromBytes<T>(
/// such as <c>int</c> or <c>String</c>, or a plain-old-data type
/// (POCO or POJO type) within the control of the application. If the
/// plain-old-data type references other data types, those types should
/// likewise meet either criterion above.</typeparam>
/// likewise meet either criterion given earlier.</typeparam>
/// <returns>An object of the given type decoded from the given byte
/// array. Returns null (as opposed to CBORObject.Null) if <paramref
/// name='data'/> is empty and the AllowEmpty property is set on the
Expand Down Expand Up @@ -573,7 +573,7 @@ public static T DecodeObjectFromBytes<T>(byte[] data, CBOREncodeOptions
/// <c>int</c> or <c>String</c>, or a plain-old-data type (POCO or
/// POJO type) within the control of the application. If the
/// plain-old-data type references other data types, those types should
/// likewise meet either criterion above.</typeparam>
/// likewise meet either criterion given earlier.</typeparam>
/// <returns>An object of the given type decoded from the given byte
/// array. Returns null (as opposed to CBORObject.Null) if <paramref
/// name='data'/> is empty and the AllowEmpty property is set on the
Expand Down Expand Up @@ -612,7 +612,7 @@ public static T DecodeObjectFromBytes<T>(
/// <c>int</c> or <c>String</c>, or a plain-old-data type (POCO or
/// POJO type) within the control of the application. If the
/// plain-old-data type references other data types, those types should
/// likewise meet either criterion above.</typeparam>
/// likewise meet either criterion given earlier.</typeparam>
/// <returns>An object of the given type decoded from the given byte
/// array. Returns null (as opposed to CBORObject.Null) if <paramref
/// name='data'/> is empty and the AllowEmpty property is set on the
Expand Down
18 changes: 9 additions & 9 deletions CBOR/PeterO/Cbor/JSONOptions.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -112,24 +112,24 @@ 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 upper-case and/or basic lower-case letters:
/// basic uppercase and/or 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
/// this version of the CBOR library. (Keys are compared using a basic
/// case-insensitive comparison, in which two strings are equal if they
/// match after converting the basic upper-case letters A to Z (U+0041
/// to U+005A) in both strings to basic lower-case letters.) If two or
/// match after converting the basic uppercase letters A to Z (U+0041
/// to U+005A) in both strings to basic lowercase letters.) If two or
/// more key/value pairs have equal keys (in a basic case-insensitive
/// comparison), the value given for the last such key is used. The
/// first 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 upper-case and/or basic lower-case
/// letters), which means true, and any other value meaning false. The
/// last key, <c>numberconversion</c>, can have a value of any name
/// given in the <c>JSONOptions.ConversionMode</c> enumeration (where
/// the letters can be any combination of basic upper-case and/or basic
/// lower-case letters), and any other value is unrecognized. (If the
/// any combination of basic uppercase and/or basic lowercase letters),
/// which means true, and any other value meaning false. The last key,
/// <c>numberconversion</c>, can have a value of any name given in the
/// <c>JSONOptions.ConversionMode</c> enumeration (where the letters
/// can be any combination of basic uppercase and/or basic lowercase
/// letters), and any other value is unrecognized. (If the
/// <c>numberconversion</c> key is not given, its value is treated as
/// <c>intorfloat</c> (formerly <c>full</c> in versions earlier than
/// 5.0). If that key is given, but has an unrecognized value, an
Expand Down
Loading

0 comments on commit 7dabb5c

Please sign in to comment.