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

Updates to rcutils to make rosdoc2 generation happier. #416

Merged
merged 2 commits into from
Mar 22, 2023

Conversation

clalancette
Copy link
Contributor

In particular:

  • Fix a mostly duplicated and slightly wrong formatted docblock at the top of sha256.c
  • Add in a few field names so doxygen can resolve them.
  • Make a doxygen-only function signature of sha256_final, since rosdoc2 doesn't understand uint8_t[]
  • Modify the configuration to include all needed files.

With this in place, all but one warning are removed when generating the documentation.

In particular:

* Fix a mostly duplicated and slightly wrong formatted docblock
at the top of sha256.c
* Add in a few field names so doxygen can resolve them.
* Make a doxygen-only function signature of sha256_final, since
rosdoc2 doesn't understand uint8_t[]
* Modify the configuration to include all needed files.

With this in place, all but one warning are removed when generating
the documentation.

Signed-off-by: Chris Lalancette <clalancette@gmail.com>
@clalancette
Copy link
Contributor Author

clalancette commented Mar 22, 2023

CI:

  • Linux Build Status
  • Linux-aarch64 Build Status
  • Windows Build Status

include/rcutils/sha256.h Outdated Show resolved Hide resolved
Signed-off-by: Chris Lalancette <clalancette@gmail.com>
@clalancette
Copy link
Contributor Author

New CI with the latest changes (only checking up to rcutils, since the change since the last CI was just to a comment):

  • Linux Build Status
  • Linux-aarch64 Build Status
  • Windows Build Status

Copy link
Member

@wjwwood wjwwood left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lgtm, thanks for updating it

@clalancette clalancette merged commit 9046167 into rolling Mar 22, 2023
@clalancette clalancette deleted the clalancette/doxygen-fixes branch March 22, 2023 19:37
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.

5 participants