search

ros2 / rmw

The ROS Middleware (rmw) Interface.
Apache License 2.0
95 stars 67 forks source link

Fix up errors in doxygen documentation. #311

Closed clalancette closed 3 years ago

clalancette commented 3 years ago

While running the rosdoc2 tool against this repository, I came across these documentation errors. This PR fixes them all up so that doxygen runs clean. We still can't successfully run rosdoc2 on this package due to one other error, but at least this will get us ready once we figure that issue out.

Signed-off-by: Chris Lalancette clalancette@openrobotics.org

clalancette commented 3 years ago

I don't feel strongly about [inout] vs [in,out], but I think we use [inout] elsewhere like in rclcpp.

Yeah, that's true. I was following that pattern here, though @aprotyas is correct about Doxygen suggesting [in,out]. Is it better to be consistent with our style elsewhere, or correct in terms of the Doxygen documentation? I'm not sure. My inclination is to be consistent, and leave this as [inout]. Maybe in the future we can do a pass where we update all of them (but I also don't feel strongly about this point).

wjwwood commented 3 years ago

Yeah, I don't mind about the inout thing. I would say just leave it inout for consistency.

clalancette commented 3 years ago

I believe the conversation in https://github.com/ros2/rmw/pull/311#discussion_r687108023 is wrapped up (with further work to come, but in a different PR).

With that said, this now has approvals. It also has green PR job. I'm going to skip CI since this is a documentation change only. Thanks for the reviews!

ros-discourse commented 3 years ago

This pull request has been mentioned on ROS Discourse. There might be relevant details there:

https://discourse.ros.org/t/ros-2-tsc-meeting-minutes-2021-08-19/22008/1

ros-discourse commented 3 years ago

This pull request has been mentioned on ROS Discourse. There might be relevant details there:

https://discourse.ros.org/t/ros-2-tsc-meeting-minutes-2021-9-16/22372/1