niklas/rcl
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Removed doxygen warnings (#712) (#724)

Browse source 
* Removed doxygen warnings

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

* added feedback

Signed-off-by: ahcorde <ahcorde@gmail.com>
This commit is contained in:
Alejandro Hernández Cordero 2020-07-22 15:23:48 +02:00 • committed by GitHub
parent fd5e56a0e6
commit aa0967f0e2
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
20 changed files with 106 additions and 23 deletions
Download patch file Download diff file Expand all files Collapse all files

1
rcl_yaml_param_parser/Doxyfile
View file

@ -9,7 +9,6 @@ USE_MDFILE_AS_MAINPAGE = README.md
RECURSIVE = YES
OUTPUT_DIRECTORY = doc_output
EXTRACT_ALL = YES
SORT_MEMBER_DOCS = NO
GENERATE_LATEX = NO

2
rcl_yaml_param_parser/include/rcl_yaml_param_parser/parser.h
View file

@ -12,7 +12,7 @@
// See the License for the specific language governing permissions and
// limitations under the License.
/** \mainpage rcl_yaml_param_parser: Parse a YAML parameter file and populate the C data structure
/** rcl_yaml_param_parser: Parse a YAML parameter file and populate the C data structure
*
* - Parser
* - rcl/parser.h

52
rcl_yaml_param_parser/include/rcl_yaml_param_parser/types.h
View file

@ -17,41 +17,59 @@
#include "rcutils/allocator.h"
#include "rcutils/types/string_array.h"
/// \typedef rcl_bool_array_t
/// \brief Array of bool values
/// Array of bool values
/*
* \typedef rcl_bool_array_t
*/
typedef struct rcl_bool_array_s
{
/// Array with bool values
bool * values;
/// Number of values in the array
size_t size;
} rcl_bool_array_t;
/// \typedef rcl_int64_array_t
/// \brief Array of int64_t values
/// Array of int64_t values
/*
* \typedef rcl_int64_array_t
*/
typedef struct rcl_int64_array_s
{
/// Array with int64 values
int64_t * values;
/// Number of values in the array
size_t size;
} rcl_int64_array_t;
/// \typedef rcl_double_array_t
/// \brief Array of double values
/// Array of double values
/*
* \typedef rcl_double_array_t
*/
typedef struct rcl_double_array_s
{
/// Array with double values
double * values;
/// Number of values in the array
size_t size;
} rcl_double_array_t;
/// \typedef rcl_byte_array_t
/// \brief Array of byte values
/// Array of byte values
/*
* \typedef rcl_byte_array_t
*/
typedef struct rcl_byte_array_s
{
/// Array with uint8_t values
uint8_t * values;
/// Number of values in the array
size_t size;
} rcl_byte_array_t;
/// \typedef rcl_variant_t
/// \brief variant_t stores the value of a parameter
/// Only one pointer in this struct will store the value
/// variant_t stores the value of a parameter
/*
* Only one pointer in this struct will store the value
* \typedef rcl_variant_t
*/
typedef struct rcl_variant_s
{
bool * bool_value; ///< If bool, gets stored here
@ -65,8 +83,10 @@ typedef struct rcl_variant_s
rcutils_string_array_t * string_array_value; ///< If array of strings
} rcl_variant_t;
/// \typedef rcl_node_params_t
/// \brief node_params_t stores all the parameters(key:value) of a single node
/// node_params_t stores all the parameters(key:value) of a single node
/*
* \typedef rcl_node_params_t
*/
typedef struct rcl_node_params_s
{
char ** parameter_names; ///< Array of parameter names (keys)
@ -74,8 +94,10 @@ typedef struct rcl_node_params_s
size_t num_params; ///< Number of parameters in the node
} rcl_node_params_t;
/// \typedef rcl_params_t
/// \brief params_t stores all the parameters of all nodes of a process
/// stores all the parameters of all nodes of a process
/*
* \typedef rcl_params_t
*/
typedef struct rcl_params_s
{
char ** node_names; ///< List of names of the node