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 Fixes #14

Merged
merged 2 commits into from
Oct 21, 2023
Merged

Doxygen Fixes #14

merged 2 commits into from
Oct 21, 2023

Conversation

dmadison
Copy link
Owner

Two small Doxygen-related fixes.

First, enables autobrief so that all of the thorough documentation is properly split into brief and detail sections. Oops.

Second, changes the \brief command to \details for all of the examples, to fix double-printing text on the example pages.

I just realized that autobrief was disabled, so all of the thorough documentation was stuck in the detail section... oops
The @brief doesn't work in the file list since there is no @file for the examples to avoid documenting the example functions as part of the library. Changing this to @details also fixes the double printed text on the example pages.
@dmadison dmadison merged commit 053c24c into master Oct 21, 2023
2 checks passed
@dmadison dmadison deleted the doxygen-fixes branch October 21, 2023 06:43
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