Changeset 96170 in vbox

Timestamp:

Aug 12, 2022 12:23:56 PM (2 years ago)

Author:

vboxsync

Message:

IPRT: Doxygen fixes in strtonum.cpp and strtofloat.cpp. bugref:20261

Location:

trunk/src/VBox/Runtime/common/string

Files:

• strtofloat.cpp (modified) (4 diffs)
• strtonum.cpp (modified) (1 diff)

trunk/src/VBox/Runtime/common/string/strtofloat.cpp

@@ -516 +516 @@
  *                      Optional.
  * @param   cchMax      Number of bytes left in the string starting at @a psz.
+ * @param   fPositive   Whether the infinity should be positive or negative.
  * @param   rc          The status code to return.
+ * @param   iRetType    The target type.
+ * @param   pRet        Where to store the result.
  */
 static int rtStrToLongDoubleReturnInf(const char *psz, char **ppszNext, size_t cchMax, bool fPositive,
@@ -656 +659 @@
  *                      Optional.
  * @param   cchMax      Number of bytes left in the string starting at @a psz.
- * @param   rc          The status code to return.
+ * @param   fPositive   Whether the NaN should be positive or negative.
+ * @param   iRetType    The target type.
+ * @param   pRet        Where to store the result.
  */
 static int rtStrToLongDoubleReturnNan(const char *psz, char **ppszNext, size_t cchMax, bool fPositive,
@@ -749 +754 @@
  * @param   cchMax      Number of bytes left in the string starting at @a psz.
  * @param   rc          The status code to return.
+ * @param   iRetType    The target type.
+ * @param   pRet        Where to store the result.
  */
 static int rtStrToLongDoubleReturnZero(const char *psz, char **ppszNext, size_t cchMax, bool fPositive,
@@ -786 +793 @@
  *                      Optional.
  * @param   cchMax      Number of bytes left in the string starting at @a psz.
- * @param   rc          The status code to return.
+ * @param   fPositive   Whether the value should be positive or negative.
+ * @param   iExponent   Overflow/underflow indicator.
+ * @param   iRetType    The target type.
+ * @param   pRet        Where to store the result.
  */
 static int rtStrToLongDoubleReturnOverflow(const char *psz, char **ppszNext, size_t cchMax, bool fPositive,

trunk/src/VBox/Runtime/common/string/strtonum.cpp

@@ -944 +944 @@
  *                          defaulting to 10.  A max length of zero means no length
  *                          restriction.
- * @param   pu8             Where to store the converted number. (optional)
  * @param   pi16            Where to store the converted number. (optional)
  */