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

[rcl_action] Minor documentation fixes (#397)

Browse source 
* Update rcl_action Doxyfile

Add reference to rcl tagfile and fix generated tagfile name.

Signed-off-by: Jacob Perron <jacob@openrobotics.org>

* Fix minor doc errors

Signed-off-by: Jacob Perron <jacob@openrobotics.org>
This commit is contained in:
Jacob Perron 2019-03-11 14:46:18 -07:00 • committed by GitHub
parent 4f9e6bc12f
commit 1a34301995
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 4 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

3
rcl_action/Doxyfile
View file

@ -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
rcl_action/include/rcl_action/rcl_action.h
View file

@ -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