Finish up private and deprecated and doxygen errors for decode
diff --git a/QCBOR.xcodeproj/project.pbxproj b/QCBOR.xcodeproj/project.pbxproj
index 024011f..9060e9e 100644
--- a/QCBOR.xcodeproj/project.pbxproj
+++ b/QCBOR.xcodeproj/project.pbxproj
@@ -711,7 +711,7 @@
CLANG_WARN_CONSTANT_CONVERSION = YES;
CLANG_WARN_DEPRECATED_OBJC_IMPLEMENTATIONS = YES;
CLANG_WARN_DIRECT_OBJC_ISA_USAGE = YES_ERROR;
- CLANG_WARN_DOCUMENTATION_COMMENTS = YES;
+ CLANG_WARN_DOCUMENTATION_COMMENTS = NO;
CLANG_WARN_EMPTY_BODY = YES;
CLANG_WARN_ENUM_CONVERSION = YES;
CLANG_WARN_IMPLICIT_SIGN_CONVERSION = YES;
@@ -776,7 +776,7 @@
CLANG_WARN_CONSTANT_CONVERSION = YES;
CLANG_WARN_DEPRECATED_OBJC_IMPLEMENTATIONS = YES;
CLANG_WARN_DIRECT_OBJC_ISA_USAGE = YES_ERROR;
- CLANG_WARN_DOCUMENTATION_COMMENTS = YES;
+ CLANG_WARN_DOCUMENTATION_COMMENTS = NO;
CLANG_WARN_EMPTY_BODY = YES;
CLANG_WARN_ENUM_CONVERSION = YES;
CLANG_WARN_IMPLICIT_SIGN_CONVERSION = YES;
diff --git a/inc/qcbor/qcbor_encode.h b/inc/qcbor/qcbor_encode.h
index e37b654..ce087ef 100644
--- a/inc/qcbor/qcbor_encode.h
+++ b/inc/qcbor/qcbor_encode.h
@@ -3156,54 +3156,54 @@
* BEGINNING OF PRIVATE INLINE IMPLEMENTATION *
* ========================================================================= */
-/* Semi-private funcion used by public inline functions. See qcbor_encode.c */
+/** @private Semi-private function. See qcbor_encode.c */
void QCBOREncode_Private_AppendCBORHead(QCBOREncodeContext *pMe,
const uint8_t uMajorType,
const uint64_t uArgument,
const uint8_t uMinLen);
-/* Semi-private funcion used by public inline functions. See qcbor_encode.c */
+/** @private Semi-private function. See qcbor_encode.c */
void
QCBOREncode_Private_AddBuffer(QCBOREncodeContext *pCtx,
uint8_t uMajorType,
UsefulBufC Bytes);
-/* Semi-private function for adding a double with preferred encoding. See qcbor_encode.c */
+/** @private Semi-private function. See qcbor_encode.c */
void
QCBOREncode_Private_AddPreferredDouble(QCBOREncodeContext *pMe, const double dNum);
-/* Semi-private function for adding a float with preferred encoding. See qcbor_encode.c */
+/** @private Semi-private function. See qcbor_encode.c */
void
QCBOREncode_Private_AddPreferredFloat(QCBOREncodeContext *pMe, const float fNum);
-/* Semi-private funcion used by public inline functions. See qcbor_encode.c */
+/** @private Semi-private function. See qcbor_encode.c */
void
QCBOREncode_Private_OpenMapOrArray(QCBOREncodeContext *pCtx,
uint8_t uMajorType);
-/* Semi-private funcion used by public inline functions. See qcbor_encode.c */
+/** @private Semi-private function. See qcbor_encode.c */
void
QCBOREncode_Private_OpenMapOrArrayIndefiniteLength(QCBOREncodeContext *pCtx,
uint8_t uMajorType);
-/* Semi-private funcion used by public inline functions. See qcbor_encode.c */
+/** @private Semi-private function. See qcbor_encode.c */
void
QCBOREncode_Private_CloseMapOrArray(QCBOREncodeContext *pCtx,
uint8_t uMajorType);
-/* Semi-private funcion used by public inline functions. See qcbor_encode.c */
+/** @private Semi-private function. See qcbor_encode.c */
void
QCBOREncode_Private_CloseMapOrArrayIndefiniteLength(QCBOREncodeContext *pCtx,
uint8_t uMajorType);
-/* Semi-private funcion used by public inline functions. See qcbor_encode.c */
+/** @private Semi-private function. See qcbor_encode.c */
void
QCBOREncode_Private_AddTBigNumberMain(QCBOREncodeContext *pMe,
const uint8_t uTagRequirement,
@@ -3211,7 +3211,7 @@
const bool bNegative,
const UsefulBufC BigNumber);
-/* Semi-private funcion used by public inline functions. See qcbor_encode.c */
+/** @private Semi-private function. See qcbor_encode.c */
void
QCBOREncode_Private_AddTExpIntMantissa(QCBOREncodeContext *pMe,
const int uTagRequirement,
@@ -3220,7 +3220,7 @@
const int64_t nMantissa);
-/* Semi-private funcion used by public inline functions. See qcbor_encode.c */
+/** @private Semi-private function. See qcbor_encode.c */
void
QCBOREncode_Private_AddTExpBigMantissa(QCBOREncodeContext *pMe,
const int uTagRequirement,
@@ -3230,7 +3230,7 @@
const bool bBigNumIsNegative);
-/* Semi-private funcion used by public inline functions. See qcbor_encode.c */
+/** @private Semi-private function. See qcbor_encode.c */
void
QCBOREncode_Private_AddTExpBigMantissaRaw(QCBOREncodeContext *pMe,
const int uTagRequirement,
@@ -3240,6 +3240,8 @@
const bool bBigNumIsNegative);
/**
+ * @private
+ *
* @brief Semi-private method to add simple items and floating-point.
*
* @param[in] pMe The encoding context.
@@ -3263,15 +3265,11 @@
}
-/* Forward declaration */
-static void
-QCBOREncode_AddSZString(QCBOREncodeContext *pMe, const char *szString);
-
-
-
+/** @private Semi-private function. See qcbor_encode.c */
void
QCBOREncode_Private_CloseMapUnsorted(QCBOREncodeContext *pMe);
+
static inline void
QCBOREncode_Config(QCBOREncodeContext *pMe, enum QCBOREncodeConfig uConfig)
{
@@ -3297,9 +3295,6 @@
-
-
-
static inline void
QCBOREncode_AddInt64ToMapSZ(QCBOREncodeContext *pMe,
const char *szLabel,
@@ -3458,6 +3453,7 @@
#ifndef USEFULBUF_DISABLE_ALL_FLOAT
+/** @private */
static inline void
QCBOREncode_Private_AddDoubleRaw(QCBOREncodeContext *pMe, const double dNum)
{
@@ -3514,6 +3510,7 @@
}
+/** @private */
static inline void
QCBOREncode_Private_AddFloatRaw(QCBOREncodeContext *pMe, const float fNum)
{
@@ -3884,11 +3881,12 @@
QCBOREncode_AddTBigNumberNoPreferred(pMe, uTagRequirement, bNegative, BigNumber);
}
-/*
+/**
+ * @private
* @brief Add the tag number for a big number (private).
*
* @param[in] pMe The decode context.
- * @param[in] uTagRequirement
+ * @param[in] uTagRequirement TODO: fill in
* @param[in] bNegative If true, big number is negative.
*/
static inline void
diff --git a/inc/qcbor/qcbor_main_decode.h b/inc/qcbor/qcbor_main_decode.h
index fc552a9..9a84882 100644
--- a/inc/qcbor/qcbor_main_decode.h
+++ b/inc/qcbor/qcbor_main_decode.h
@@ -1414,7 +1414,8 @@
* ========================================================================= */
/**
- * @brief Configure CBOR decoder context for QCBOR v1 compatibility (deprecated).
+ * @deprecated The v2 tag number behavior is more correct.
+ * @brief [Deprecated] Configure CBOR decoder context for QCBOR v1 compatibility.
*
* @param[in] pCtx The context to configure.
*
@@ -1432,7 +1433,7 @@
* number processing is too loose. See @ref v2-Tag-Decoding.
*
* This links in a fair bit of object code for all the tag content
- * handlers that were always present in v1. To get the v1 behavior
+ * handlers that were always present in v1. To get the v1 tag number behavior
* without the object code for the tag content handlers, pass
* @ref QCBOR_DECODE_ALLOW_UNPROCESSED_TAG_NUMBERS to
* QCBORDecode_Init().
diff --git a/inc/qcbor/qcbor_number_decode.h b/inc/qcbor/qcbor_number_decode.h
index 7076444..7031bfd 100644
--- a/inc/qcbor/qcbor_number_decode.h
+++ b/inc/qcbor/qcbor_number_decode.h
@@ -141,12 +141,14 @@
enum QCBORDecodeNumberConvert uConvertTypes,
int64_t *pnValue);
+/** See QCBORDecode_GetInt64Convert(). */
static void
QCBORDecode_GetInt64ConvertInMapN(QCBORDecodeContext *pCtx,
int64_t nLabel,
enum QCBORDecodeNumberConvert uConvertTypes,
int64_t *pnValue);
+/** See QCBORDecode_GetInt64Convert(). */
static void
QCBORDecode_GetInt64ConvertInMapSZ(QCBORDecodeContext *pCtx,
const char *szLabel,
@@ -198,12 +200,14 @@
enum QCBORDecodeNumberConvert uConvertTypes,
int64_t *pnValue);
+/** See QCBORDecode_GetInt64ConvertAll(). */
void
QCBORDecode_GetInt64ConvertAllInMapN(QCBORDecodeContext *pCtx,
int64_t nLabel,
enum QCBORDecodeNumberConvert uConvertTypes,
int64_t *pnValue);
+/** See QCBORDecode_GetInt64ConvertAll(). */
void
QCBORDecode_GetInt64ConvertAllInMapSZ(QCBORDecodeContext *pCtx,
const char *szLabel,
@@ -231,11 +235,13 @@
QCBORDecode_GetUInt64(QCBORDecodeContext *pCtx,
uint64_t *puValue);
+/** See QCBORDecode_GetUInt64(). */
static void
QCBORDecode_GetUInt64InMapN(QCBORDecodeContext *pCtx,
int64_t nLabel,
uint64_t *puValue);
+/** See QCBORDecode_GetUInt64(). */
static void
QCBORDecode_GetUInt64InMapSZ(QCBORDecodeContext *pCtx,
const char *szLabel,
@@ -272,12 +278,14 @@
enum QCBORDecodeNumberConvert uConvertTypes,
uint64_t *puValue);
+/** See QCBORDecode_GetUInt64Convert(). */
static void
QCBORDecode_GetUInt64ConvertInMapN(QCBORDecodeContext *pCtx,
int64_t nLabel,
enum QCBORDecodeNumberConvert uConvertTypes,
uint64_t *puValue);
+/** See QCBORDecode_GetUInt64Convert(). */
static void
QCBORDecode_GetUInt64ConvertInMapSZ(QCBORDecodeContext *pCtx,
const char *szLabel,
@@ -303,12 +311,14 @@
enum QCBORDecodeNumberConvert uConvertTypes,
uint64_t *puValue);
+/** See QCBORDecode_GetUInt64ConvertAll(). */
void
QCBORDecode_GetUInt64ConvertAllInMapN(QCBORDecodeContext *pCtx,
int64_t nLabel,
enum QCBORDecodeNumberConvert uConvertTypes,
uint64_t *puValue);
+/** See QCBORDecode_GetUInt64ConvertAll(). */
void
QCBORDecode_GetUInt64ConvertAllInMapSZ(QCBORDecodeContext *pCtx,
const char *szLabel,
@@ -344,11 +354,13 @@
QCBORDecode_GetDouble(QCBORDecodeContext *pCtx,
double *pValue);
+/** See QCBORDecode_GetDouble(). */
static void
QCBORDecode_GetDoubleInMapN(QCBORDecodeContext *pCtx,
int64_t nLabel,
double *pdValue);
+/** See QCBORDecode_GetDouble(). */
static void
QCBORDecode_GetDoubleInMapSZ(QCBORDecodeContext *pCtx,
const char *szLabel,
@@ -392,12 +404,14 @@
enum QCBORDecodeNumberConvert uConvertTypes,
double *pdValue);
+/** See QCBORDecode_GetDoubleConvert(). */
static void
QCBORDecode_GetDoubleConvertInMapN(QCBORDecodeContext *pCtx,
int64_t nLabel,
enum QCBORDecodeNumberConvert uConvertTypes,
double *pdValue);
+/** See QCBORDecode_GetDoubleConvert(). */
static void
QCBORDecode_GetDoubleConvertInMapSZ(QCBORDecodeContext *pCtx,
const char *szLabel,
@@ -433,12 +447,14 @@
const enum QCBORDecodeNumberConvert uConvertTypes,
double *pdValue);
+/** See QCBORDecode_GetDoubleConvertAll(). */
void
QCBORDecode_GetDoubleConvertAllInMapN(QCBORDecodeContext *pCtx,
int64_t nLabel,
const enum QCBORDecodeNumberConvert uConvertTypes,
double *pdValue);
+/** See QCBORDecode_GetDoubleConvertAll(). */
void
QCBORDecode_GetDoubleConvertAllInMapSZ(QCBORDecodeContext *pCtx,
const char *szLabel,
@@ -532,7 +548,7 @@
* | @ref QCBOR_TYPE_BYTE_STRING |
* | ---- |
*
- * For the type @ref QCBOR_TYPE_BYTES, @c pIsNegative becomes an in
+ * For the type @ref QCBOR_TYPE_BYTE_STRING, @c pIsNegative becomes an in
* parameter indicating the sign.
*
* If @c BigNumberBuf is too small, @c pBigNum.ptr will be @c NULL and
@@ -542,7 +558,7 @@
* QCBOR_TYPE_NEGBIGNUM because the application of the offset of one
* for negative numbers may have an arithmetic carry. A way to size
* the output buffer is MIN(9, Item.val.bignum.len + 1). 9 comes from
- * the length of they type @ref QCBOR_TYPE_65BIT_NEG plus the
+ * the length of they type @ref QCBOR_TYPE_65BIT_NEG_INT plus the
* possibility of an arithmetic carry.
*
* The object code for this is surprisingly large at about 1KB. This
@@ -583,7 +599,6 @@
-
/**
* @brief Decode next item as a big number encoded using preferred
* serialization.
@@ -645,6 +660,7 @@
UsefulBufC *pBigNumber,
bool *pbIsNegative);
+/** See QCBORDecode_GetTBigNumber(). */
void
QCBORDecode_GetTBigNumberInMapN(QCBORDecodeContext *pCtx,
int64_t nLabel,
@@ -653,6 +669,7 @@
UsefulBufC *pBigNumber,
bool *pbIsNegative);
+/** See QCBORDecode_GetTBigNumber(). */
void
QCBORDecode_GetTBigNumberInMapSZ(QCBORDecodeContext *pCtx,
const char *szLabel,
@@ -689,6 +706,7 @@
UsefulBufC *pBigNumber,
bool *pbIsNegative);
+/** See QCBORDecode_GetTBigNumberNoPreferred(). */
void
QCBORDecode_GetTBigNumberNoPreferredInMapN(QCBORDecodeContext *pCtx,
int64_t nLabel,
@@ -697,6 +715,7 @@
UsefulBufC *pBigNumber,
bool *pbIsNegative);
+/** See QCBORDecode_GetTBigNumberNoPreferred(). */
void
QCBORDecode_GetTBigNumberNoPreferredInMapSZ(QCBORDecodeContext *pCtx,
const char *szLabel,
@@ -707,12 +726,12 @@
/**
- * @brief Decode the next item as a big number with no processing
+ * @brief Decode the next item as a big number with no processing.
*
* @param[in] pCtx The decode context.
* @param[in] uTagRequirement See @ref QCBORDecodeTagReq.
- * @param[out] pBigNumber The decoded big number, most significant
- * byte first (network byte order).
+ * @param[out] pBigNumber The decoded big number, most significant
+ * byte first (network byte order).
* @param[out] pbIsNegative Is @c true if the big number is negative. This
* is only valid when @c uTagRequirement is
* @ref QCBOR_TAG_REQUIREMENT_TAG.
@@ -755,6 +774,7 @@
UsefulBufC *pBigNumber,
bool *pbIsNegative);
+/** See QCBORDecode_GetTBigNumberRaw(). */
void
QCBORDecode_GetTBigNumberRawInMapN(QCBORDecodeContext *pMe,
const int64_t nLabel,
@@ -762,6 +782,7 @@
UsefulBufC *pBigNumber,
bool *pbIsNegative);
+/** See QCBORDecode_GetTBigNumberRaw(). */
void
QCBORDecode_GetTBigNumberRawInMapSZ(QCBORDecodeContext *pMe,
const char *szLabel,
@@ -830,6 +851,7 @@
int64_t *pnMantissa,
int64_t *pnExponent);
+/** See QCBORDecode_GetTDecimalFraction(). */
void
QCBORDecode_GetTDecimalFractionInMapN(QCBORDecodeContext *pCtx,
int64_t nLabel,
@@ -837,6 +859,7 @@
int64_t *pnMantissa,
int64_t *pnExponent);
+/** See QCBORDecode_GetTDecimalFraction(). */
void
QCBORDecode_GetTDecimalFractionInMapSZ(QCBORDecodeContext *pMe,
const char *szLabel,
@@ -880,6 +903,7 @@
bool *pbMantissaIsNegative,
int64_t *pnExponent);
+/** See QCBORDecode_GetTDecimalFractionBigMantissa(). */
void
QCBORDecode_GetTDecimalFractionBigMantissaInMapN(QCBORDecodeContext *pCtx,
int64_t nLabel,
@@ -889,6 +913,7 @@
bool *pbIsNegative,
int64_t *pnExponent);
+/** See QCBORDecode_GetTDecimalFractionBigMantissa(). */
void
QCBORDecode_GetTDecimalFractionBigMantissaInMapSZ(QCBORDecodeContext *pCtx,
const char *szLabel,
@@ -937,6 +962,7 @@
bool *pbMantissaIsNegative,
int64_t *pnExponent);
+/** See QCBORDecode_GetTDecimalFractionBigMantissaRaw(). */
void
QCBORDecode_GetTDecimalFractionBigMantissaRawInMapN(QCBORDecodeContext *pCtx,
int64_t nLabel,
@@ -946,6 +972,7 @@
bool *pbIsNegative,
int64_t *pnExponent);
+/** See QCBORDecode_GetTDecimalFractionBigMantissaRaw(). */
void
QCBORDecode_GetTDecimalFractionBigMantissaRawInMapSZ(QCBORDecodeContext *pCtx,
const char *szLabel,
@@ -970,7 +997,7 @@
* the second is the mantissa.
*
* Depending on @c uTagRequirement, the tag number
- * @ref CBOR_TAG_BIG_FLOAT (5) may or may not need to be present
+ * @ref CBOR_TAG_BIGFLOAT (5) may or may not need to be present
* before the array. See @ref Tag-Usage.
*
* The exponent must always be an integer (CBOR type 0 or 1). The
@@ -1008,6 +1035,7 @@
int64_t *pnMantissa,
int64_t *pnExponent);
+/** See QCBORDecode_GetTBigFloat(). */
void
QCBORDecode_GetTBigFloatInMapN(QCBORDecodeContext *pCtx,
int64_t nLabel,
@@ -1015,6 +1043,7 @@
int64_t *pnMantissa,
int64_t *pnExponent);
+/** See QCBORDecode_GetTBigFloat(). */
void
QCBORDecode_GetTBigFloatInMapSZ(QCBORDecodeContext *pCtx,
const char *szLabel,
@@ -1053,6 +1082,7 @@
bool *pbMantissaIsNegative,
int64_t *pnExponent);
+/** See QCBORDecode_GetTBigFloatBigMantissa(). */
void
QCBORDecode_GetTBigFloatBigMantissaInMapN(QCBORDecodeContext *pCtx,
int64_t nLabel,
@@ -1062,6 +1092,7 @@
bool *pbMantissaIsNegative,
int64_t *pnExponent);
+/** See QCBORDecode_GetTBigFloatBigMantissa(). */
void
QCBORDecode_GetTBigFloatBigMantissaInMapSZ(QCBORDecodeContext *pCtx,
const char *szLabel,
@@ -1108,6 +1139,7 @@
bool *pbMantissaIsNegative,
int64_t *pnExponent);
+/** See QCBORDecode_GetTBigFloatBigMantissaRaw(). */
void
QCBORDecode_GetTBigFloatBigMantissaRawInMapN(QCBORDecodeContext *pCtx,
int64_t nLabel,
@@ -1117,6 +1149,7 @@
bool *pbMantissaIsNegative,
int64_t *pnExponent);
+/** See QCBORDecode_GetTBigFloatBigMantissaRaw(). */
void
QCBORDecode_GetTBigFloatBigMantissaRawInMapSZ(QCBORDecodeContext *pCtx,
const char *szLabel,
@@ -1216,10 +1249,7 @@
return 0;
}
-/**
- * https://github.com/laurencelundblade/QCBOR/pull/243
- * For backwards compatibility
- */
+/** @private Fix misnaming in previous versions. */
#define QCBOR_Int64UToInt16 QCBOR_Int64ToUInt16
static inline int
@@ -1268,14 +1298,16 @@
* ========================================================================= */
-/* Deprecated. Use QCBORDecode_GetTBigNumberRaw() instead. */
+/**
+ * @brief [Deprecated] Decode big number with no processing.
+ * @deprecated Use QCBORDecode_GetTBigNumberRaw() instead. */
static void
QCBORDecode_GetBignum(QCBORDecodeContext *pCtx,
enum QCBORDecodeTagReq uTagRequirement,
UsefulBufC *pValue,
bool *pbIsNegative);
-/* Deprecated. Use QCBORDecode_GetTBigNumberRawInMapN() instead. */
+/** @deprecated. Use QCBORDecode_GetTBigNumberRawInMapN() instead. */
static void
QCBORDecode_GetBignumInMapN(QCBORDecodeContext *pCtx,
int64_t nLabel,
@@ -1283,7 +1315,7 @@
UsefulBufC *pValue,
bool *pbIsNegative);
-/* Deprecated. Use QCBORDecode_GetTBigNumberRawInMapSZ() instead. */
+/** @deprecated. Use QCBORDecode_GetTBigNumberRawInMapSZ() instead. */
static void
QCBORDecode_GetBignumInMapSZ(QCBORDecodeContext *pCtx,
const char *szLabel,
@@ -1292,14 +1324,16 @@
bool *pbIsNegative);
#ifndef QCBOR_CONFIG_DISABLE_EXP_AND_MANTISSA
-/* Deprecated. Use QCBORDecode_GetTDecimalFraction() instead. */
+/**
+ * @brief [Deprecated] Decode a decimal fraction.
+ * @deprecated. Use QCBORDecode_GetTDecimalFraction() instead. */
static void
QCBORDecode_GetDecimalFraction(QCBORDecodeContext *pCtx,
enum QCBORDecodeTagReq uTagRequirement,
int64_t *pnMantissa,
int64_t *pnExponent);
-/* Deprecated. Use QCBORDecode_GetTDecimalFractionInMapN() instead. */
+/** @deprecated. Use QCBORDecode_GetTDecimalFractionInMapN() instead. */
static void
QCBORDecode_GetDecimalFractionInMapN(QCBORDecodeContext *pCtx,
int64_t nLabel,
@@ -1307,7 +1341,7 @@
int64_t *pnMantissa,
int64_t *pnExponent);
-/* Deprecated. Use QCBORDecode_GetTDecimalFractionInMapSZ() instead. */
+/** @deprecated. Use QCBORDecode_GetTDecimalFractionInMapSZ() instead. */
static void
QCBORDecode_GetDecimalFractionInMapSZ(QCBORDecodeContext *pMe,
const char *szLabel,
@@ -1315,18 +1349,20 @@
int64_t *pnMantissa,
int64_t *pnExponent);
-/* Deprecated. Use QCBORDecode_GetTDecimalFractionBigMantissaRaw() instead. */
-/*
- TODO: integrate this comment better
-* For QCBOR before v1.5, this function had a bug where
-* by the negative mantissa sometimes had the offset of
-* one applied, making this function somewhat usless for
-* negative mantissas. Specifically if the to-be-decode CBOR
-* was a type 1 integer the offset was applied and when it
-* was a tag 3, the offset was not applied. It is possible
-* that a tag 3 could contain a value in the range of a type 1
-* integer. @ref QCBORExpAndMantissa is
-* correct and can be used instead of this. */
+/**
+ * @brief [Deprecated] Decode a decimal fraction with big number mantissa.
+ * @deprecated. Use QCBORDecode_GetTDecimalFractionBigMantissaRaw() instead.
+ *
+ * For QCBOR before v1.5, this function had a bug where
+ * by the negative mantissa sometimes had the offset of
+ * one applied, making this function somewhat usless for
+ * negative mantissas. Specifically if the to-be-decode CBOR
+ * was a type 1 integer the offset was applied and when it
+ * was a tag 3, the offset was not applied. It is possible
+ * that a tag 3 could contain a value in the range of a type 1
+ * integer. @ref QCBORExpAndMantissa is
+ * correct and can be used instead of this.
+ **/
static void
QCBORDecode_GetDecimalFractionBig(QCBORDecodeContext *pCtx,
const enum QCBORDecodeTagReq uTagRequirement,
@@ -1335,7 +1371,7 @@
bool *pbMantissaIsNegative,
int64_t *pnExponent);
-/* Deprecated. Use QCBORDecode_GetTDecimalFractionBigMantissaRawInMapN() */
+/** @deprecated. Use QCBORDecode_GetTDecimalFractionBigMantissaRawInMapN() */
static void
QCBORDecode_GetDecimalFractionBigInMapN(QCBORDecodeContext *pCtx,
int64_t nLabel,
@@ -1345,7 +1381,7 @@
bool *pbIsNegative,
int64_t *pnExponent);
-/* Deprecated. Use QCBORDecode_GetTDecimalFractionBigMantissaRawInMapSZ() */
+/** @deprecated. Use QCBORDecode_GetTDecimalFractionBigMantissaRawInMapSZ() */
static void
QCBORDecode_GetDecimalFractionBigInMapSZ(QCBORDecodeContext *pCtx,
const char *szLabel,
@@ -1355,14 +1391,16 @@
bool *pbMantissaIsNegative,
int64_t *pnExponent);
-/* Deprecated. Use QCBORDecode_GetTBigFloat() instead. */
+/**
+ * @brief [Deprecated] Decode a big float.
+ * @deprecated. Use QCBORDecode_GetTBigFloat() instead. */
static void
QCBORDecode_GetBigFloat(QCBORDecodeContext *pCtx,
const enum QCBORDecodeTagReq uTagRequirement,
int64_t *pnMantissa,
int64_t *pnExponent);
-/* Deprecated. Use QCBORDecode_GetTBigFloatInMapN() instead. */
+/** @deprecated. Use QCBORDecode_GetTBigFloatInMapN() instead. */
static void
QCBORDecode_GetBigFloatInMapN(QCBORDecodeContext *pCtx,
int64_t nLabel,
@@ -1370,7 +1408,7 @@
int64_t *pnMantissa,
int64_t *pnExponent);
-/* Deprecated. Use QCBORDecode_GetTBigFloatInMapSZ() instead. */
+/** @deprecated. Use QCBORDecode_GetTBigFloatInMapSZ() instead. */
static void
QCBORDecode_GetBigFloatInMapSZ(QCBORDecodeContext *pCtx,
const char *szLabel,
@@ -1378,7 +1416,10 @@
int64_t *pnMantissa,
int64_t *pnExponent);
-/* Deprecated. Use QCBORDecode_GetTBigFloatBigMantissaRaw() instead. */
+/**
+ * @brief [Depreacted] Decode big float with a big number mantissa.
+ * @deprecated. Use QCBORDecode_GetTBigFloatBigMantissaRaw() instead. */
+// TODO: same bug as GetDecimalFraction?
static void
QCBORDecode_GetBigFloatBig(QCBORDecodeContext *pCtx,
const enum QCBORDecodeTagReq uTagRequirement,
@@ -1387,7 +1428,7 @@
bool *pbMantissaIsNegative,
int64_t *pnExponent);
-/* Deprecated. Use QCBORDecode_GetTBigFloatBigMantissaRawInMapN() instead. */
+/** @deprecated. Use QCBORDecode_GetTBigFloatBigMantissaRawInMapN() instead. */
static void
QCBORDecode_GetBigFloatBigInMapN(QCBORDecodeContext *pCtx,
int64_t nLabel,
@@ -1397,7 +1438,7 @@
bool *pbMantissaIsNegative,
int64_t *pnExponent);
-/* Deprecated. Use QCBORDecode_GetTBigFloatBigMantissaRawInMapSZ() instead. */
+/** @deprecated. Use QCBORDecode_GetTBigFloatBigMantissaRawInMapSZ() instead. */
static void
QCBORDecode_GetBigFloatBigInMapSZ(QCBORDecodeContext *pCtx,
const char *szLabel,
diff --git a/inc/qcbor/qcbor_tag_decode.h b/inc/qcbor/qcbor_tag_decode.h
index f828687..32dd1f5 100644
--- a/inc/qcbor/qcbor_tag_decode.h
+++ b/inc/qcbor/qcbor_tag_decode.h
@@ -237,7 +237,7 @@
*
* @returns The nth tag number or @ref CBOR_TAG_INVALID64.
*
- * Typically, this is only used with @ref QCBOR_DECODE_CONFIG_UNPROCESSED_TAG_NUMBERS.
+ * Typically, this is only used with @ref QCBOR_DECODE_ALLOW_UNPROCESSED_TAG_NUMBERS.
* Normally, tag numbers are processed QCBORDecode_VGetNextTagNumber() or
* QCBORTagContentCallBack.
*
@@ -876,7 +876,9 @@
* @c uTagNumber. Then @c pfContentDecoder is called.
*/
struct QCBORTagDecoderEntry {
+ /** Tag number to match. */
uint64_t uTagNumber;
+ /** Callback function to fire when the tag number is matched. */
QCBORTagContentCallBack *pfContentDecoder;
};
@@ -1086,7 +1088,8 @@
#ifndef QCBOR_DISABLE_TAGS
/**
- * @brief Returns the tag numbers for an item. (deprecated).
+ * @brief [Deprecated] Returns the tag numbers for an item..
+ * @deprecated Use QCBORDecode_GetNthTagNumber() instead.
*
* @param[in] pCtx The decoder context.
* @param[in] uIndex The index of the tag to get.
@@ -1102,7 +1105,8 @@
/**
- * @brief Returns the tag numbers for last-decoded item (deprecated).
+ * @brief [Deprecated] Returns the tag numbers for last-decoded item.
+ * @deprecated Use QCBORDecode_GetNthTagNumber() instead.
*
* @param[in] pCtx The decoder context.
* @param[in] uIndex The index of the tag to get.