Import Geant4 10.7.0 source tree

source/intercoms/include/G4UIcmdWith3Vector.hh

@@ -23,46 +23,51 @@
 // * acceptance of all terms of the Geant4 Software license.          *
 // ********************************************************************
 //
+// G4UIcmdWith3Vector
 //
+// Class description:
 //
-//
+// A concrete class of G4UIcommand. The command defined by this class
+// takes three double values.
+// General information of G4UIcommand is given in G4UIcommand.hh
 
-#ifndef G4UIcmdWith3Vector_H
-#define G4UIcmdWith3Vector_H 1
+// Author: M.Asai, 1998
+// --------------------------------------------------------------------
+#ifndef G4UIcmdWith3Vector_hh
+#define G4UIcmdWith3Vector_hh 1
 
 #include "G4UIcommand.hh"
 #include "G4ThreeVector.hh"
 
-// class description:
-//  A concrete class of G4UIcommand. The command defined by this class
-// takes three double values.
-//  General information of G4UIcommand is given in G4UIcommand.hh.
-
 class G4UIcmdWith3Vector : public G4UIcommand
 {
-  public: // with description
-    G4UIcmdWith3Vector
-    (const char * theCommandPath,G4UImessenger * theMessenger);
-    //  Constructor. The command string with full path directory
-    // and the pointer to the messenger must be given.
+  public:
+
+    G4UIcmdWith3Vector(const char* theCommandPath, G4UImessenger* theMessenger);
+      // Constructor. The command string with full path directory
+      // and the pointer to the messenger must be given
+
     static G4ThreeVector GetNew3VectorValue(const char* paramString);
-    //  Convert string which represents three double values to
-    // G4ThreeVector.
-    void SetParameterName(const char * theNameX,const char * theNameY,
-      const char * theNameZ,G4bool omittable,G4bool currentAsDefault=false);
-    //  Set the parameter names for three parameters. Names are used by
-    // the range checking routine.
-    //  If "omittable" is set as true, the user of this command can ommit
-    // the value(s) when he/she applies the command. If "omittable" is false,
-    // the user must supply all three values.
-    //  "currentAsDefault" flag is valid only if "omittable" is true. If this
-    // flag is true, the current values are used as the default values when the 
-    // user ommit some of the parameters. If this flag is false, the values
-    // given by the next SetDefaultValue() method are used. 
+      // Convert string which represents three double values to
+      // G4ThreeVector
+
+    void SetParameterName(const char* theNameX, const char* theNameY,
+                          const char* theNameZ, G4bool omittable,
+                          G4bool currentAsDefault = false);
+      // Set the parameter names for three parameters. Names are used by
+      // the range checking function.
+      // If "omittable" is set as true, the user of this command can omit
+      // the value(s) when the command is applied. If "omittable" is false,
+      // the user must supply all three values.
+      // "currentAsDefault" flag is valid only if "omittable" is true. If this
+      // flag is true, the current values are used as the default values when
+      // the user omits some of the parameters. If this flag is false, the
+      // values given by the next SetDefaultValue() method are used
+
     void SetDefaultValue(G4ThreeVector defVal);
-    //  Set the default values of the parameters. These default values are used
-    // when the user of this command ommits some of the parameter values, and
-    // "ommitable" is true and "currentAsDefault" is false.
+      // Set the default values of the parameters. These default values are
+      // used when the user of this command omits some of the parameter values,
+      // and "omittable" is true and "currentAsDefault" is false
 };
 
 #endif