Skip to content

Conversation

schaubh
Copy link
Contributor

@schaubh schaubh commented Sep 20, 2023

  • Review: By commit
  • Merge strategy: Merge (no squash)

Description

The BSK documentation build process had a few new doxygen warnings at the very beginning of the build process. These are now fixed in this pull request.

Verification

Did a clean build of the documentation and no warnings were present.

Documentation

N/A

Future work

Be sure to keep checking the full RST documentation build process log for warnings.

@schaubh schaubh added the documentation Improvements or additions to documentation label Sep 20, 2023
@schaubh schaubh self-assigned this Sep 20, 2023
@schaubh schaubh force-pushed the feature/doc_warning_fix branch from 2b434ab to f16d0f5 Compare October 1, 2023 15:54
@schaubh schaubh requested a review from joaogvcarneiro October 7, 2023 13:00
@schaubh schaubh force-pushed the feature/doc_warning_fix branch from f16d0f5 to fd1dc09 Compare October 7, 2023 15:28
@schaubh schaubh force-pushed the feature/doc_warning_fix branch from fd1dc09 to 31674b4 Compare October 7, 2023 17:10
Copy link
Contributor

@joaogvcarneiro joaogvcarneiro left a comment

Choose a reason for hiding this comment

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

Looks good. However, please note that commits 2-4 have commit messages that are too long and are being chopped off.

@schaubh schaubh force-pushed the feature/doc_warning_fix branch from 31674b4 to 9db301d Compare October 8, 2023 14:22
The warning is about the method documentation having
arguments that are no longer present
The capitalization of
currentSimNanos changed in the method, but not the method
documentation.
This feature is now already in BSK
@schaubh schaubh force-pushed the feature/doc_warning_fix branch from 9db301d to 9ebf4e7 Compare October 8, 2023 14:27
@schaubh schaubh merged commit 31bfe00 into develop Oct 8, 2023
@schaubh schaubh deleted the feature/doc_warning_fix branch October 8, 2023 15:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants