Standardize header file comments

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@8782 91177308-0d34-0410-b5e6-96231b3b80d8

11 files changed, 22 insertions, 28 deletions

diff --git a/include/llvm/ADT/BitSetVector.h b/include/llvm/ADT/BitSetVector.h
index cdcd52d..fa2598a 100644
--- a/include/llvm/ADT/BitSetVector.h
+++ b/include/llvm/ADT/BitSetVector.h
@@ -1,13 +1,11 @@
-//===-- BitVectorSet.h - A bit-vector representation of sets -----*- C++ -*--=//
+//===-- BitVectorSet.h - A bit-vector representation of sets ----*- C++ -*-===//
 //
-// class BitVectorSet --
-// 
-// An implementation of the bit-vector representation of sets.
-// Unlike vector<bool>, this allows much more efficient parallel set
-// operations on bits, by using the bitset template .  The bitset template
-// unfortunately can only represent sets with a size chosen at compile-time.
-// We therefore use a vector of bitsets.  The maxmimum size of our sets
-// (i.e., the size of the universal set) can be chosen at creation time.
+// This is an implementation of the bit-vector representation of sets.  Unlike
+// vector<bool>, this allows much more efficient parallel set operations on
+// bits, by using the bitset template.  The bitset template unfortunately can
+// only represent sets with a size chosen at compile-time.  We therefore use a
+// vector of bitsets.  The maxmimum size of our sets (i.e., the size of the
+// universal set) can be chosen at creation time.
 //
 // External functions:
 // 
diff --git a/include/llvm/ADT/DepthFirstIterator.h b/include/llvm/ADT/DepthFirstIterator.h
index 2bb2e68..967a0e1 100644
--- a/include/llvm/ADT/DepthFirstIterator.h
+++ b/include/llvm/ADT/DepthFirstIterator.h
@@ -1,4 +1,4 @@
-//===- Support/DepthFirstIterator.h - Depth First iterator -------*- C++ -*--=//
+//===- Support/DepthFirstIterator.h - Depth First iterator ------*- C++ -*-===//
 //
 // This file builds on the Support/GraphTraits.h file to build generic depth
 // first graph iterator.
diff --git a/include/llvm/ADT/EquivalenceClasses.h b/include/llvm/ADT/EquivalenceClasses.h
index 96cfc87..dab5d73 100644
--- a/include/llvm/ADT/EquivalenceClasses.h
+++ b/include/llvm/ADT/EquivalenceClasses.h
@@ -1,12 +1,11 @@
-//===-- Support/EquivalenceClasses.h -------------------------*- C++ -*--=//
+//===-- Support/EquivalenceClasses.h ----------------------------*- C++ -*-===//
 // 
-// Generic implementation of equivalence classes and implementation of 
-// union-find algorithms
-// A not-so-fancy implementation: 2 level tree i.e root and one more level
-// Overhead of a union = size of the equivalence class being attached
-// Overhead of a find = 1.
+// Generic implementation of equivalence classes and implementation of
+// union-find algorithms A not-so-fancy implementation: 2 level tree i.e root
+// and one more level Overhead of a union = size of the equivalence class being
+// attached Overhead of a find = 1.
 // 
-//===------------------------------------------------------------------===//
+//===----------------------------------------------------------------------===//
 
 #ifndef SUPPORT_EQUIVALENCECLASSES_H
 #define SUPPORT_EQUIVALENCECLASSES_H
@@ -68,7 +67,6 @@ public:
       return EqClass;
     
     ElemTy classLeader = Elem2ECLeaderMap[Element1];
-
     for (typename std::map<ElemTy, ElemTy>::iterator ElemI = 
 	   Elem2ECLeaderMap.begin(), ElemE = Elem2ECLeaderMap.end(); 
 	 ElemI != ElemE; ++ElemI) {
@@ -77,13 +75,11 @@ public:
     }
     
     return EqClass;
-    
   }
 
   std::map<ElemTy, ElemTy>& getLeaderMap() {
     return Elem2ECLeaderMap ;
   }
-  
 };
 
 #endif
diff --git a/include/llvm/ADT/GraphTraits.h b/include/llvm/ADT/GraphTraits.h
index 15c285d..e54d963 100644
--- a/include/llvm/ADT/GraphTraits.h
+++ b/include/llvm/ADT/GraphTraits.h
@@ -1,4 +1,4 @@
-//===-- Support/GraphTraits.h - Graph traits template ------------*- C++ -*--=//
+//===-- Support/GraphTraits.h - Graph traits template -----------*- C++ -*-===//
 //
 // This file defines the little GraphTraits<X> template class that should be 
 // specialized by classes that want to be iteratable by generic graph iterators.
diff --git a/include/llvm/ADT/HashExtras.h b/include/llvm/ADT/HashExtras.h
index 44355a4..f648a28 100644
--- a/include/llvm/ADT/HashExtras.h
+++ b/include/llvm/ADT/HashExtras.h
@@ -1,4 +1,4 @@
-//===-- HashExtras.h - Useful functions for STL hash containers --*- C++ -*--=//
+//===-- HashExtras.h - Useful functions for STL hash containers -*- C++ -*-===//
 //
 // This file contains some templates that are useful if you are working with the
 // STL Hashed containers.
diff --git a/include/llvm/ADT/PostOrderIterator.h b/include/llvm/ADT/PostOrderIterator.h
index d976f08..2e5a0ad 100644
--- a/include/llvm/ADT/PostOrderIterator.h
+++ b/include/llvm/ADT/PostOrderIterator.h
@@ -1,4 +1,4 @@
-//===-- Support/PostOrderIterator.h - Generic PostOrder iterator -*- C++ -*--=//
+//===- Support/PostOrderIterator.h - Generic PostOrder iterator -*- C++ -*-===//
 //
 // This file builds on the Support/GraphTraits.h file to build a generic graph
 // post order iterator.  This should work over any graph type that has a
diff --git a/include/llvm/ADT/STLExtras.h b/include/llvm/ADT/STLExtras.h
index 348c4e1..012d002 100644
--- a/include/llvm/ADT/STLExtras.h
+++ b/include/llvm/ADT/STLExtras.h
@@ -1,4 +1,4 @@
-//===-- STLExtras.h - Useful functions when working with the STL -*- C++ -*--=//
+//===- STLExtras.h - Useful functions when working with the STL -*- C++ -*-===//
 //
 // This file contains some templates that are useful if you are working with the
 // STL at all.
diff --git a/include/llvm/ADT/SetOperations.h b/include/llvm/ADT/SetOperations.h
index 3a5e6f2..fe020b8 100644
--- a/include/llvm/ADT/SetOperations.h
+++ b/include/llvm/ADT/SetOperations.h
@@ -1,4 +1,4 @@
-//===-- Support/SetOperations.h - Generic Set Operations ---------*- C++ -*--=//
+//===-- Support/SetOperations.h - Generic Set Operations --------*- C++ -*-===//
 //
 // This file defines generic set operations that may be used on set's of
 // different types, and different element types.
diff --git a/include/llvm/ADT/StringExtras.h b/include/llvm/ADT/StringExtras.h
index 924f6c3..9233d6c 100644
--- a/include/llvm/ADT/StringExtras.h
+++ b/include/llvm/ADT/StringExtras.h
@@ -1,4 +1,4 @@
-//===-- Support/StringExtras.h - Useful string functions ---------*- C++ -*--=//
+//===-- Support/StringExtras.h - Useful string functions --------*- C++ -*-===//
 //
 // This file contains some functions that are useful when dealing with strings.
 //
diff --git a/include/llvm/ADT/Tree.h b/include/llvm/ADT/Tree.h
index 928c99b..1557261 100644
--- a/include/llvm/ADT/Tree.h
+++ b/include/llvm/ADT/Tree.h
@@ -1,4 +1,4 @@
-//===- Support/Tree.h - Generic n-way tree structure -------------*- C++ -*--=//
+//===- Support/Tree.h - Generic n-way tree structure ------------*- C++ -*-===//
 //
 // This class defines a generic N way tree node structure.  The tree structure
 // is immutable after creation, but the payload contained within it is not.
diff --git a/include/llvm/ADT/ilist b/include/llvm/ADT/ilist
index aa6e09c..1468308 100644
--- a/include/llvm/ADT/ilist
+++ b/include/llvm/ADT/ilist
@@ -1,4 +1,4 @@
-//===-- <Support/ilist> - Intrusive Linked List Template ---------*- C++ -*--=//
+//===-- Support/ilist - Intrusive Linked List Template ----------*- C++ -*-===//
 //
 // This file defines classes to implement an intrusive doubly linked list class
 // (ie each node of the list must contain a next and previous field for the