Skip to content

Conversation

@bmribler
Copy link
Collaborator

@bmribler bmribler commented Dec 10, 2025

  • Added missing html tags
  • When \c is used inside , Doxygen did not parse correctly, causing a mismatched error. Replaced \c with <tt></tt>.

* an \c ENUM required for their use, are described below.
*
* <b>Callback struct and \c ENUM:</b>
* <b>Callback struct and \TText{ENUM:}</b>
Copy link

Choose a reason for hiding this comment

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

There appears to be a typo with the Doxygen command on this line. The original text used \c ENUM: while the change now uses \TText{ENUM:}. Please verify if \TText is the intended command or if it should remain \c (or another valid Doxygen macro), as the commit title suggests this change was to fix typos.

Suggested change
* <b>Callback struct and \TText{ENUM:}</b>
* <b>Callback struct and \c ENUM:</b>

Copy link
Collaborator Author

@bmribler bmribler Dec 10, 2025

Choose a reason for hiding this comment

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

No, it is not a typo. The original source had:
Callback struct and \c ENUM:
Doxygen was converting \c ENUM: into <computeroutput>ENUM:</computeroutput>
This created mismatched/improperly nested XML tags: ...<computeroutput>ENUM:</bold></computeroutput>
The XML parser failed on this, preventing the entire file from being indexed.
Using <tt> instead of \c inside HTML <b> tags avoids the nesting issue.

The problem was mixing HTML tags (<b>) with Doxygen commands (\c). The fix ensures proper XML nesting.

@lrknox lrknox merged commit 94c3f7c into HDFGroup:develop Dec 12, 2025
122 checks passed
@github-project-automation github-project-automation bot moved this from To be triaged to Done in HDF5 - TRIAGE & TRACK Dec 12, 2025
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.

4 participants