[llvm] r225937 - [dom] Clean up some comments in this header that were confusingly

[Chandler Carruth]

Author: chandlerc
Date: Tue Jan 13 21:55:58 2015
New Revision: 225937

URL: http://llvm.org/viewvc/llvm-project?rev=225937&view=rev
Log:
[dom] Clean up some comments in this header that were confusingly
formatted or placed incorrectly.

Modified:
    llvm/trunk/include/llvm/Support/GenericDomTree.h

Modified: llvm/trunk/include/llvm/Support/GenericDomTree.h
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/include/llvm/Support/GenericDomTree.h?rev=225937&r1=225936&r2=225937&view=diff
==============================================================================
--- llvm/trunk/include/llvm/Support/GenericDomTree.h (original)
+++ llvm/trunk/include/llvm/Support/GenericDomTree.h Tue Jan 13 21:55:58 2015
@@ -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 DomTreeNo
     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,