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

Doxygen comments for generated C++ structs #675

Draft
wants to merge 1 commit into
base: rolling
Choose a base branch
from

Conversation

ottojo
Copy link

@ottojo ottojo commented Apr 7, 2022

I noticed that the .msg to .idl conversion preserves comments, and while the template for C structs includes those as doxygen comments (here), the C++ template is still missing those.

This PR intends to add the same comments to the C++ template.

I just copied over the code from the C template, which seems to work. I am not sure however how i can test this in my local workspace with a package containing message definitions and another package containing C++ nodes using those messages... I found the rosidl generate command, but i am not sure how i can use the modified rosidl_generator_cpp when building my messages-package...

@ottojo
Copy link
Author

ottojo commented Apr 7, 2022

BTW: Is it specified/documented somewhere which/how comments are extracted from .msg to .idl? I noticed, for example, by reading the source code that units are extracted from comments seperately if they follow the pattern (\s*\[([^,\]]+)\]) https://github.com/ros2/rosidl/blob/master/rosidl_adapter/rosidl_adapter/parser.py#L561-L570

@audrow audrow changed the base branch from master to rolling June 28, 2022 14:23
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

Successfully merging this pull request may close these issues.

1 participant