ros2 / rclcpp

rclcpp (ROS Client Library for C++)
Apache License 2.0
537 stars 417 forks source link

Latest Doxygen docs does not seem to include all files #2103

Open russkel opened 1 year ago

russkel commented 1 year ago

Expected behavior

Documentation of classes such as GenericSubscription should be in the documentation at https://docs.ros2.org/latest/api/rclcpp/

Actual behavior

Classes don't appear at all - not even in the class index: https://docs.ros2.org/latest/api/rclcpp/classes.html#letter_g

jrutgeer commented 1 year ago

docs.ros2.org is deprecated. It does no longer point to the latest API info. Links to the latest API (for any package, not just rclcpp) can be found from the corresponding package info page at the ROS Index. For rclcpp it's at https://docs.ros.org/en/humble/p/rclcpp/

The rclcpp README was fixed to reflect this info: see PR #2071

If you prefer the standard doxygen theme, I don´t know of another way than to download the source and manually run Doxygen, as described here. It's less of a hassle than you´d might expect.

fujitatomoya commented 1 year ago

related to https://github.com/ros2/ros2_documentation/pull/3323

russkel commented 1 year ago

docs.ros2.org is deprecated. It does no longer point to the latest API info.

I didn't even realise there were two domains! Thanks @jrutgeer for enlightening me.

In which case, I change the point of this ticket, can we get docs.ros2.org to redirect to docs.ros.org?

clalancette commented 1 year ago

In which case, I change the point of this ticket, can we get docs.ros2.org to redirect to docs.ros.org?

Once Foxy goes out of support in May, we will do this.