style: Unify style for all Doxygen comments#7776
Open
mathbunnyru wants to merge 16 commits into
Open
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #7776 +/- ##
=======================================
Coverage 82.6% 82.6%
=======================================
Files 1036 1036
Lines 79870 79870
Branches 8949 8949
=======================================
+ Hits 65959 65960 +1
+ Misses 13902 13901 -1
Partials 9 9
... and 206 files with indirect coverage changes 🚀 New features to boost your workflow:
|
godexsoft
approved these changes
Jul 10, 2026
godexsoft
left a comment
godexsoft
left a comment
Contributor
There was a problem hiding this comment.
Too much to review - checked by random sampling. In any case this is better than before
|
This PR has conflicts, please resolve them in order for the PR to be reviewed. |
|
All conflicts have been resolved. Assigned reviewers can now start or resume their review. |
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.
High Level Overview of Change
Brings documentation comments into a single, consistent house style. This is a
formatting-only change — no code and no comment wording was altered (verified:
every diff hunk is comment-only, and comment text is preserved verbatim aside
from the tag conversions below).
///comment blocks and/*!(Qt-style)blocks to
/** … */, so all Doxygen comments use a single form./**and the closing*/each sit alone ontheir own line; every content line is prefixed with
*; bare-indentedcontinuation lines (the old "aligned text" style) now carry the
*prefix.(
/** @brief …,/** text …) off the opener line, and expanded single-line/** text */comments to multi-line blocks.\brief,\param, …) to the@-form used everywhere else.Returns:/Throws:function-doc labelswith
@return/@throws(the house convention).bodies while preserving the relative indentation of embedded
@codesamples,lists, and hanging
@paramcontinuations.@{,@},@cond [label],@endcond) are kept as single-line/** … */.new style and regenerated
protocol_autogen, so generated headers stayconsistent with the templates.
Left intentionally untouched:
///<//**<"member-after" comments,all-slash divider lines, plain non-Doxygen
/* … */comments, and the C++standardese requirement blocks (
Effects:/Preconditions:/ nestedThrows:) inhash_append.handEnv.h.This doesn't change the actual content of comments, doesn't add new annotations and etc..
Only unifies style of most (hopefully, almost all) existing comments which are treated as doxygen commetns.
Context of Change
API Impact
libxrplchange (any change that may affectlibxrplor dependents oflibxrpl)