update docs (#147)

This commit is contained in:
William Woodall 2017-06-27 12:02:49 -07:00 committed by GitHub
parent 6c5f98ed4c
commit 9d37b9de72
3 changed files with 11 additions and 0 deletions

View file

@ -23,5 +23,6 @@ PREDEFINED += RCL_WARN_UNUSED=
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/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"

View file

@ -190,6 +190,7 @@ rcl_names_and_types_fini(rcl_names_and_types_t * names_and_types);
* <i>[1] implementation may need to protect the data structure with a lock</i>
*
* \param[in] node the handle to the node being used to query the ROS graph
* \param[in] allocator used to control allocation and deallocation of names
* \param[out] node_names struct storing discovered node names.
* \return `RCL_RET_OK` if the query was successful, or
* \return `RCL_RET_ERROR` if an unspecified error occurs.

View file

@ -29,6 +29,15 @@
* - Timer
* - rcl/timer.h
*
* There are some functions for working with "Topics" and "Services":
*
* - A function to validate a topic or service name (not necessarily fully qualified):
* - rcl_validate_topic_name()
* - rcl/validate_topic_name.h
* - A function to expand a topic or service name to a fully qualified name:
* - rcl_expand_topic_name()
* - rcl/expand_topic_name.h
*
* It also has some machinery that is necessary to wait on and act on these concepts:
*
* - Initialization and shutdown management (global for now)