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/tools/libclang/CXString.h | |
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/tools/libclang/CXString.h')
-rw-r--r-- | clang/tools/libclang/CXString.h | 20 |
1 files changed, 10 insertions, 10 deletions
diff --git a/clang/tools/libclang/CXString.h b/clang/tools/libclang/CXString.h index 6473eb2d710..ed192611870 100644 --- a/clang/tools/libclang/CXString.h +++ b/clang/tools/libclang/CXString.h @@ -27,33 +27,33 @@ namespace cxstring { struct CXStringBuf; -/// \brief Create a CXString object for an empty "" string. +/// Create a CXString object for an empty "" string. CXString createEmpty(); -/// \brief Create a CXString object for an NULL string. +/// Create a CXString object for an NULL string. /// /// A NULL string should be used as an "invalid" value in case of errors. CXString createNull(); -/// \brief Create a CXString object from a nul-terminated C string. New +/// Create a CXString object from a nul-terminated C string. New /// CXString may contain a pointer to \p String. /// /// \p String should not be changed by the caller afterwards. CXString createRef(const char *String); -/// \brief Create a CXString object from a nul-terminated C string. New +/// Create a CXString object from a nul-terminated C string. New /// CXString will contain a copy of \p String. /// /// \p String can be changed or freed by the caller. CXString createDup(const char *String); -/// \brief Create a CXString object from a StringRef. New CXString may +/// Create a CXString object from a StringRef. New CXString may /// contain a pointer to the undrelying data of \p String. /// /// \p String should not be changed by the caller afterwards. CXString createRef(StringRef String); -/// \brief Create a CXString object from a StringRef. New CXString will +/// Create a CXString object from a StringRef. New CXString will /// contain a copy of \p String. /// /// \p String can be changed or freed by the caller. @@ -65,12 +65,12 @@ CXString createDup(StringRef String); // If you need to make a copy, call \c createDup(StringRef(String)). CXString createRef(std::string String) = delete; -/// \brief Create a CXString object that is backed by a string buffer. +/// Create a CXString object that is backed by a string buffer. CXString createCXString(CXStringBuf *buf); CXStringSet *createSet(const std::vector<std::string> &Strings); -/// \brief A string pool used for fast allocation/deallocation of strings. +/// A string pool used for fast allocation/deallocation of strings. class CXStringPool { public: ~CXStringPool(); @@ -89,13 +89,13 @@ struct CXStringBuf { CXStringBuf(CXTranslationUnit TU) : TU(TU) {} - /// \brief Return this buffer to the pool. + /// Return this buffer to the pool. void dispose(); }; CXStringBuf *getCXStringBuf(CXTranslationUnit TU); -/// \brief Returns true if the CXString data is managed by a pool. +/// Returns true if the CXString data is managed by a pool. bool isManagedByPool(CXString str); } |