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/docs/LibFormat.rst | |
parent | cfa98548307264f29ec447e24452117b72bcb517 (diff) | |
download | llvm-9fc8faf9e619733a21915d4c41696f09aa2a7a50.zip llvm-9fc8faf9e619733a21915d4c41696f09aa2a7a50.tar.gz llvm-9fc8faf9e619733a21915d4c41696f09aa2a7a50.tar.bz2 |
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/docs/LibFormat.rst')
-rw-r--r-- | clang/docs/LibFormat.rst | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/clang/docs/LibFormat.rst b/clang/docs/LibFormat.rst index 086a528..2863a07 100644 --- a/clang/docs/LibFormat.rst +++ b/clang/docs/LibFormat.rst @@ -44,11 +44,11 @@ two style guides are hard-coded: .. code-block:: c++ - /// \brief Returns a format style complying with the LLVM coding standards: + /// Returns a format style complying with the LLVM coding standards: /// http://llvm.org/docs/CodingStandards.html. FormatStyle getLLVMStyle(); - /// \brief Returns a format style complying with Google's C++ style guide: + /// Returns a format style complying with Google's C++ style guide: /// http://google-styleguide.googlecode.com/svn/trunk/cppguide.xml. FormatStyle getGoogleStyle(); |