Remove \brief commands from doxygen comments. #21017
Merged
Conversation
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
|
@swift-ci Please test |
|
Next up on the chopping block: the really old style of "FooMethod - Does the foo thing." |
adrian-prantl
force-pushed
the
debrief
branch
from
5555e2b to
eb951be
Compare
|
@swift-ci test |
1 similar comment
|
@swift-ci test |
|
Build failed |
|
Build failed |
We've been running doxygen with the autobrief option for a couple of
years now. This makes the \brief markers into our comments
redundant. Since they are a visual distraction and we don't want to
encourage more \brief markers in new code either, this patch removes
them all.
Patch produced by
for i in $(git grep -l '\\brief'); do perl -pi -e 's/\\brief //g' $i & done
adrian-prantl
force-pushed
the
debrief
branch
from
eb951be to
a9b4b6a
Compare
|
@swift-ci test and merge |
adrian-prantl
force-pushed
the
debrief
branch
from
a9b4b6a to
ff63eae
Compare
|
@swift-ci test and merge |
1 similar comment
|
@swift-ci test and merge |
|
That test failure looks unrelated. @swift-ci smoke test |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
[This is analogous to LLVM r331272 and CFE r331834]
We've been running doxygen with the autobrief option for a couple of
years now. This makes the \brief markers into our comments
redundant. Since they are a visual distraction and we don't want to
encourage more \brief markers in new code either, this patch removes
them all.
Patch produced by