You're reading the documentation for a development version. For the latest released version, please have a look at Iron.

API Documentation

All ROS 2 package’s documentation is hosted alongside its information on the ROS Index. Searching for packages will yield their information such as released distributions, README.md files, URLs, and other important metadata. A list of all packages for each distribution on the index can be found here. From the right-hand side of a package of interest, the auto-generated API documentation may be found found using the “API Docs” button.

You can find the API Documentation for the Client Libraries in the Rolling distribution using the links below:

• rclcpp - C++ client library

• rclcpp_lifecycle - C++ lifecycle library

• rclcpp_components - C++ components library

• rclcpp_action - C++ actions library

A raw list of Rolling package documentation may be found here.