Skip to content

Conversation

@bmribler
Copy link
Collaborator

@bmribler bmribler commented Nov 24, 2025

  • Added c++ source files to file patterns to include detailed description of member functions.
  • Cleaned up many outdated comments and added missing documentation of several parameters.
  • Removed the C++ API main page for it's no longer relevant because the C++ documentation is now in the RM of the main library documentation.

Fixes #5529


Important

Added C++ source files to FILE_PATTERNS in Doxyfile.in for detailed member function descriptions.

  • Configuration:
    • Added @HDF5_CPP_SRC_DIR@/*.h and @HDF5_CPP_SRC_DIR@/*.cpp to FILE_PATTERNS in Doxyfile.in to include C++ source files for detailed member function descriptions.

This description was created by Ellipsis for e7169f2. You can customize this summary. It will automatically update as commits are pushed.

Added c++ source files to file patterns to include detailed description
of member functions.
- added missing parameters and made other corrections
- removed outdated comments/notes
@bmribler bmribler marked this pull request as ready for review December 3, 2025 05:51
@bmribler bmribler assigned lrknox and byrnHDF and unassigned bmribler Dec 5, 2025
@brtnfld
Copy link
Collaborator

brtnfld commented Dec 5, 2025

Didn't you lose the introductory material when you deleted the file? Why is that no longer important?

@brtnfld
Copy link
Collaborator

brtnfld commented Dec 5, 2025

The CXX/TUTR aren't referenced from anywhere

@bmribler
Copy link
Collaborator Author

bmribler commented Dec 5, 2025

Didn't you lose the introductory material when you deleted the file? Why is that no longer important?

Actually, when the C++ RM was moved to doxygen, it already lost that introduction. The C++ RM was put in as part of the main RM, so my objection about losing the introduction wasn't valid. The C++ RM even lost all the detail description of the methods, hence issue #5529. This PR fixes #5529, but there is no good place to add the introduction back in the current structure.

@bmribler
Copy link
Collaborator Author

bmribler commented Dec 5, 2025

The CXX/TUTR aren't referenced from anywhere

The only way to get to the C++ API is in the Reference Manual.

@lrknox lrknox merged commit 2cee17d into HDFGroup:develop Dec 6, 2025
129 checks passed
@github-project-automation github-project-automation bot moved this from To be triaged to Done in HDF5 - TRIAGE & TRACK Dec 6, 2025
@bmribler bmribler deleted the fix_gh_5529 branch December 8, 2025 06:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Component - Documentation Doxygen, markdown, etc.

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

C++ reference manual does not show detailed description

5 participants