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

fix: comments for doxygen #287

Merged
merged 5 commits into from
Jun 18, 2024
Merged

fix: comments for doxygen #287

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
f87c3ed
fix comments for doxygen
xygyo77 May 31, 2024
e866b10
Update CARET_trace/include/caret_trace/tracing_controller.hpp
xygyo77 Jun 18, 2024
7095d11
Update CARET_trace/include/caret_trace/tracing_controller.hpp
xygyo77 Jun 18, 2024
2c28291
Update CARET_trace/include/caret_trace/tracing_controller.hpp
xygyo77 Jun 18, 2024
1f52035
sentence correction
xygyo77 Jun 18, 2024
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
19 changes: 9 additions & 10 deletions CARET_trace/include/caret_trace/tracing_controller.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,17 +38,17 @@ class TracingController
/// @param node_name Node name.
void add_node(const void * node_handle, std::string node_name);

/// @brief Register topic name for rcl_subscription_init hook.
/// @brief Register topic name and binding information for rcl_subscription_init hook.
/// @param node_handle Address of the node handle.
/// @param subscription_handle Address of the subscription handle.
/// @param topic_name topic name.
/// @param topic_name Topic name.
void add_subscription_handle(
const void * node_handle, const void * subscription_handle, std::string topic_name);

/// @brief Register topic name for rcl_subscription_init hook.
/// @brief Register topic name and binding information for rcl_subscription_init hook.
/// @param node_handle Address of the node handle.
/// @param rmw_subscription_handle Address of the rmw_subscription handle.
/// @param topic_name topic name.
/// @param topic_name Topic name.
void add_rmw_subscription_handle(
const void * node_handle, const void * rmw_subscription_handle, std::string topic_name);

Expand All @@ -67,7 +67,7 @@ class TracingController
/// @param node_handle Address of the node handle.
void add_timer_handle(const void * timer_handle, const void * node_handle);

/// @brief Register topic name for ros_trace_rcl_publisher_init
/// @brief Register topic name and binding information for rcl_publisher_init tracepoint.
/// @param node_handle Address of the node handle.
/// @param publisher_handle Address of the publisher handle.
/// @param topic_name Topic name.
Expand Down Expand Up @@ -104,13 +104,12 @@ class TracingController
/// @param node_handle Address of the node handle.
void add_client_handle(const void * client_handle, const void * node_handle);

/// @brief Registering acceptable and unacceptable message.
/// @brief Register message tracing enable/disable.
/// @param message Address of the intra original message.
/// @param is_allowed True is enabled, false otherwise.
void add_allowed_messages(const void * message, bool is_allowed);

/// @brief Check if trace point is a enabled callback
/// @param callback
/// @param callback Address of callback instance.
/// @return True if the callback is enabled, false otherwise.
bool is_allowed_callback(const void * callback);
Expand All @@ -130,12 +129,12 @@ class TracingController
/// @return True if the subscription is enabled, false otherwise.
bool is_allowed_subscription_handle(const void * subscription_handle);

/// @brief Check if trace point is a enabled subscription
/// @brief Check if trace point is a enabled rmw subscription
/// @param rmw_subscription_handle Address of the rmw_subscription handle.
/// @return True if the rmw_subscription is enabled, false otherwise.
bool is_allowed_rmw_subscription_handle(const void * rmw_subscription_handle);

/// @brief Check if trace point is a enabled subscription
/// @brief Check if trace point is a enabled intra-process buffer
/// @param buffer Address of the intra-process buffer.
/// @return True if the buffer is enabled, false otherwise.
bool is_allowed_buffer(const void * buffer);
Expand Down Expand Up @@ -169,7 +168,7 @@ class TracingController
/// @return True if the client_handle is enabled, false otherwise.
bool is_allowed_client_handle(const void * client_handle);

/// @brief Check if trace point is a enabled publisher
/// @brief Check if trace point is a enabled message
/// @param message Address of the message.
/// @return True if the message is enabled, false otherwise.
bool is_allowed_message(const void * message);
Expand Down
Loading