summaryrefslogtreecommitdiff
path: root/include/llvm/ADT
diff options
context:
space:
mode:
authorDuncan P. N. Exon Smith <dexonsmith@apple.com>2014-04-25 18:18:46 +0000
committerDuncan P. N. Exon Smith <dexonsmith@apple.com>2014-04-25 18:18:46 +0000
commit5a6277a2306791a62b264f1b6a05000c07053aec (patch)
treecb850bd65ffe6ac6b8bf5de93eb1c5d018851428 /include/llvm/ADT
parent25c74de50059076d87fda6fe01cb53aea9a3c302 (diff)
downloadllvm-5a6277a2306791a62b264f1b6a05000c07053aec.tar.gz
llvm-5a6277a2306791a62b264f1b6a05000c07053aec.tar.bz2
llvm-5a6277a2306791a62b264f1b6a05000c07053aec.tar.xz
SCC: Doxygen-ize comments, NFC
<rdar://problem/14292693> git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@207251 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'include/llvm/ADT')
-rw-r--r--include/llvm/ADT/SCCIterator.h26
1 files changed, 13 insertions, 13 deletions
diff --git a/include/llvm/ADT/SCCIterator.h b/include/llvm/ADT/SCCIterator.h
index 9273cbedb5..86bef96168 100644
--- a/include/llvm/ADT/SCCIterator.h
+++ b/include/llvm/ADT/SCCIterator.h
@@ -47,7 +47,7 @@ class scc_iterator
typedef typename super::reference reference;
typedef typename super::pointer pointer;
- // Element of VisitStack during DFS.
+ /// Element of VisitStack during DFS.
struct StackElement {
NodeType *Node; ///< The current node pointer.
ChildItTy NextChild; ///< The next child, modified inplace during DFS.
@@ -63,30 +63,30 @@ class scc_iterator
}
};
- // The visit counters used to detect when a complete SCC is on the stack.
- // visitNum is the global counter.
- // nodeVisitNumbers are per-node visit numbers, also used as DFS flags.
+ /// The visit counters used to detect when a complete SCC is on the stack.
+ /// visitNum is the global counter.
+ ///
+ /// nodeVisitNumbers are per-node visit numbers, also used as DFS flags.
unsigned visitNum;
DenseMap<NodeType *, unsigned> nodeVisitNumbers;
- // Stack holding nodes of the SCC.
+ /// Stack holding nodes of the SCC.
std::vector<NodeType *> SCCNodeStack;
- // The current SCC, retrieved using operator*().
+ /// The current SCC, retrieved using operator*().
SccTy CurrentSCC;
-
- // DFS stack, Used to maintain the ordering. The top contains the current
- // node, the next child to visit, and the minimum uplink value of all child
+ /// DFS stack, Used to maintain the ordering. The top contains the current
+ /// node, the next child to visit, and the minimum uplink value of all child
std::vector<StackElement> VisitStack;
- // A single "visit" within the non-recursive DFS traversal.
+ /// A single "visit" within the non-recursive DFS traversal.
void DFSVisitOne(NodeType *N);
- // The stack-based DFS traversal; defined below.
+ /// The stack-based DFS traversal; defined below.
void DFSVisitChildren();
- // Compute the next SCC using the DFS traversal.
+ /// Compute the next SCC using the DFS traversal.
void GetNextSCC();
scc_iterator(NodeType *entryN) : visitNum(0) {
@@ -94,7 +94,7 @@ class scc_iterator
GetNextSCC();
}
- // End is when the DFS stack is empty.
+ /// End is when the DFS stack is empty.
scc_iterator() {}
public: