Skip to content
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.

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

API documentation is outdated #914

Open
JanStaschulat opened this issue Apr 22, 2021 · 0 comments
Open

API documentation is outdated #914

JanStaschulat opened this issue Apr 22, 2021 · 0 comments
Assignees

Comments

@JanStaschulat
Copy link

JanStaschulat commented Apr 22, 2021

The API documentation for Foxy of rcl
https://index.ros.org/p/rcl/github-ros2-rcl/#foxy
clicking on API Docs, points to
https://docs.ros2.org/foxy/api/rcl/
This API documentation seems to be outdated. For example, the documentation for the node.h points to
https://docs.ros2.org/foxy/api/rcl/node_8h_source.html

This header file does not contain any doxygen documentation. While the node.h of the foxy branch contains lots of documentation:
https://github.com/ros2/rcl/blob/foxy/rcl/include/rcl/node.h

Maybe you are using an old ROS distribution for generating documentation for the foxy branch?

@clalancette clalancette self-assigned this May 13, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants