You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Two Doxygen-specific issues in the new comments that will affect the generated docs:
1. ///< used as a section header documents the wrong thing (and drops the text)
///< is a trailing comment — it documents the preceding declaration, not the line below it. In several places it's placed on its own line before a member as a section marker, e.g. in read_pp.h / pseudo.h:
///<PP_HEADER>bool has_so = false; ///< if .true. includes spin-orbit
Two problems here:
The ///<PP_HEADER> attaches backward (to whatever came before), so it does not label has_so.
Doxygen parses <PP_HEADER> as an unknown HTML tag and silently drops it (with a warning), so the section text is lost entirely.
Same pattern appears with ///<PP_INFO>, ///<PP_MESH>, ///<Dynamic arrays>, ///<VWR format>, ///<USPP>, ///<UPF201 format> (read_pp.h), and ///<K-point information> (parallel_kpoints.h).
Suggested fix — use a member group instead:
/// @name PP_HEADER/// @{bool has_so = false; ///< if .true. includes spin-orbitint nv = 0; ///< UPF file version number/// @}
or, if a group is overkill, just a plain /// line (no <, and avoid the angle brackets so it isn't read as HTML):
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
keep cleaning source_cell