Skip to content

Update doxygen configuration files #498

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

Merged
merged 4 commits into from
Jun 20, 2025
Merged

Update doxygen configuration files #498

merged 4 commits into from
Jun 20, 2025

Conversation

bobpaw
Copy link
Collaborator

@bobpaw bobpaw commented Jun 19, 2025

Update doxygen configuration files

  • Configure public documentation INPUT programmatically from HEADERS lists in CMake scorec_export_library.
  • Configure private documentation INPUT programmatically from subdirectories.
  • Strip the CMake source path from all public documentation file names.
    • not sure why the default "shortest unique path" functionality wasn't working
    • Leave full filenames in for internal documentation because it may be important or include build details.
  • Add __cplusplus to Doxygen PREDEFINED macros to ensure all APIs are extracted.
  • Change Doxyfile_internal.in output directory so both documentations can be generated side by side.

bobpaw added 4 commits June 18, 2025 12:15
- CMakeLists.txt: move Doxyfile generation below all add_subdirectory
  calls so that INPUTS can be collected.
- (scorec_export_library): add public header collection into
  DOXYGEN_INPUTS list.
- build DOXYGEN_INPUT from the list (one item per line).
- Doxyfile.in: strip the cmake source path from all file names (not sure
  why the default "shortest unique path" functionality wasn't working,
  but this is more foolproof).
- remove hard coded input headers and replace with DOXYGEN_INPUT.
- add __cplusplus to PREDEFINED macros to ensure all APIs are extracted.
- Doxyfile_internal.in: change output directory so both documentations
  can be generated side by side
- add DOXYGEN_INPUT to INPUT variable, but don't remove headers because
  they might represent private headers.

Signed-off-by: Aiden Woodruff <woodra@rpi.edu>
- doxygen -u Doxyfile.in
- doxygen -u Doxyfile_internal.in

Signed-off-by: Aiden Woodruff <woodra@rpi.edu>
Signed-off-by: Aiden Woodruff <woodra@rpi.edu>
- CMakeLists.txt: get list of subdirectories as INPUT for internal docs.
- Doxyfile_internal.in: replace input list with subdirectories.
- search directories recursively for headers and dox pages.
- lots of files so make subdirectories.
- remove protected=private macro because private tags are extracted for
  internal docs and the distinction is useful.

Signed-off-by: Aiden Woodruff <woodra@rpi.edu>
@bobpaw bobpaw requested a review from cwsmith June 20, 2025 13:51
Copy link
Contributor

@cwsmith cwsmith left a comment

Choose a reason for hiding this comment

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

This is a nice improvement. Thank you.

@cwsmith cwsmith merged commit 0250bc3 into develop Jun 20, 2025
32 checks passed
@cwsmith cwsmith deleted the apw/update-doxygen branch June 20, 2025 18:02
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.

2 participants