* Removed doxygen warnings Signed-off-by: ahcorde <ahcorde@gmail.com> * added feedback Signed-off-by: ahcorde <ahcorde@gmail.com>
This commit is contained in:
parent
fd5e56a0e6
commit
aa0967f0e2
20 changed files with 106 additions and 23 deletions
|
@ -8,7 +8,6 @@ INPUT = ./include
|
|||
RECURSIVE = YES
|
||||
OUTPUT_DIRECTORY = doc_output
|
||||
|
||||
EXTRACT_ALL = YES
|
||||
SORT_MEMBER_DOCS = NO
|
||||
|
||||
GENERATE_LATEX = NO
|
||||
|
@ -21,7 +20,6 @@ PREDEFINED += RCL_WARN_UNUSED=
|
|||
|
||||
# Uncomment to generate internal documentation.
|
||||
ENABLED_SECTIONS = INTERNAL
|
||||
INPUT += ./src/rcl/arguments.c
|
||||
|
||||
# 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/"
|
||||
|
|
|
@ -32,6 +32,7 @@ struct rcl_action_client_impl_t;
|
|||
/// Structure which encapsulates a ROS action client.
|
||||
typedef struct rcl_action_client_t
|
||||
{
|
||||
/// Pointer to the action client implementation
|
||||
struct rcl_action_client_impl_t * impl;
|
||||
} rcl_action_client_t;
|
||||
|
||||
|
@ -39,10 +40,15 @@ typedef struct rcl_action_client_t
|
|||
typedef struct rcl_action_client_options_t
|
||||
{
|
||||
/// Middleware quality of service settings for the action client.
|
||||
/// Goal service quality of service
|
||||
rmw_qos_profile_t goal_service_qos;
|
||||
/// Result service quality of service
|
||||
rmw_qos_profile_t result_service_qos;
|
||||
/// Cancel service quality of service
|
||||
rmw_qos_profile_t cancel_service_qos;
|
||||
/// Feedback topic quality of service
|
||||
rmw_qos_profile_t feedback_topic_qos;
|
||||
/// Status topic quality of service
|
||||
rmw_qos_profile_t status_topic_qos;
|
||||
/// Custom allocator for the action client, used for incidental allocations.
|
||||
/** For default behavior (malloc/free), see: rcl_get_default_allocator() */
|
||||
|
|
|
@ -35,6 +35,7 @@ struct rcl_action_server_impl_t;
|
|||
/// Structure which encapsulates a ROS Action Server.
|
||||
typedef struct rcl_action_server_t
|
||||
{
|
||||
/// Pointer to the action server implementation
|
||||
struct rcl_action_server_impl_t * impl;
|
||||
} rcl_action_server_t;
|
||||
|
||||
|
@ -42,10 +43,15 @@ typedef struct rcl_action_server_t
|
|||
typedef struct rcl_action_server_options_t
|
||||
{
|
||||
/// Middleware quality of service settings for the action server.
|
||||
/// Goal service quality of service
|
||||
rmw_qos_profile_t goal_service_qos;
|
||||
/// Cancel service quality of service
|
||||
rmw_qos_profile_t cancel_service_qos;
|
||||
/// Result service quality of service
|
||||
rmw_qos_profile_t result_service_qos;
|
||||
/// Feedback topic quality of service
|
||||
rmw_qos_profile_t feedback_topic_qos;
|
||||
/// Status topic quality of service
|
||||
rmw_qos_profile_t status_topic_qos;
|
||||
/// Custom allocator for the action server, used for incidental allocations.
|
||||
/** For default behavior (malloc/free), see: rcl_get_default_allocator() */
|
||||
|
|
|
@ -32,6 +32,7 @@ struct rcl_action_goal_handle_impl_t;
|
|||
/// Goal handle for an action.
|
||||
typedef struct rcl_action_goal_handle_t
|
||||
{
|
||||
/// Pointer to the action goal handle implementation
|
||||
struct rcl_action_goal_handle_impl_t * impl;
|
||||
} rcl_action_goal_handle_t;
|
||||
|
||||
|
|
|
@ -65,15 +65,19 @@ typedef struct rcl_action_server_t rcl_action_server_t;
|
|||
// Typedef generated messages for convenience
|
||||
typedef action_msgs__msg__GoalInfo rcl_action_goal_info_t;
|
||||
typedef action_msgs__msg__GoalStatus rcl_action_goal_status_t;
|
||||
/// Struct with the action goal status array
|
||||
typedef struct rcl_action_goal_status_array_t
|
||||
{
|
||||
/// Goal status array message
|
||||
action_msgs__msg__GoalStatusArray msg;
|
||||
/// Allocator used to initialize this struct.
|
||||
rcl_allocator_t allocator;
|
||||
} rcl_action_goal_status_array_t;
|
||||
typedef action_msgs__srv__CancelGoal_Request rcl_action_cancel_request_t;
|
||||
/// Struct with the action cancel response
|
||||
typedef struct rcl_action_cancel_response_t
|
||||
{
|
||||
/// Cancel goal response message
|
||||
action_msgs__srv__CancelGoal_Response msg;
|
||||
/// Allocator used to initialize this struct.
|
||||
rcl_allocator_t allocator;
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue