Standardize header file comments
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@8782 91177308-0d34-0410-b5e6-96231b3b80d8
diff --git a/include/Support/BitSetVector.h b/include/Support/BitSetVector.h
index cdcd52d..fa2598a 100644
--- a/include/Support/BitSetVector.h
+++ b/include/Support/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/Support/Casting.h b/include/Support/Casting.h
index 2815ecd..fc2d4b2 100644
--- a/include/Support/Casting.h
+++ b/include/Support/Casting.h
@@ -1,4 +1,4 @@
-//===-- Support/Casting.h - Allow flexible, checked, casts -------*- C++ -*--=//
+//===-- Support/Casting.h - Allow flexible, checked, casts ------*- C++ -*-===//
//
// This file defines the isa<X>(), cast<X>(), dyn_cast<X>(), cast_or_null<X>(),
// and dyn_cast_or_null<X>() templates.
diff --git a/include/Support/CommandLine.h b/include/Support/CommandLine.h
index 789679e..179bca3 100644
--- a/include/Support/CommandLine.h
+++ b/include/Support/CommandLine.h
@@ -1,4 +1,4 @@
-//===- Support/CommandLine.h - Flexible Command line parser ------*- C++ -*--=//
+//===- Support/CommandLine.h - Flexible Command line parser -----*- C++ -*-===//
//
// This class implements a command line argument processor that is useful when
// creating a tool. It provides a simple, minimalistic interface that is easily
diff --git a/include/Support/DOTGraphTraits.h b/include/Support/DOTGraphTraits.h
index 2371b66..6ffade8 100644
--- a/include/Support/DOTGraphTraits.h
+++ b/include/Support/DOTGraphTraits.h
@@ -1,4 +1,4 @@
-//===-- Support/DotGraphTraits.h - Customize .dot output -------*- C++ -*--===//
+//===-- Support/DotGraphTraits.h - Customize .dot output --------*- C++ -*-===//
//
// This file defines a template class that can be used to customize dot output
// graphs generated by the GraphWriter.h file. The default implementation of
diff --git a/include/Support/DataTypes.h b/include/Support/DataTypes.h
index 84f3c2b..eb93321 100644
--- a/include/Support/DataTypes.h
+++ b/include/Support/DataTypes.h
@@ -1,4 +1,4 @@
-//===-- include/Support/DataTypes.h - Define fixed size types ----*- C++ -*--=//
+//===-- include/Support/DataTypes.h - Define fixed size types ---*- C++ -*-===//
//
// This file contains definitions to figure out the size of _HOST_ data types.
// This file is important because different host OS's define different macros,
diff --git a/include/Support/DepthFirstIterator.h b/include/Support/DepthFirstIterator.h
index 2bb2e68..967a0e1 100644
--- a/include/Support/DepthFirstIterator.h
+++ b/include/Support/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/Support/EquivalenceClasses.h b/include/Support/EquivalenceClasses.h
index 96cfc87..dab5d73 100644
--- a/include/Support/EquivalenceClasses.h
+++ b/include/Support/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 @@
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 @@
}
return EqClass;
-
}
std::map<ElemTy, ElemTy>& getLeaderMap() {
return Elem2ECLeaderMap ;
}
-
};
#endif
diff --git a/include/Support/GraphTraits.h b/include/Support/GraphTraits.h
index 15c285d..e54d963 100644
--- a/include/Support/GraphTraits.h
+++ b/include/Support/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/Support/GraphWriter.h b/include/Support/GraphWriter.h
index 3b7b357..7b21dbf 100644
--- a/include/Support/GraphWriter.h
+++ b/include/Support/GraphWriter.h
@@ -1,4 +1,4 @@
-//===-- Support/GraphWriter.h - Write a graph to a .dot file ---*- C++ -*--===//
+//===-- Support/GraphWriter.h - Write a graph to a .dot file ----*- C++ -*-===//
//
// This file defines a simple interface that can be used to print out generic
// LLVM graphs to ".dot" files. "dot" is a tool that is part of the AT&T
diff --git a/include/Support/HashExtras.h b/include/Support/HashExtras.h
index 44355a4..f648a28 100644
--- a/include/Support/HashExtras.h
+++ b/include/Support/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/Support/MathExtras.h b/include/Support/MathExtras.h
index bfb8855..ea3bba4 100644
--- a/include/Support/MathExtras.h
+++ b/include/Support/MathExtras.h
@@ -1,4 +1,4 @@
-//===-- Support/MathExtras.h - Useful math functions -------------*- C++ -*--=//
+//===-- Support/MathExtras.h - Useful math functions ------------*- C++ -*-===//
//
// This file contains some functions that are useful for math stuff.
//
diff --git a/include/Support/PostOrderIterator.h b/include/Support/PostOrderIterator.h
index d976f08..2e5a0ad 100644
--- a/include/Support/PostOrderIterator.h
+++ b/include/Support/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/Support/STLExtras.h b/include/Support/STLExtras.h
index 348c4e1..012d002 100644
--- a/include/Support/STLExtras.h
+++ b/include/Support/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/Support/SetOperations.h b/include/Support/SetOperations.h
index 3a5e6f2..fe020b8 100644
--- a/include/Support/SetOperations.h
+++ b/include/Support/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/Support/Signals.h b/include/Support/Signals.h
index 1445bd4..218cf99 100644
--- a/include/Support/Signals.h
+++ b/include/Support/Signals.h
@@ -1,4 +1,4 @@
-//===- Support/Signals.h - Signal Handling support -------------*- C++ -*-===//
+//===- Support/Signals.h - Signal Handling support --------------*- C++ -*-===//
//
// This file defines some helpful functions for dealing with the possibility of
// unix signals occuring while your program is running.
diff --git a/include/Support/StringExtras.h b/include/Support/StringExtras.h
index 924f6c3..9233d6c 100644
--- a/include/Support/StringExtras.h
+++ b/include/Support/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/Support/SystemUtils.h b/include/Support/SystemUtils.h
index 26371c9..01c8189 100644
--- a/include/Support/SystemUtils.h
+++ b/include/Support/SystemUtils.h
@@ -1,4 +1,4 @@
-//===- SystemUtils.h - Utilities to do low-level system stuff --*- C++ -*--===//
+//===- SystemUtils.h - Utilities to do low-level system stuff ---*- C++ -*-===//
//
// This file contains functions used to do a variety of low-level, often
// system-specific, tasks.
diff --git a/include/Support/Tree.h b/include/Support/Tree.h
index 928c99b..1557261 100644
--- a/include/Support/Tree.h
+++ b/include/Support/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/Support/TypeInfo.h b/include/Support/TypeInfo.h
index 9884f65..488f56d 100644
--- a/include/Support/TypeInfo.h
+++ b/include/Support/TypeInfo.h
@@ -1,4 +1,4 @@
-//===- Support/TypeInfo.h - Support class for type_info objects --*- C++ -*--=//
+//===- Support/TypeInfo.h - Support class for type_info objects -*- C++ -*-===//
//
// This class makes std::type_info objects behave like first class objects that
// can be put in maps and hashtables. This code is based off of code in the
diff --git a/include/Support/hash_map b/include/Support/hash_map
index b6eda7a..6e1ca2c 100644
--- a/include/Support/hash_map
+++ b/include/Support/hash_map
@@ -1,5 +1,4 @@
//===-- Support/hash_map - "Portable" wrapper around hash_map ---*- C++ -*-===//
-// vim:ft=cpp
//
// This file provides a wrapper around the mysterious <hash_map> header file
// that seems to move around between GCC releases into and out of namespaces at
diff --git a/include/Support/ilist b/include/Support/ilist
index aa6e09c..1468308 100644
--- a/include/Support/ilist
+++ b/include/Support/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