Documentation updates
Use "encoder-decoder" rather than "encoder / decoder".
Minor limitations clarifications.
* Readme and copyright updates
* Small documentation fixes
---------
Co-authored-by: Laurence Lundblade <lgl@securitytheory.com>
diff --git a/README.md b/README.md
index 159051b..8ced909 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
-**QCBOR** is a powerful, commercial-quality CBOR encoder/decoder that
+**QCBOR** is a powerful, commercial-quality CBOR encoder-decoder that
implements these RFCs:
* [RFC8949](https://tools.ietf.org/html/rfc8949) The CBOR Standard. (Nearly everything
diff --git a/cmd_line_main.c b/cmd_line_main.c
index 59ceb3a..4df6e98 100644
--- a/cmd_line_main.c
+++ b/cmd_line_main.c
@@ -1,5 +1,5 @@
/*==============================================================================
- cmd_line_mainc.c -- Runs tests for QCBOR encoder / decoder
+ cmd_line_mainc.c -- Runs tests for QCBOR encoder-decoder
Copyright (c) 2018-2020, Laurence Lundblade. All rights reserved.
diff --git a/inc/qcbor/qcbor_common.h b/inc/qcbor/qcbor_common.h
index b58a332..288c691 100644
--- a/inc/qcbor/qcbor_common.h
+++ b/inc/qcbor/qcbor_common.h
@@ -237,7 +237,7 @@
/**
- * Error codes returned by QCBOR Encoder and Decoder.
+ * Error codes returned by QCBOR Encoder-Decoder.
*
* They are grouped to keep the code size of
* QCBORDecode_IsNotWellFormedError() and
diff --git a/inc/qcbor/qcbor_decode.h b/inc/qcbor/qcbor_decode.h
index f54a478..bf866f1 100644
--- a/inc/qcbor/qcbor_decode.h
+++ b/inc/qcbor/qcbor_decode.h
@@ -56,7 +56,7 @@
* # QCBOR Basic Decode
*
* This section discusses decoding assuming familiarity with the
- * general description of this encoder / decoder in section @ref
+ * general description of this encoder-decoder in section @ref
* Overview.
*
* Encoded CBOR has a tree structure where the leaf nodes are
diff --git a/inc/qcbor/qcbor_encode.h b/inc/qcbor/qcbor_encode.h
index 3981e9b..75b4d64 100644
--- a/inc/qcbor/qcbor_encode.h
+++ b/inc/qcbor/qcbor_encode.h
@@ -341,7 +341,7 @@
* float type as 32-bits and a C double type as 64-bits. Floating-point
* epoch dates will be unsupported.
*
- * If USEFULBUF_DISABLE_ALL_FLOATis defined, then floating point
+ * If USEFULBUF_DISABLE_ALL_FLOAT is defined, then floating point
* support is completely disabled. Decoding functions return
* @ref QCBOR_ERR_ALL_FLOAT_DISABLED if a floating point value is
* encountered during decoding. Functions that are encoding floating
@@ -349,31 +349,32 @@
*
* ## Limitations
*
- * Summary Limits of this implementation:
+ * Summary limitations:
* - The entire encoded CBOR must fit into contiguous memory.
- * - Max size of encoded / decoded CBOR data is a few bytes less than @c UINT32_MAX (4GB).
- * - Max array / map nesting level when encoding / decoding is
+ * - Max size of encoded CBOR data is a few bytes less than
+ * @c UINT32_MAX (4GB).
+ * - Max array / map nesting level when encoding or decoding is
* @ref QCBOR_MAX_ARRAY_NESTING (this is typically 15).
- * - Max items in an array or map when encoding / decoding is
+ * - Max items in an array or map when encoding or decoding is
* @ref QCBOR_MAX_ITEMS_IN_ARRAY (typically 65,536).
* - Does not directly support labels in maps other than text strings & integers.
- * - Does not directly support integer labels greater than @c INT64_MAX.
+ * - Does not directly support integer labels beyond whats fits in @c int64_t
+ * or @c uint64_t.
* - Epoch dates limited to @c INT64_MAX (+/- 292 billion years).
- * - Exponents for bigfloats and decimal integers are limited to @c INT64_MAX.
+ * - Exponents for bigfloats and decimal integers are limited to whats fits in
+ * @c int64_t.
* - Tags on labels are ignored during decoding.
* - The maximum tag nesting is @c QCBOR_MAX_TAGS_PER_ITEM (typically 4).
- * - Works only on 32- and 64-bit CPUs (modifications could make it work
- * on 16-bit CPUs).
+ * - Works only on 32- and 64-bit CPUs.
*
* The public interface uses @c size_t for all lengths. Internally the
* implementation uses 32-bit lengths by design to use less memory and
* fit structures on the stack. This limits the encoded CBOR it can
- * work with to size @c UINT32_MAX (4GB) which should be enough.
+ * work with to size @c UINT32_MAX (4GB).
*
- * This implementation assumes two's compliment integer machines.
- * @c <stdint.h> also requires this. It is possible to modify this
- * implementation for another integer representation, but all modern
- * machines seem to be two's compliment.
+ * This implementation requires two's compliment integers. While
+ * C doesn't require two's compliment, <stdint.h> does. Other
+ * parts of this implementation may also require two's compliment.
*/
diff --git a/test/float_tests.c b/test/float_tests.c
index 1a7ade1..97f92bf 100644
--- a/test/float_tests.c
+++ b/test/float_tests.c
@@ -73,7 +73,7 @@
* other formats. CDE and DCBOR standards are not complete yet,
* encodings are a guess. C string literals are used because they
* are the shortest notation. They are used __with a length__ . Null
- * termination doesn't work because * there are zero bytes.
+ * termination doesn't work because there are zero bytes.
*/
static const struct DoubleTestCase DoubleTestCases[] = {
/* Zero */
diff --git a/test/run_tests.h b/test/run_tests.h
index ce44673..6790710 100644
--- a/test/run_tests.h
+++ b/test/run_tests.h
@@ -60,7 +60,7 @@
/**
- @brief Print sizes of encoder / decoder contexts.
+ @brief Print sizes of encoder-decoder contexts.
@param[in] pfOutput Function that is called to output text strings.
@param[in] pOutCtx Context pointer passed to output function.