Added missing documentation

Signed-off-by: Devin Bonnie <[email protected]>
ros2 · Apr 1, 2019 · a13bbdd · a13bbdd
1 parent f387d78
commit a13bbdd
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/rmw/include/rmw/event.h b/rmw/include/rmw/event.h
@@ -44,10 +44,15 @@ typedef enum rmw_event_type_t
   RMW_EVENT_INVALID
 } rmw_event_type_t;
 
+
+/// Encapsulate the RMW event implementation, data, and type.
 typedef struct RMW_PUBLIC_TYPE rmw_event_t
 {
+  /// Implementation identifier, used to ensure two different implementations are not being mixed.
   const char * implementation_identifier;
+  /// Data specific to this event type from either the publisher or subscriber.
   void * data;
+  /// The event type that occurred.
   rmw_event_type_t event_type;
 } rmw_event_t;
 

diff --git a/rmw/include/rmw/ret_types.h b/rmw/include/rmw/ret_types.h
@@ -26,6 +26,7 @@ typedef int32_t rmw_ret_t;
 #define RMW_RET_OK 0
 #define RMW_RET_ERROR 1
 #define RMW_RET_TIMEOUT 2
+/// The operation or event handling is not supported.
 #define RMW_RET_UNSUPPORTED 3
 /// Failed to allocate memory return code.
 #define RMW_RET_BAD_ALLOC 10