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 | 647be32c6048e24f90f470c557e850597e5526c3 (patch) | |
tree | 2be5c01566ec82e55fd30ceedef970efd887b4a5 /include/clang/CrossTU | |
parent | c8ad1ab42f269f29bcf6385446e5b728aff7e4ad (diff) | |
download | clang-647be32c6048e24f90f470c557e850597e5526c3.tar.gz |
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
git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@331834 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'include/clang/CrossTU')
-rw-r--r-- | include/clang/CrossTU/CrossTranslationUnit.h | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/include/clang/CrossTU/CrossTranslationUnit.h b/include/clang/CrossTU/CrossTranslationUnit.h index f2a1690250..041f1a8eea 100644 --- a/include/clang/CrossTU/CrossTranslationUnit.h +++ b/include/clang/CrossTU/CrossTranslationUnit.h @@ -62,7 +62,7 @@ private: int LineNo; }; -/// \brief This function parses an index file that determines which +/// This function parses an index file that determines which /// translation unit contains which definition. /// /// The index file format is the following: @@ -75,7 +75,7 @@ parseCrossTUIndex(StringRef IndexPath, StringRef CrossTUDir); std::string createCrossTUIndexString(const llvm::StringMap<std::string> &Index); -/// \brief This class is used for tools that requires cross translation +/// This class is used for tools that requires cross translation /// unit capability. /// /// This class can load function definitions from external AST files. @@ -90,7 +90,7 @@ public: CrossTranslationUnitContext(CompilerInstance &CI); ~CrossTranslationUnitContext(); - /// \brief This function loads a function definition from an external AST + /// This function loads a function definition from an external AST /// file and merge it into the original AST. /// /// This method should only be used on functions that have no definitions in @@ -110,7 +110,7 @@ public: getCrossTUDefinition(const FunctionDecl *FD, StringRef CrossTUDir, StringRef IndexName); - /// \brief This function loads a function definition from an external AST + /// This function loads a function definition from an external AST /// file. /// /// A function definition with the same declaration will be looked up in the @@ -126,17 +126,17 @@ public: StringRef CrossTUDir, StringRef IndexName); - /// \brief This function merges a definition from a separate AST Unit into + /// This function merges a definition from a separate AST Unit into /// the current one which was created by the compiler instance that /// was passed to the constructor. /// /// \return Returns the resulting definition or an error. llvm::Expected<const FunctionDecl *> importDefinition(const FunctionDecl *FD); - /// \brief Get a name to identify a function. + /// Get a name to identify a function. static std::string getLookupName(const NamedDecl *ND); - /// \brief Emit diagnostics for the user for potential configuration errors. + /// Emit diagnostics for the user for potential configuration errors. void emitCrossTUDiagnostics(const IndexError &IE); private: |