-
Notifications
You must be signed in to change notification settings - Fork 302
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
Standardize Doxygen parameter formatting for systems A-N #2183
Conversation
…his is for systems beginning with A-N. Signed-off-by: Mabel Zhang <[email protected]>
Codecov Report
@@ Coverage Diff @@
## gz-sim8 #2183 +/- ##
===========================================
+ Coverage 65.92% 66.04% +0.11%
===========================================
Files 323 323
Lines 30719 30718 -1
===========================================
+ Hits 20251 20287 +36
+ Misses 10468 10431 -37
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Other than the @ahcorde's unresolved issue, LGTM!
Signed-off-by: Mabel Zhang <[email protected]>
Signed-off-by: Mabel Zhang <[email protected]>
Addressed |
Signed-off-by: Mabel Zhang <[email protected]>
@ahcorde Merging is blocked until change requested changes to green check :) |
Signed-off-by: Mabel Zhang <[email protected]>
🦟 Bug fix
We were looking to improve the Doxygen pages for system plugins and noticed some huge paragraphs that meant to be bullet lists, and inconsistencies in headings.
This PR standardizes the formatting for SDF parameters for systems starting with letter A to N (which is not to say I will do the same for O to Z, as this isn't really the task I'm tackling... just fixing on the way as I familiarize myself with how systems are documented).
A-N is 46 systems. There are only 24 remaining that others can fight over.
Summary
This is the standard being adopted (comes from
AckermannSteering
, not because it's the first in the alphabetical list, but because its rendered page looks the best):## System Parameters
, to appear the same size as the preset "Detailed Description" heading\sa
, or they are all in one huge paragraph.- <param>
- <param>:
, but I let some pass with hyphen, because it wasn't worth the effort.To test
In a browser, navigate to
build/gz-sim8/doxygen/html/index.html
Click on the “gz::sim::systems” link.
Look at the corresponding system pages.
Compare to the live render here before the fix: https://gazebosim.org/api/sim/8/
Checklist
codecheck
passed (See contributing)Note to maintainers: Remember to use Squash-Merge and edit the commit message to match the pull request summary while retaining
Signed-off-by
messages.