Fix Doxygen warnings in IPPL API comments#499
Open
aaadelmann wants to merge 4 commits into
Open
Conversation
Clean up a first batch of API documentation issues reported by Doxygen: - fix over-qualified Communicator::split definition - remove duplicate FDTD constructor docs from implementation files - correct stale and mismatched @param names - replace malformed @Brieg command with @brief - avoid recursive or incorrect copydoc targets in buffer docs - add missing parameter names for particle, FEM, and solver APIs Regenerating Doxygen now removes the targeted warning families and keeps the manual/API link check clean.
biddisco
reviewed
May 19, 2026
Collaborator
biddisco
left a comment
biddisco
left a comment
There was a problem hiding this comment.
LGTM apart from one typo. I don't know why the clang-format relative path fix is needed -was it broken somewhere? (I looked at the new version but couldn't quite see what it is doing, however, I trust you wouldn't put it there without checking it ...)
Co-authored-by: John Biddiscombe <biddisco@cscs.ch>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Clean up a first batch of API documentation issues reported by Doxygen:
Regenerating Doxygen now removes the targeted warning families and keeps the manual/API link check clean.