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/Analysis/CallGraph.h | |
parent | c8ad1ab42f269f29bcf6385446e5b728aff7e4ad (diff) |
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/Analysis/CallGraph.h')
-rw-r--r-- | include/clang/Analysis/CallGraph.h | 20 |
1 files changed, 10 insertions, 10 deletions
diff --git a/include/clang/Analysis/CallGraph.h b/include/clang/Analysis/CallGraph.h index bdcdfecddc..ae0f392ed9 100644 --- a/include/clang/Analysis/CallGraph.h +++ b/include/clang/Analysis/CallGraph.h @@ -34,7 +34,7 @@ class Decl; class DeclContext; class Stmt; -/// \brief The AST-based call graph. +/// The AST-based call graph. /// /// The call graph extends itself with the given declarations by implementing /// the recursive AST visitor, which constructs the graph by visiting the given @@ -55,7 +55,7 @@ public: CallGraph(); ~CallGraph(); - /// \brief Populate the call graph with the functions in the given + /// Populate the call graph with the functions in the given /// declaration. /// /// Recursively walks the declaration to find all the dependent Decls as well. @@ -63,13 +63,13 @@ public: TraverseDecl(D); } - /// \brief Determine if a declaration should be included in the graph. + /// Determine if a declaration should be included in the graph. static bool includeInGraph(const Decl *D); - /// \brief Lookup the node for the given declaration. + /// Lookup the node for the given declaration. CallGraphNode *getNode(const Decl *) const; - /// \brief Lookup the node for the given declaration. If none found, insert + /// Lookup the node for the given declaration. If none found, insert /// one into the graph. CallGraphNode *getOrInsertNode(Decl *); @@ -83,7 +83,7 @@ public: const_iterator begin() const { return FunctionMap.begin(); } const_iterator end() const { return FunctionMap.end(); } - /// \brief Get the number of nodes in the graph. + /// Get the number of nodes in the graph. unsigned size() const { return FunctionMap.size(); } /// \ brief Get the virtual root of the graph, all the functions available @@ -133,10 +133,10 @@ public: bool shouldWalkTypesOfTypeLocs() const { return false; } private: - /// \brief Add the given declaration to the call graph. + /// Add the given declaration to the call graph. void addNodeForDecl(Decl *D, bool IsGlobal); - /// \brief Allocate a new node in the graph. + /// Allocate a new node in the graph. CallGraphNode *allocateNewNode(Decl *); }; @@ -145,10 +145,10 @@ public: using CallRecord = CallGraphNode *; private: - /// \brief The function/method declaration. + /// The function/method declaration. Decl *FD; - /// \brief The list of functions called from this node. + /// The list of functions called from this node. SmallVector<CallRecord, 5> CalledFunctions; public: |