also doc that take* can return RMW_RET_BAD_ALLOC

ros2 · Jun 12, 2018 · 35ee9e3 · 35ee9e3
1 parent 8d0acff
commit 35ee9e3
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/rmw/include/rmw/rmw.h b/rmw/include/rmw/rmw.h
@@ -276,6 +276,7 @@ rmw_take_with_info(
  * \param raw_message the destination in which to store the serialized message
  * \param taken boolean flag indicating if a message was taken or not
  * \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
@@ -294,6 +295,7 @@ rmw_take_raw(
  * \param raw_message the destination in which to store the serialized message
  * \param taken boolean flag indicating if a message was taken or not
  * \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