Skip to content

[rcl_action] Minor documentation fixes #397

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

Merged
jacobperron merged 2 commits into from
Mar 11, 2019
Merged

[rcl_action] Minor documentation fixes #397

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
517fdf2
Update rcl_action Doxyfile
jacobperron Mar 11, 2019
17d82ca
Fix minor doc errors
jacobperron Mar 11, 2019
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
3 changes: 2 additions & 1 deletion rcl_action/Doxyfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,8 @@ 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/"
# Consider changing "latest" to the version you want to reference (e.g. beta1 or 1.0.0)
TAGFILES += "../../../../doxygen_tag_files/rmw.tag=http://docs.ros2.org/latest/api/rcl/"
TAGFILES += "../../../../doxygen_tag_files/rmw.tag=http://docs.ros2.org/latest/api/rmw/"
TAGFILES += "../../../../doxygen_tag_files/rcutils.tag=http://docs.ros2.org/latest/api/rcutils/"
# Uncomment to generate tag files for cross-project linking.
#GENERATE_TAGFILE = "../../../../doxygen_tag_files/rcl.tag"
# GENERATE_TAGFILE = "../../../../doxygen_tag_files/rcl_action.tag"
4 changes: 2 additions & 2 deletions rcl_action/include/rcl_action/rcl_action.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,10 @@

/** \mainpage rcl: Common functionality ROS actions
*
* `rcl_action` provides a pure C implementation of the ROS concept an \b action.
* `rcl_action` provides a pure C implementation of the ROS concept of an \b action.
* It builds on top of the implementation of topics and services in `rcl`.
*
* `rcl_action` consists of functions and structs following ROS action entities:
* `rcl_action` consists of functions and structs for the following ROS action entities:
*
* - Action client
* - rcl_action/action_client.h
Expand Down