diff options
author | Chris Lattner <sabre@nondot.org> | 2003-09-30 18:37:50 +0000 |
---|---|---|
committer | Chris Lattner <sabre@nondot.org> | 2003-09-30 18:37:50 +0000 |
commit | 48486893f46d2e12e926682a3ecb908716bc66c4 (patch) | |
tree | 1b9df5ccb8bd8eb836403dc9c1b3b42707c2d07d /include | |
parent | f4744498042cc69627b3a0b40fe80d3967179ea4 (diff) |
Standardize header file comments
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@8782 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'include')
106 files changed, 134 insertions, 152 deletions
diff --git a/include/Support/BitSetVector.h b/include/Support/BitSetVector.h index cdcd52d948..fa2598a285 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 2815ecde71..fc2d4b21ea 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 789679e399..179bca378b 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 2371b66407..6ffade878b 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 84f3c2b356..eb933216d8 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 2bb2e68e67..967a0e145a 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 96cfc87a72..dab5d73257 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 @@ 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/Support/GraphTraits.h b/include/Support/GraphTraits.h index 15c285da17..e54d963129 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 3b7b357554..7b21dbf30f 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 44355a48e9..f648a28c09 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 fi |