Import Geant4 2.0.0 source tree

source/geometry/management/include/G4SolidStore.hh

@@ -5,14 +5,17 @@
 // based on the Program) you indicate your acceptance of this statement,
 // and all its terms.
 //
-// $Id: G4SolidStore.hh,v 1.3 1999/12/15 14:49:51 gunter Exp $
-// GEANT4 tag $Name: geant4-01-01 $
+// $Id: G4SolidStore.hh,v 1.4 2000/04/20 16:49:48 gcosmo Exp $
+// GEANT4 tag $Name: geant4-02-00 $
 //
 // class G4SolidStore
 //
+// Class description:
+//
 // Container for all solids, with functionality derived from
-// G4RWTPtrOrderedVector<T>. The class is `singleton', in that only
-// one can exist, and access is facillitated via G4SolidStore::GetInstance()
+// G4RWTPtrOrderedVector<T>. The class is a `singleton', in that only
+// one can exist, and access is provided via the static method
+// G4SolidStore::GetInstance().
 //
 // All solids should be registered with G4SolidStore, and removed on their
 // destruction. Intended principally for UI browser. The underlying
@@ -21,27 +24,11 @@
 // If much additional functionality is added, should consider containment
 // instead of inheritance for G4RWTPtrOrderedVector<T>
 //
-// Class member functions:
-//
-// static void Register(G4G4VSolid* pSolid)
-//   Add the solid to the collection
-// static void DeRegister(G4G4VSolid* pSolid)
-//   Remove the solid from the collection
-// static G4SolidStore* GetInstance()
-//   Get a ptr to the unique G4SolidStore, creting it if necessary
-//
-// Member functions:
-//
-// [as per RWTPtrOrderedvector]
-//
-// NOTE: Constructor is protected - creation and subsequent access is via
-//       GetInstance
-//
 // Member data:
 //
 // static G4SolidStore*
-//   Ptr to the single G4SolidStore
-//
+//   - Ptr to the single G4SolidStore
+
 // History:
 // 10.07.95 P.Kent Initial version
 
@@ -54,14 +41,24 @@
 
 class G4SolidStore : public G4RWTPtrOrderedVector<G4VSolid>
 {
-  public:
+  public:  // with description
+
     static void Register(G4VSolid* pSolid);
+      // Add the solid to the collection.
     static void DeRegister(G4VSolid* pSolid);
+      // Remove the solid from the collection.
     static G4SolidStore* GetInstance();
+      // Get a ptr to the unique G4SolidStore, creating it if necessary.
+
     virtual ~G4SolidStore();
+      // Default destructor.
+
   protected:
+
     G4SolidStore();
+
   private:
+
     static G4SolidStore* fgInstance;
 };