Import Geant4 1.0.0 source tree

source/interfaces/basic/include/G4UIterminal.hh

@@ -1,12 +1,12 @@
 // This code implementation is the intellectual property of
-// the RD44 GEANT4 collaboration.
+// the GEANT4 collaboration.
 //
 // By copying, distributing or modifying the Program (or any work
 // based on the Program) you indicate your acceptance of this statement,
 // and all its terms.
 //
-// $Id: G4UIterminal.hh,v 1.2 1999/04/13 01:26:25 yhajime Exp $
-// GEANT4 tag $Name: geant4-00-01 $
+// $Id: G4UIterminal.hh,v 1.3.4.1 1999/12/07 20:49:08 gunter Exp $
+// GEANT4 tag $Name: geant4-01-00 $
 //
 
 #ifndef G4UIterminal_h
@@ -16,17 +16,31 @@
 #include "G4UImanager.hh"
 #include <fstream.h>
 
+// class description:
+//
+// This class inherits the class G4UIsession.
+// This is the class to use a character-terminal sesion.
+
 class G4UIterminal : public G4VBasicShell
 {
-  public:
+      public: // with description
       G4UIterminal();
       ~G4UIterminal();
 
       G4UIsession * SessionStart();
+      // A character-terminal session  "terminalSession" is instantiated.
+      // G4cout stream is redirected by default to the constructed instance.
+      // Usage:  G4UIsession * terminalSession = new G4UIterminal;
+      // "terminalSession" is started.
+      // Usage: terminalSession->SessionStart();
+      // "terminalSession"  is deleted.
+      // Usage: delete terminalSession;
+      //
       void PauseSessionStart(G4String);
       G4int ReceiveG4cout(G4String coutString);
       G4int ReceiveG4cerr(G4String cerrString);
-
+      // These methods are implementation of corresponding virtual methods
+      // of G4UIsession class.
   private:
       G4UImanager * UI;
       G4String promptCharacter;