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/CursorVisitor.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/CursorVisitor.h')
-rw-r--r-- | clang/tools/libclang/CursorVisitor.h | 24 |
1 files changed, 12 insertions, 12 deletions
diff --git a/clang/tools/libclang/CursorVisitor.h b/clang/tools/libclang/CursorVisitor.h index 82f251a348f..f2fb68fab95 100644 --- a/clang/tools/libclang/CursorVisitor.h +++ b/clang/tools/libclang/CursorVisitor.h @@ -55,44 +55,44 @@ class CursorVisitor : public DeclVisitor<CursorVisitor, bool>, public TypeLocVisitor<CursorVisitor, bool> { public: - /// \brief Callback called after child nodes of a cursor have been visited. + /// Callback called after child nodes of a cursor have been visited. /// Return true to break visitation or false to continue. typedef bool (*PostChildrenVisitorTy)(CXCursor cursor, CXClientData client_data); private: - /// \brief The translation unit we are traversing. + /// The translation unit we are traversing. CXTranslationUnit TU; ASTUnit *AU; - /// \brief The parent cursor whose children we are traversing. + /// The parent cursor whose children we are traversing. CXCursor Parent; - /// \brief The declaration that serves at the parent of any statement or + /// The declaration that serves at the parent of any statement or /// expression nodes. const Decl *StmtParent; - /// \brief The visitor function. + /// The visitor function. CXCursorVisitor Visitor; PostChildrenVisitorTy PostChildrenVisitor; - /// \brief The opaque client data, to be passed along to the visitor. + /// The opaque client data, to be passed along to the visitor. CXClientData ClientData; - /// \brief Whether we should visit the preprocessing record entries last, + /// Whether we should visit the preprocessing record entries last, /// after visiting other declarations. bool VisitPreprocessorLast; - /// \brief Whether we should visit declarations or preprocessing record + /// Whether we should visit declarations or preprocessing record /// entries that are #included inside the \arg RegionOfInterest. bool VisitIncludedEntities; - /// \brief When valid, a source range to which the cursor should restrict + /// When valid, a source range to which the cursor should restrict /// its search. SourceRange RegionOfInterest; - /// \brief Whether we should only visit declarations and not preprocessing + /// Whether we should only visit declarations and not preprocessing /// record entries. bool VisitDeclsOnly; @@ -110,7 +110,7 @@ private: using DeclVisitor<CursorVisitor, bool>::Visit; using TypeLocVisitor<CursorVisitor, bool>::Visit; - /// \brief Determine whether this particular source range comes before, comes + /// Determine whether this particular source range comes before, comes /// after, or overlaps the region of interest. /// /// \param R a half-open source range retrieved from the abstract syntax tree. @@ -177,7 +177,7 @@ public: bool Visit(CXCursor Cursor, bool CheckedRegionOfInterest = false); - /// \brief Visit declarations and preprocessed entities for the file region + /// Visit declarations and preprocessed entities for the file region /// designated by \see RegionOfInterest. bool visitFileRegion(); |