Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix up documentation build for rcl_lifecycle when using rosdoc2 #938

Merged
merged 1 commit into from
Sep 28, 2021
Merged

Fix up documentation build for rcl_lifecycle when using rosdoc2 #938

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions rcl_lifecycle/Doxyfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ ENABLE_PREPROCESSING = YES
MACRO_EXPANSION = YES
EXPAND_ONLY_PREDEF = YES
PREDEFINED += RCL_LIFECYCLE_PUBLIC=
PREDEFINED += RCL_WARN_UNUSED=

# Tag files that do not exist will produce a warning and cross-project linking will not work.
TAGFILES += "../../../../doxygen_tag_files/cppreference-doxygen-web.tag.xml=http://en.cppreference.com/w/"
Expand Down
14 changes: 7 additions & 7 deletions rcl_lifecycle/include/rcl_lifecycle/data_types.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,10 @@ extern "C"
{
#endif

typedef struct rcl_lifecycle_transition_t rcl_lifecycle_transition_t;
typedef struct rcl_lifecycle_transition_s rcl_lifecycle_transition_t;

/// It contains the state of the lifecycle state machine
typedef struct rcl_lifecycle_state_t
typedef struct rcl_lifecycle_state_s
{
/// String with state name: Unconfigured, Inactive, Active or Finalized
const char * label;
Expand All @@ -41,7 +41,7 @@ typedef struct rcl_lifecycle_state_t
} rcl_lifecycle_state_t;

/// It contains the transitions of the lifecycle state machine
typedef struct rcl_lifecycle_transition_t
typedef struct rcl_lifecycle_transition_s
{
/// String with transition name: configuring, cleaningup, activating, deactivating,
/// errorprocessing or shuttingdown.
Expand All @@ -55,7 +55,7 @@ typedef struct rcl_lifecycle_transition_t
} rcl_lifecycle_transition_t;

/// It contains the transition map states and transitions
typedef struct rcl_lifecycle_transition_map_t
typedef struct rcl_lifecycle_transition_map_s
{
/// States used to generate the transition map
rcl_lifecycle_state_t * states;
Expand All @@ -68,7 +68,7 @@ typedef struct rcl_lifecycle_transition_map_t
} rcl_lifecycle_transition_map_t;

/// It contains the communication interfac with the ROS world
typedef struct rcl_lifecycle_com_interface_t
typedef struct rcl_lifecycle_com_interface_s
{
/// Handle to the node used to create the publisher and the services
rcl_node_t * node_handle;
Expand All @@ -87,7 +87,7 @@ typedef struct rcl_lifecycle_com_interface_t
} rcl_lifecycle_com_interface_t;

/// It contains various options to configure the rcl_lifecycle_state_machine_t instance
typedef struct rcl_lifecycle_state_machine_options_t
typedef struct rcl_lifecycle_state_machine_options_s
{
/// Flag indicating whether the state machine shall be initialized with default states
bool initialize_default_states;
Expand All @@ -98,7 +98,7 @@ typedef struct rcl_lifecycle_state_machine_options_t
} rcl_lifecycle_state_machine_options_t;

/// It contains the state machine data
typedef struct rcl_lifecycle_state_machine_t
typedef struct rcl_lifecycle_state_machine_s
{
/// Current state of the state machine
const rcl_lifecycle_state_t * current_state;
Expand Down