clean up code

Signed-off-by: bpwilcox <bpwilcox@eng.ucsd.edu>
ros2 · Oct 28, 2019 · fd939c4 · fd939c4
1 parent fc25c14
commit fd939c4
Show file tree

Hide file tree

Showing 5 changed files with 216 additions and 201 deletions.
diff --git a/rcl_yaml_param_parser/include/rcl_yaml_param_parser/types.h b/rcl_yaml_param_parser/include/rcl_yaml_param_parser/types.h
@@ -74,9 +74,8 @@ typedef struct rcl_node_params_s
   size_t num_params;  ///< Number of parameters in the node
 } rcl_node_params_t;
 
-/// \typedef rcl_variant_t
-/// \brief variant_t stores the value of a parameter
-/// Only one pointer in this struct will store the value
+/// \typedef rcl_param_descriptor_t
+/// \brief param_descriptor_t stores the descriptor of a parameter
 typedef struct rcl_param_descriptor_s
 {
   char * name;
@@ -92,24 +91,17 @@ typedef struct rcl_param_descriptor_s
   int64_t * step_int;
 } rcl_param_descriptor_t;
 
-
-// typedef struct rcl_param_descriptor_keys_s
-// {
-//   char ** keys;
-// } rcl_param_descriptor_keys_t;
-
-/// \typedef rcl_node_params_t
-/// \brief node_params_descriptors_t stores all the parameters descriptors of a single node
+/// \typedef rcl_node_params_descriptors_t
+/// \brief node_params_descriptors_t stores all the parameter descriptors of a single node
 typedef struct rcl_node_params_descriptors_s
 {
   char ** parameter_names;  ///< Array of parameter names (keys)
   rcl_param_descriptor_t * parameter_descriptors;  ///< Array of coressponding parameter descriptors
-  // rcl_param_descriptor_keys_t * parameter_descriptors_keys;
   size_t num_params;  ///< Number of parameters in the node
 } rcl_node_params_descriptors_t;
 
 /// \typedef rcl_params_t
-/// \brief params_t stores all the parameters of all nodes of a process
+/// \brief params_t stores all the parameters and parameter descriptors of all nodes of a process
 typedef struct rcl_params_s
 {
   char ** node_names;  ///< List of names of the node