[rtems commit] Fix documentation comment
Sebastian Huber
sebh at rtems.org
Thu Jan 12 13:29:08 UTC 2017
Module: rtems
Branch: master
Commit: 3b784ba0284796cb1f36f4aed5c3142351ca40d8
Changeset: http://git.rtems.org/rtems/commit/?id=3b784ba0284796cb1f36f4aed5c3142351ca40d8
Author: Sebastian Huber <sebastian.huber at embedded-brains.de>
Date: Thu Jan 12 08:56:48 2017 +0100
Fix documentation comment
---
cpukit/libcsupport/include/rtems/assoc.h | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/cpukit/libcsupport/include/rtems/assoc.h b/cpukit/libcsupport/include/rtems/assoc.h
index 238a02f..3457617 100644
--- a/cpukit/libcsupport/include/rtems/assoc.h
+++ b/cpukit/libcsupport/include/rtems/assoc.h
@@ -168,8 +168,8 @@ typedef struct {
* @param[in] fallback Fallback value in case no bits contained in the pairs
* are set in the value.
*
- * @retval The length of the text representation. May be greater than the
- * buffer size if truncation occurred.
+ * @retval The length of the text representation. May be greater than or equal
+ * to the buffer size if truncation occurred.
*/
size_t rtems_assoc_32_to_string(
uint32_t value,
@@ -188,8 +188,8 @@ size_t rtems_assoc_32_to_string(
* @param[in] buffer The buffer for the text representation.
* @param[in] buffer_size The buffer size in characters.
*
- * @retval The length of the text representation. May be greater than the
- * buffer size if truncation occurred.
+ * @retval The length of the text representation. May be greater than or equal
+ * to the buffer size if truncation occurred.
*/
size_t rtems_assoc_thread_states_to_string(
uint32_t states,
More information about the vc
mailing list