add docs about returning of RMW_RET_BAD_ALLOC

ros2 · Jun 12, 2018 · 0a53658 · 0a53658
1 parent afb72ef
commit 0a53658
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/rmw/include/rmw/raw_message.h b/rmw/include/rmw/raw_message.h
@@ -61,6 +61,7 @@ rmw_raw_message_init(
  *
  * \param msg pointer to the raw message to be cleaned up
  * \return `RMW_RET_OK` if successful, or
+ * \return `RMW_RET_BAD_ALLOC` if memory allocation failed, or
  * \return `RMW_RET_ERROR` if an unexpected error occurs
  */
 RMW_PUBLIC
@@ -80,6 +81,7 @@ rmw_raw_message_fini(rmw_message_raw_t * msg);
  * \param msg pointer to the instance of rmw_message_raw_t which is being resized
  * \param new_size the new size of the internal buffer
  * \return `RMW_RET_OK` if successful, or
+ * \return `RMW_RET_BAD_ALLOC` if memory allocation failed, or
  * \return `RMW_RET_ERROR` if an unexpected error occurs
  */
 RMW_PUBLIC