diff options
author | Adrian Prantl <aprantl@apple.com> | 2018-05-09 01:00:01 +0000 |
---|---|---|
committer | Adrian Prantl <aprantl@apple.com> | 2018-05-09 01:00:01 +0000 |
commit | 9fc8faf9e619733a21915d4c41696f09aa2a7a50 (patch) | |
tree | f35a970439bcea95268071f86c04a93d09fdabeb /clang/lib/AST/CommentBriefParser.cpp | |
parent | cfa98548307264f29ec447e24452117b72bcb517 (diff) | |
download | bcm5719-llvm-9fc8faf9e619733a21915d4c41696f09aa2a7a50.tar.gz bcm5719-llvm-9fc8faf9e619733a21915d4c41696f09aa2a7a50.zip |
Remove \brief commands from doxygen comments.
This is similar to the LLVM change https://reviews.llvm.org/D46290.
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
for i in $(git grep -l '\\brief'); do perl -pi -e 's/\\brief //g' $i & done
Differential Revision: https://reviews.llvm.org/D46320
llvm-svn: 331834
Diffstat (limited to 'clang/lib/AST/CommentBriefParser.cpp')
-rw-r--r-- | clang/lib/AST/CommentBriefParser.cpp | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/clang/lib/AST/CommentBriefParser.cpp b/clang/lib/AST/CommentBriefParser.cpp index eecea8fc11d..5ec7586a475 100644 --- a/clang/lib/AST/CommentBriefParser.cpp +++ b/clang/lib/AST/CommentBriefParser.cpp @@ -122,8 +122,8 @@ std::string BriefParser::Parse() { if (Tok.is(tok::newline)) { ConsumeToken(); // We found a paragraph end. This ends the brief description if - // \\brief command or its equivalent was explicitly used. - // Stop scanning text because an explicit \\brief paragraph is the + // \command or its equivalent was explicitly used. + // Stop scanning text because an explicit \paragraph is the // preffered one. if (InBrief) break; |