From 3abe6ea44a9206bda3f4b1eade8bde2a83ceaa91 Mon Sep 17 00:00:00 2001
From: Chandler Carruth <chandlerc@gmail.com>
Date: Wed, 14 Jan 2015 03:55:58 +0000
Subject: [PATCH] [dom] Clean up some comments in this header that were
confusingly formatted or placed incorrectly.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@225937 91177308-0d34-0410-b5e6-96231b3b80d8
---
include/llvm/Support/GenericDomTree.h | 16 +++++++---------
1 file changed, 7 insertions(+), 9 deletions(-)
diff --git a/include/llvm/Support/GenericDomTree.h b/include/llvm/Support/GenericDomTree.h
index 6bc4b4425e7..12a1f5d6178 100644
--- a/include/llvm/Support/GenericDomTree.h
+++ b/include/llvm/Support/GenericDomTree.h
@@ -29,10 +29,8 @@
namespace llvm {
-//===----------------------------------------------------------------------===//
-/// DominatorBase - Base class that other, more interesting dominator analyses
+/// \brief Base class that other, more interesting dominator analyses
/// inherit from.
-///
template <class NodeT>
class DominatorBase {
protected:
@@ -54,11 +52,10 @@ public:
};
-//===----------------------------------------------------------------------===//
-// DomTreeNodeBase - Dominator Tree Node
template<class NodeT> class DominatorTreeBase;
struct PostDominatorTree;
+/// \brief Base class for the actual dominator tree node.
template <class NodeT>
class DomTreeNodeBase {
NodeT *TheBB;
@@ -169,14 +166,15 @@ inline void PrintDomTree(const DomTreeNodeBase<NodeT> *N, raw_ostream &o,
PrintDomTree<NodeT>(*I, o, Lev+1);
}
-//===----------------------------------------------------------------------===//
-/// DominatorTree - Calculate the immediate dominator tree for a function.
-///
-
+// The calculate routine is provided in a separate header but referenced here.
template<class FuncT, class N>
void Calculate(DominatorTreeBase<typename GraphTraits<N>::NodeType>& DT,
FuncT& F);
+/// \brief Core dominator tree base class.
+///
+/// This class is a generic template over graph nodes. It is instantiated for
+/// various graphs in the LLVM IR or in the code generator.
template<class NodeT>
class DominatorTreeBase : public DominatorBase<NodeT> {
bool dominatedBySlowTreeWalk(const DomTreeNodeBase<NodeT> *A,