search

3473f / ros2autodoc

ROS2 CLI tool to generate ROS Wiki style documentation template for ROS2 nodes
BSD 3-Clause "New" or "Revised" License
3 stars 0 forks source link

Pull parameter descriptions from Node itself #27

Closed jonselling closed 1 year ago

jonselling commented 1 year ago

I thought this effort was neat, and I wanted to note that each parameter can have a ParameterDescriptor that you can possibly access to get descriptions and some other information (like bounds) about a parameter.

I believe rqt_reconfigure pulls this information from the parameters if you wanted an example.

I also created an issue ( https://github.com/ros2/ros2/issues/1482 ) to add string descriptions to all ROS interfaces that this can also support from (and this is basically what I am looking for documentation wise)

3473f commented 1 year ago

Thanks for the tip! We have been using the tool for a few months now and I have a few things planne and this would definitely be a nice quality-of-life feature to include. I am extremely busy right now, but should have time for it in the first week of september so it should be coming soon! :)

3473f commented 1 year ago

@jonselling had a bit of time on my hand tonight so I decided to implement this. It would be neat if all interfaces included a description as well .. we will see how it goes with the other feature request.

jonselling commented 1 year ago

@3473f This is honestly extremely fast and not expected :laughing:. Great job!

I haven't started to test this plugin yet, but it seems like something my team might be interested in using.

I know we have been filling in the ParameterDescriptors where possible if we found a tool that could automatically pull them, so I just wanted to mention them as an option to you. Again, great job getting it done as fast as you did!

3473f commented 1 year ago

It was quite easy since I was making the API call to get the parameter info to get the data type, so I only needed to access the description field as well.

It's about time we started using the ParameterDescriptors as well (: We usually have a lot of interfaces, and it was tedious to list all of them manually, so having the tool generate a complete list and manually filling in the description saved us a lot of time.

It would be great to get feedback from you once you have tested it! 😄