Import Geant4 2.0.0 source tree

source/geometry/management/include/G4GeometryManager.hh

@@ -5,33 +5,23 @@
 // based on the Program) you indicate your acceptance of this statement,
 // and all its terms.
 //
-// $Id: G4GeometryManager.hh,v 1.2 1999/12/15 14:49:51 gunter Exp $
-// GEANT4 tag $Name: geant4-01-01 $
+// $Id: G4GeometryManager.hh,v 1.3 2000/04/20 16:49:46 gcosmo Exp $
+// GEANT4 tag $Name: geant4-02-00 $
 //
 // class G4GeometryManager
 //
-// A class resposible for high level geometrical functions, and for
+// Class description:
+//
+// A class responsible for high level geometrical functions, and for
 // high level objects in the geometry subdomain.
-// The class is `singleton', with access via G4GeometryManager::GetInstance
-//
-// Member functions:
-//
-// G4bool CloseGeometry(G4bool pOptimise=true);
-//   Close (`lock') the geometry: perform sanity and `completion' checks
-//   and optionally [default=yes] Build optimisation information.
-//  
-// void OpenGeometry();
-//   Open (`unlock') the geometry and remove optimisation information if
-//   present.
-//
-// static G4GeometryManager* GetInstance()
-//   Return ptr to singleton instance of the class.
+// The class is a `singleton', with access via the static method
+// G4GeometryManager::GetInstance().
 //
 // Member data:
 //
-// static G4GeometryManager* fgInstance
-//   Ptr to the unique instance of class
-//
+//   static G4GeometryManager* fgInstance
+//     - Ptr to the unique instance of class
+
 // History:
 // 26.07.95 P.Kent Initial version, incuding optimisation Build
 
@@ -51,14 +41,25 @@
 
 class G4GeometryManager
 {
-public:
+  public: // with description
+  
     G4bool CloseGeometry(G4bool pOptimise=true);
+      // Close (`lock') the geometry: perform sanity and `completion' checks
+      // and optionally [default=yes] build optimisation information.
+    
     void OpenGeometry();
-    static G4GeometryManager* GetInstance();
+      // Open (`unlock') the geometry and remove optimisation information if
+      // present.
+
+    static G4GeometryManager* GetInstance();
+      // Return ptr to singleton instance of the class.
+
+  protected:
 
-protected:
     G4GeometryManager();
-private:
+
+  private:
+
     void BuildOptimisations(const G4bool allOpt);
     void DeleteOptimisations();
 
@@ -67,5 +68,3 @@ private:
 };
 
 #endif
-
-