Changeset 31950 in vbox for trunk

Timestamp:

Aug 25, 2010 10:06:10 AM (14 years ago)

Author:

vboxsync

Message:

iprt: explicitly document that all RTStr* functions return the number of characters excluding the terminator

File:

• trunk/include/iprt/string.h (modified) (8 diffs)

trunk/include/iprt/string.h

@@ -1630 +1630 @@
  * String printf.
  *
- * @returns The length of the returned string (in pszBuffer).
+ * @returns The length of the returned string (in pszBuffer) excluding the
+ *          terminator.
  * @param   pszBuffer   Output buffer.
  * @param   cchBuffer   Size of the output buffer.
@@ -1641 +1642 @@
  * String printf.
  *
- * @returns The length of the returned string (in pszBuffer).
+ * @returns The length of the returned string (in pszBuffer) excluding the
+ *          terminator.
  * @param   pszBuffer   Output buffer.
  * @param   cchBuffer   Size of the output buffer.
@@ -1653 +1655 @@
  * String printf with custom formatting.
  *
- * @returns The length of the returned string (in pszBuffer).
+ * @returns The length of the returned string (in pszBuffer) excluding the
+ *          terminator.
  * @param   pfnFormat   Pointer to handler function for the custom formats.
  * @param   pvArg       Argument to the pfnFormat function.
@@ -1666 +1669 @@
  * String printf with custom formatting.
  *
- * @returns The length of the returned string (in pszBuffer).
+ * @returns The length of the returned string (in pszBuffer) excluding the
+ *          terminator.
  * @param   pfnFormat   Pointer to handler function for the custom formats.
  * @param   pvArg       Argument to the pfnFormat function.
@@ -1680 +1684 @@
  * Allocating string printf (default tag).
  *
- * @returns The length of the string in the returned *ppszBuffer.
+ * @returns The length of the string in the returned *ppszBuffer excluding the
+ *          terminator.
  * @returns -1 on failure.
  * @param   ppszBuffer  Where to store the pointer to the allocated output buffer.
@@ -1693 +1698 @@
  * Allocating string printf (custom tag).
  *
- * @returns The length of the string in the returned *ppszBuffer.
+ * @returns The length of the string in the returned *ppszBuffer excluding the
+ *          terminator.
  * @returns -1 on failure.
  * @param   ppszBuffer  Where to store the pointer to the allocated output buffer.
@@ -1707 +1713 @@
  * Allocating string printf.
  *
- * @returns The length of the string in the returned *ppszBuffer.
+ * @returns The length of the string in the returned *ppszBuffer excluding the
+ *          terminator.
  * @returns -1 on failure.
  * @param   ppszBuffer  Where to store the pointer to the allocated output buffer.
@@ -1728 +1735 @@
  * Allocating string printf (custom tag).
  *
- * @returns The length of the string in the returned *ppszBuffer.
+ * @returns The length of the string in the returned *ppszBuffer excluding the
+ *          terminator.
  * @returns -1 on failure.
  * @param   ppszBuffer  Where to store the pointer to the allocated output buffer.