Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Jump to bottom

Doxygen Updates #1255

Merged
merged 21 commits into from
Oct 26, 2022
Merged

Doxygen Updates #1255

merged 21 commits into from
Oct 26, 2022

Conversation

varunagrawal
Copy link
Collaborator

Based on #1252, I made a bunch of improvements to doxygen related doc generation.

  1. Defined different groups corresponding to the directories under gtsam.
  2. Made GTSAM_UNSTABLE a page since doxygen doesn't like having 2 mainpages.
  3. Fixed a whole bunch of grouping issues.
  4. Fixed a whole bunch of formatting issues.
  5. Replaced addtogroup with ingroup so that the docs render nicely.
  6. Upgraded the Doxyfile config file.
  7. Updated CMake to have the correct directory listing to look for docstrings.
  8. Fixed some docstring typos.
  9. Fixed incorrect filenames.

@varunagrawal varunagrawal added the docs Update to docs or README without code changes label Jul 26, 2022
@varunagrawal varunagrawal requested review from ProfFan and dellaert July 26, 2022 22:21
@varunagrawal varunagrawal self-assigned this Jul 26, 2022
ProfFan
ProfFan reviewed Jul 28, 2022
View reviewed changes
gtsam/navigation/CombinedImuFactor.h
@@ -252,7 +252,7 @@ class GTSAM_EXPORT PreintegratedCombinedMeasurements : public PreintegrationType
* the correlation between the bias uncertainty and the preintegrated
* measurements uncertainty.
*
* @ingroup SLAM
* @ingroup navigation
Copy link
Collaborator

Choose a reason for hiding this comment

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

does case matter in the final doc?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

No but those are labels and I liked the labels to be lower case. Helps differentiate between the actual titles in the docs.

@varunagrawal varunagrawal requested a review from ProfFan August 22, 2022 21:38
@varunagrawal
Copy link
Collaborator Author

Gentle reminder for review. There should be 0 code changes in this PR.

@jlblancoc jlblancoc self-requested a review October 25, 2022 19:36
jlblancoc
jlblancoc approved these changes Oct 25, 2022
View reviewed changes
Copy link
Member

@jlblancoc jlblancoc left a comment

Choose a reason for hiding this comment

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

LGTM

@varunagrawal varunagrawal merged commit b1a8225 into develop Oct 26, 2022
@varunagrawal varunagrawal deleted the fix/doxygen branch October 26, 2022 09:16
# for free to join this conversation on GitHub. Already have an account? # to comment
Reviewers

@jlblancoc jlblancoc jlblancoc approved these changes

@dellaert dellaert Awaiting requested review from dellaert

@ProfFan ProfFan Awaiting requested review from ProfFan

Assignees

@varunagrawal varunagrawal

Labels
docs Update to docs or README without code changes
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@varunagrawal @ProfFan @jlblancoc