minor notes explaining rmw_qos_profile_t (#156)

* minor notes explaining rmw_qos_profile_t * Doxygen * Doxygen * fixup * Update rmw/include/rmw/types.h * using triple slash to match style
ros2 · Jan 11, 2019 · 132f306 · 132f306
1 parent b723424
commit 132f306
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/rmw/include/rmw/types.h b/rmw/include/rmw/types.h
@@ -192,9 +192,11 @@ enum RMW_PUBLIC_TYPE rmw_qos_durability_policy_t
   RMW_QOS_POLICY_DURABILITY_VOLATILE
 };
 
+/// ROS MiddleWare quality of service profile.
 typedef struct RMW_PUBLIC_TYPE rmw_qos_profile_t
 {
   enum rmw_qos_history_policy_t history;
+  /// Size of the message queue.
   size_t depth;
   enum rmw_qos_reliability_policy_t reliability;
   enum rmw_qos_durability_policy_t durability;