Removed doxygen warnings (#712) (#724)

* Removed doxygen warnings

Signed-off-by: ahcorde <ahcorde@gmail.com>

* added feedback

Signed-off-by: ahcorde <ahcorde@gmail.com>

rcl_lifecycle/Doxyfile

@@ -8,7 +8,6 @@ INPUT                  = ./include
 RECURSIVE              = YES
 OUTPUT_DIRECTORY       = doc_output
 
-EXTRACT_ALL            = YES
 SORT_MEMBER_DOCS       = NO
 
 GENERATE_LATEX         = NO

rcl_lifecycle/include/rcl_lifecycle/data_types.h

@@ -26,48 +26,74 @@ extern "C"
 
 typedef struct rcl_lifecycle_transition_t rcl_lifecycle_transition_t;
 
+/// It contains the state of the lifecycle state machine
 typedef struct rcl_lifecycle_state_t
 {
+  /// String with state name: Unconfigured, Inactive, Active or Finalized
   const char * label;
+  /// Identifier of the state
   unsigned int id;
 
+  /// Pointer to a struct with the valid transitions
   rcl_lifecycle_transition_t * valid_transitions;
+  /// Number of valid transitions
   unsigned int valid_transition_size;
 } rcl_lifecycle_state_t;
 
+/// It contains the transitions of the lifecycle state machine
 typedef struct rcl_lifecycle_transition_t
 {
+  /// String with transition name: configuring, cleaningup, activating, deactivating,
+  /// errorprocessing or shuttingdown.
   const char * label;
+  /// Identifier of the transition
   unsigned int id;
+  /// The value where the transition is initialized
   rcl_lifecycle_state_t * start;
+  /// The objetive of the transition
   rcl_lifecycle_state_t * goal;
 } rcl_lifecycle_transition_t;
 
+/// It contains the transition map states and transitions
 typedef struct rcl_lifecycle_transition_map_t
 {
+  /// States used to generate the transition map
   rcl_lifecycle_state_t * states;
+  /// Number of states
   unsigned int states_size;
+  /// Transitions used to generate the transition map
   rcl_lifecycle_transition_t * transitions;
+  /// Number of transitions
   unsigned int transitions_size;
 } rcl_lifecycle_transition_map_t;
 
+/// It contains the communication interfac with the ROS world
 typedef struct rcl_lifecycle_com_interface_t
 {
+  /// Handle to the node used to create the publisher and the services
   rcl_node_t * node_handle;
+  /// Event used to publish the transitions
   rcl_publisher_t pub_transition_event;
+  /// Service that allows to trigger changes on the state
   rcl_service_t srv_change_state;
+  /// Service that allows to get the current state
   rcl_service_t srv_get_state;
+  /// Service that allows to get the available states
   rcl_service_t srv_get_available_states;
+  /// Service that allows to get the available transitions
   rcl_service_t srv_get_available_transitions;
+  /// Service that allows to get transitions from the graph
   rcl_service_t srv_get_transition_graph;
 } rcl_lifecycle_com_interface_t;
 
+/// It contains the state machine data
 typedef struct rcl_lifecycle_state_machine_t
 {
+  /// Current state of the state machine
   const rcl_lifecycle_state_t * current_state;
-  // Map/Associated array of registered states and transitions
+  /// Map/Associated array of registered states and transitions
   rcl_lifecycle_transition_map_t transition_map;
-  // Communication interface into a ROS world
+  /// Communication interface into a ROS world
   rcl_lifecycle_com_interface_t com_interface;
 } rcl_lifecycle_state_machine_t;