add docs about returning of RMW_RET_BAD_ALLOC

ros2 · Jun 12, 2018 · 8d0acff · 8d0acff
1 parent 0a53658
commit 8d0acff
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/rmw/include/rmw/rmw.h b/rmw/include/rmw/rmw.h
@@ -199,6 +199,7 @@ rmw_publish_raw(const rmw_publisher_t * publisher, const rmw_message_raw_t * raw
  * \param type_support the typesupport for the ROS message
  * \param raw_message the destination for the serialize ROS message
  * \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
@@ -222,6 +223,7 @@ rmw_serialize(
  * \param type_support the typesupport for the typed ros message
  * \param ros_message destination for the deserialized ROS message
  * \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