Commit in lcdd on MAIN
include/lcdd/processes/FieldMapTypeProcess.hh+24-31.2 -> 1.3
                      /FieldTypeProcess.hh+26-41.2 -> 1.3
                      /SensitiveDetectorTypeProcess.hh+27-51.2 -> 1.3
                      /calorimeterProcess.hh+22-11.2 -> 1.3
include/lcdd/schema/author.hh+2-31.2 -> 1.3
include/lcdd/util/GDMLWriter.hh+18-21.3 -> 1.4
                 /GDMLWriterMessenger.hh+20-41.2 -> 1.3
                 /NistElementsDump.hh+18-21.3 -> 1.4
                 /StoreInspector.hh+110-241.4 -> 1.5
                 /StringUtil.hh+91-101.3 -> 1.4
                 /Verbose.hh+25-91.2 -> 1.3
src/lcdd/processes/box_dipoleProcess.cc+2-21.2 -> 1.3
                  /calorimeterProcess.cc+2-21.1 -> 1.2
                  /field_map_3dProcess.cc+2-21.2 -> 1.3
                  /rz_field_mapProcess.cc+2-21.1 -> 1.2
                  /scorerProcess.cc+2-21.1 -> 1.2
                  /solenoidProcess.cc+2-21.1 -> 1.2
                  /trackerProcess.cc+2-21.1 -> 1.2
src/lcdd/util/GDMLWriterMessenger.cc+6-61.1 -> 1.2
             /Verbose.cc+2-21.1 -> 1.2
+405-89
20 modified files
add more doxygen doc

lcdd/include/lcdd/processes
FieldMapTypeProcess.hh 1.2 -> 1.3
diff -u -r1.2 -r1.3
--- FieldMapTypeProcess.hh	1 Jul 2013 21:00:42 -0000	1.2
+++ FieldMapTypeProcess.hh	3 Jul 2013 23:33:51 -0000	1.3
@@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/include/lcdd/processes/FieldMapTypeProcess.hh,v 1.2 2013/07/01 21:00:42 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/include/lcdd/processes/FieldMapTypeProcess.hh,v 1.3 2013/07/03 23:33:51 jeremy Exp $
 
 #ifndef LCDD_PROCESSES_FIELDMAPTYPEPROCESS_HH
 #define LCDD_PROCESSES_FIELDMAPTYPEPROCESS_HH 1
@@ -27,40 +27,61 @@
 class FieldMapTypeProcess: public FieldTypeProcess
 {
 public:
+
+    /**
+     * Class constructor.
+     */
     FieldMapTypeProcess(const ProcessingContext* context = 0) :
             FieldTypeProcess(context)
     {
     }
 
+    /**
+     * Class destructor.
+     */
     virtual ~FieldMapTypeProcess()
     {
     }
 
+    /**
+     *
+     */
     virtual const SAXComponentObject* Build() const
     {
         return this;
     }
 
-    /* NO-OP.  Just call up the inheritance chain to FieldTypeProcess. */
+    /*
+     * NO-OP.  Just call up the inheritance chain to FieldTypeProcess.
+     */
     virtual void StartElement(const std::string& name, const ASCIIAttributeList& attrs)
     {
         //    std::cout << "FieldMapTypeProcess::StartElement - " << name << std::endl;
         FieldTypeProcess::StartElement(name, attrs);
     }
 
+    /**
+     *
+     */
     virtual void EndElement(const std::string&)
     {
     }
 
+    /**
+     *
+     */
     virtual void Characters(const std::string&)
     {
     }
 
+    /**
+     *
+     */
     virtual void StackPopNotify(const std::string& name)
     {
         //    std::cout << "FieldMapTypeProcess::StackPopNotify" << std::endl;
         SAXObject** so = Context()->GetTopObject();
-        FieldMapType* fmap = dynamic_cast<FieldMapType*>(m_obj);
+        FieldMapType* fmap = dynamic_cast<FieldMapType*>(_obj);
         fmap->add_content(name, *so);
     }
 };

lcdd/include/lcdd/processes
FieldTypeProcess.hh 1.2 -> 1.3
diff -u -r1.2 -r1.3
--- FieldTypeProcess.hh	1 Jul 2013 21:00:42 -0000	1.2
+++ FieldTypeProcess.hh	3 Jul 2013 23:33:51 -0000	1.3
@@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/include/lcdd/processes/FieldTypeProcess.hh,v 1.2 2013/07/01 21:00:42 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/include/lcdd/processes/FieldTypeProcess.hh,v 1.3 2013/07/03 23:33:51 jeremy Exp $
 
 #ifndef LCDD_PROCESSES_FIELDTYPEPROCESS_HH
 #define LCDD_PROCESSES_FIELDTYPEPROCESS_HH 1
@@ -25,25 +25,38 @@
 class FieldTypeProcess: public SAXStateProcess
 {
 public:
+
+    /**
+     *
+     */
     FieldTypeProcess(const ProcessingContext* context = 0) :
-            SAXStateProcess(context), m_obj(0)
+            SAXStateProcess(context), _obj(0)
     {
     }
 
+    /**
+     *
+     */
     virtual ~FieldTypeProcess()
     {
     }
 
+    /**
+     *
+     */
     virtual const SAXComponentObject* Build() const
     {
         return this;
     }
 
+    /**
+     *
+     */
     virtual void StartElement(const std::string&, const ASCIIAttributeList& attrs)
     {
         //std::cout << "FieldTypeProcess::StartElement: " << name << std::endl;
 
-        FieldType* fld = dynamic_cast<FieldType*>(m_obj);
+        FieldType* fld = dynamic_cast<FieldType*>(_obj);
 
         if (fld) {
 
@@ -57,21 +70,30 @@
         }
     }
 
+    /**
+     *
+     */
     virtual void EndElement(const std::string&)
     {
     }
 
+    /**
+     *
+     */
     virtual void Characters(const std::string&)
     {
     }
 
+    /**
+     *
+     */
     virtual void StackPopNotify(const std::string&)
     {
         //std::cout << "FieldTypeProcess::StackPopNotify" << std::endl;
     }
 
 protected:
-    SAXObject* m_obj;
+    SAXObject* _obj;
 };
 
 #endif

lcdd/include/lcdd/processes
SensitiveDetectorTypeProcess.hh 1.2 -> 1.3
diff -u -r1.2 -r1.3
--- SensitiveDetectorTypeProcess.hh	1 Jul 2013 21:00:42 -0000	1.2
+++ SensitiveDetectorTypeProcess.hh	3 Jul 2013 23:33:51 -0000	1.3
@@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/include/lcdd/processes/SensitiveDetectorTypeProcess.hh,v 1.2 2013/07/01 21:00:42 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/include/lcdd/processes/SensitiveDetectorTypeProcess.hh,v 1.3 2013/07/03 23:33:51 jeremy Exp $
 
 #ifndef LCDD_PROCESSES_SENSITIVEDETECTORTYPEPROCESS_HH
 #define LCDD_PROCESSES_SENSITIVEDETECTORTYPEPROCESS_HH 1
@@ -28,25 +28,38 @@
 class SensitiveDetectorTypeProcess: public SAXStateProcess
 {
 public:
+
+    /**
+     *
+     */
     SensitiveDetectorTypeProcess(const ProcessingContext* context = 0) :
-            SAXStateProcess(context), m_obj(0)
+            SAXStateProcess(context), _obj(0)
     {
     }
 
+    /**
+     *
+     */
     virtual ~SensitiveDetectorTypeProcess()
     {
     }
 
+    /**
+     *
+     */
     virtual const SAXComponentObject* Build() const
     {
         return this;
     }
 
+    /**
+     *
+     */
     virtual void StartElement(const std::string& name, const ASCIIAttributeList& attrs)
     {
         //std::cout << "SensitiveDetectorTypeProcess::StartElement: " << name << std::endl;
 
-        SensitiveDetectorType* sdt = dynamic_cast<SensitiveDetectorType*>(m_obj);
+        SensitiveDetectorType* sdt = dynamic_cast<SensitiveDetectorType*>(_obj);
 
         if (sdt) {
             sdt->set_name(attrs.getValue("name"));
@@ -63,25 +76,34 @@
         }
     }
 
+    /**
+     *
+     */
     virtual void EndElement(const std::string&)
     {
     }
 
+    /**
+     *
+     */
     virtual void Characters(const std::string&)
     {
     }
 
+    /**
+     *
+     */
     virtual void StackPopNotify(const std::string& name)
     {
         SAXObject** so = Context()->GetTopObject();
-        SensitiveDetectorType* sdt = dynamic_cast<SensitiveDetectorType*>(m_obj);
+        SensitiveDetectorType* sdt = dynamic_cast<SensitiveDetectorType*>(_obj);
 
         // just push all content; could be idspecref or segmentation (for cal)
         sdt->add_content(name, *so);
     }
 
 protected:
-    SAXObject* m_obj;
+    SAXObject* _obj;
 
 };
 

lcdd/include/lcdd/processes
calorimeterProcess.hh 1.2 -> 1.3
diff -u -r1.2 -r1.3
--- calorimeterProcess.hh	1 Jul 2013 21:00:42 -0000	1.2
+++ calorimeterProcess.hh	3 Jul 2013 23:33:51 -0000	1.3
@@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/include/lcdd/processes/calorimeterProcess.hh,v 1.2 2013/07/01 21:00:42 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/include/lcdd/processes/calorimeterProcess.hh,v 1.3 2013/07/03 23:33:51 jeremy Exp $
 #ifndef LCDD_PROCESSES_CALORIMETERPROCESS_HH
 #define LCDD_PROCESSES_CALORIMETERPROCESS_HH 1
 
@@ -25,18 +25,39 @@
 class calorimeterProcess: public SensitiveDetectorTypeProcess
 {
 public:
+
+    /**
+     * Class constructor.
+     */
     calorimeterProcess(const ProcessingContext* context = 0);
 
+    /**
+     * Class destructor.
+     */
     virtual ~calorimeterProcess();
 
+    /**
+     * Start element processing.
+     */
     virtual void StartElement(const std::string& name, const ASCIIAttributeList& attrs);
 
+    /**
+     * End element processing.
+     */
     virtual void EndElement(const std::string&);
 
+    /**
+     *
+     */
     virtual void Characters(const std::string&);
 
+    /**
+     *
+     */
     virtual void StackPopNotify(const std::string& name);
 
+    /**
+     */
     virtual const std::string& State() const;
 };
 

lcdd/include/lcdd/schema
author.hh 1.2 -> 1.3
diff -u -r1.2 -r1.3
--- author.hh	1 Jul 2013 21:00:43 -0000	1.2
+++ author.hh	3 Jul 2013 23:33:51 -0000	1.3
@@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/include/lcdd/schema/author.hh,v 1.2 2013/07/01 21:00:43 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/include/lcdd/schema/author.hh,v 1.3 2013/07/03 23:33:51 jeremy Exp $
 
 #ifndef LCDD_SCHEMA_AUTHOR_HH
 #define LCDD_SCHEMA_AUTHOR_HH 1
@@ -8,8 +8,7 @@
 #include "AuthorType.hh"
 
 /**
- @class author
- @brief author element from schema.
+ * The author element from the schema.
  */
 class author: public SAXObject, public AuthorType
 {

lcdd/include/lcdd/util
GDMLWriter.hh 1.3 -> 1.4
diff -u -r1.3 -r1.4
--- GDMLWriter.hh	1 Jul 2013 22:10:34 -0000	1.3
+++ GDMLWriter.hh	3 Jul 2013 23:33:51 -0000	1.4
@@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/include/lcdd/util/GDMLWriter.hh,v 1.3 2013/07/01 22:10:34 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/include/lcdd/util/GDMLWriter.hh,v 1.4 2013/07/03 23:33:51 jeremy Exp $
 #ifndef LCDD_UTIL_GDMLWRITER_HH
 #define LCDD_UTIL_GDMLWRITER_HH 1
 
@@ -7,12 +7,28 @@
 #include <vector>
 
 /**
- * @brief Wrapper for the GDML package's writer.
+ * This class is a wrapper for the GDML package's writer.
  */
 class GDMLWriter
 {
+private:
+    GDMLWriter()
+    {
+    }
+
 public:
+
+    /**
+     * Write the current geometry to an output file.
+     * @param[in] fileName The name of the output file.
+     */
     static void writeCurrentGeometry(const std::string& fileName);
+
+    /**
+     * Write the list of volumes to an output file.
+     * @param[in] fileName The name of the output file.
+     * @param[in] volumes  The list of volumes.
+     */
     static void writeCurrentGeometry(const std::string& fileName, std::vector<std::string> volumes);
 };
 

lcdd/include/lcdd/util
GDMLWriterMessenger.hh 1.2 -> 1.3
diff -u -r1.2 -r1.3
--- GDMLWriterMessenger.hh	1 Jul 2013 21:00:44 -0000	1.2
+++ GDMLWriterMessenger.hh	3 Jul 2013 23:33:51 -0000	1.3
@@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/include/lcdd/util/GDMLWriterMessenger.hh,v 1.2 2013/07/01 21:00:44 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/include/lcdd/util/GDMLWriterMessenger.hh,v 1.3 2013/07/03 23:33:51 jeremy Exp $
 
 #ifndef LCDD_UTIL_GDMLWRITERMESSENGER_HH
 #define LCDD_UTIL_GDMLWRITERMESSENGER_HH 1
@@ -9,26 +9,42 @@
 class G4UIcommand;
 
 /**
- * @brief Messenger for GDMLWriter
+ * The Geant4 messenger class for the GDMLWriter.
  */
 class GDMLWriterMessenger: public G4UImessenger
 {
 
 public:
+
+    /**
+     * Class constructor.
+     */
     GDMLWriterMessenger();
+
+    /**
+     * Class destructor.
+     */
     virtual ~GDMLWriterMessenger();
 
 public:
 
-    void SetNewValue(G4UIcommand *, G4String newVals);
+    /**
+     * Execute UI command.
+     * @param[in] cmd     The command to execute.
+     * @param[in] newVals The command arguments.
+     */
+    void SetNewValue(G4UIcommand* cmd, G4String newVals);
 
 private:
 
+    /**
+     * Define the messenger commands.
+     */
     void defineCommands();
 
 private:
 
-    G4UIcommand* m_dumpGDMLCmd;
+    G4UIcommand* _dumpGDMLCmd;
 };
 // class
 #endif

lcdd/include/lcdd/util
NistElementsDump.hh 1.3 -> 1.4
diff -u -r1.3 -r1.4
--- NistElementsDump.hh	1 Jul 2013 22:10:34 -0000	1.3
+++ NistElementsDump.hh	3 Jul 2013 23:33:51 -0000	1.4
@@ -1,4 +1,4 @@
-// $Id: NistElementsDump.hh,v 1.3 2013/07/01 22:10:34 jeremy Exp $
+// $Id: NistElementsDump.hh,v 1.4 2013/07/03 23:33:51 jeremy Exp $
 
 #ifndef LCDD_UTIL_NISTELEMENTSDUMP_HH
 #define LCDD_UTIL_NISTELEMENTSDUMP_HH 1
@@ -8,23 +8,39 @@
 #include <string>
 
 /**
- * @brief Utility class for dumping NIST element data from Geant4.
+ * This is a utility class for dumping NIST element data from Geant4 to XML output.
  */
 class NistElementsDump
 {
+
 private:
     static std::string abbrevs[];
     static std::string names[];
     static int nelements;
 
 private:
+
+    /**
+     * Class constructor.
+     * Should not be instantiated.
+     */
     NistElementsDump()
     {
         ;
     }
 
 public:
+
+    /**
+     * Write XML for elements to an output file.
+     * @param[in] filename The output file name.
+     */
     static void writeXml(const std::string& filename);
+
+    /**
+     * Print XML for elements to an output stream.
+     * @param[in] out The output stream.
+     */
     static void printXml(std::ostream& out);
 };
 

lcdd/include/lcdd/util
StoreInspector.hh 1.4 -> 1.5
diff -u -r1.4 -r1.5
--- StoreInspector.hh	1 Jul 2013 22:10:34 -0000	1.4
+++ StoreInspector.hh	3 Jul 2013 23:33:51 -0000	1.5
@@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/include/lcdd/util/StoreInspector.hh,v 1.4 2013/07/01 22:10:34 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/include/lcdd/util/StoreInspector.hh,v 1.5 2013/07/03 23:33:51 jeremy Exp $
 
 #ifndef LCDD_UTIL_STOREINSPECTOR_HH
 #define LCDD_UTIL_STOREINSPECTOR_HH 1
@@ -55,7 +55,9 @@
 
 public:
 
-    /** ctor */
+    /**
+     * Class constructor.
+     */
     StoreInspector(const std::string& name, const ObjectContainer* container) :
             G4UImessenger()
     {
@@ -65,7 +67,12 @@
         defineCommands();
     }
 
-    /* Overloaded find for vector. */
+    /**
+     * Find an object by name in the list.
+     * @param[in] name   The name of the object.
+     * @param[in] objVec The list of objects.
+     * @return The object with name or 0 if doesn't exist.
+     */
     Object* findByName(const std::string& name, const std::vector<Object*>* objVec)
     {
         Object* obj = 0;
@@ -78,51 +85,83 @@
         return obj;
     }
 
-    /* Overloaded find for map. */
+    /*
+     * Find an object by name in a map.
+     * @param[in] name   The name of the object.
+     * @param[in] objMap The object map.
+     * @return The object with name or 0 if doesn't exist.
+     */
     Object* findByName(const std::string& name, const std::map<std::string, Object*>* objMap)
     {
         std::map<std::string, Object*>* objMap_nconst = const_cast<std::map<std::string, Object*>*>(objMap);
         return (*objMap_nconst)[name];
     }
 
-    /* Simple name comparison returning true if the strings match. */
+    /**
+     * Compare an object name.
+     * @param[in] obj  The object.
+     * @param[in] name The name to compare.
+     * @return True if names are the same; false if not.
+     */
     bool sameName(Object* obj, const std::string& name)
     {
         return (((std::string) obj->GetName()) == name);
     }
 
-    /* Find an object by name. */
+    /**
+     * Find an object by name.
+     * @param[in] name The object name.
+     * @return The object with name or 0 if doesn't exist.
+     */
     Object* find(const std::string& name)
     {
         return findByName(name, const_cast<const ObjectContainer*>(_container));
     }
 
-    /* Object from iterator for maps. */
+    /**
+     * Get an object from a map iterator.
+     * @param[in] it The map iterator.
+     * @return The object from the iterator.
+     */
     Object* getObject(typename std::map<std::string, Object*>::const_iterator it)
     {
         return it->second;
     }
 
-    /* Object from iterator for vectors. */
+    /**
+     * Get an object from a vector iterator.
+     * @param[in] it The vector iterator.
+     * @return The object from the iterator.
+     */
     Object* getObject(typename std::vector<Object*>::const_iterator it)
     {
         return (*it);
     }
 
-    /* Name from iterator for maps. */
+    /**
+     * Get the name of the object from a map iterator.
+     * @param[in] it The map iterator.
+     * @return The name of the object from the iterator.
+     */
     const std::string& getObjectName(typename std::map<std::string, Object*>::const_iterator it)
     {
         return it->first;
     }
 
-    /* Name from iterator for vectors. */
+    /**
+     * Get the name of an object from a vector iterator.
+     * @param[in] it The vector iterator.
+     * @return The object name.
+     */
     const std::string& getObjectName(typename std::vector<Object*>::const_iterator it)
     {
         return (*it)->GetName();
     }
 
     /**
-     * Print out the objects in the store using the stream.
+     * Print the objects in the store to an output stream.
+     * @param[in] os An output stream.
+     * @return The same output stream.
      */
     std::ostream& printStore(std::ostream& os)
     {
@@ -137,6 +176,9 @@
 
     /**
      * Print a single object's name and data using the stream operator.
+     * @param[in] os     An output stream.
+     * @param[in] name   The name of the object.
+     * @param[in] object The object to print.
      */
     std::ostream& printObject(std::ostream& os, const std::string& name, Object* obj)
     {
@@ -145,7 +187,9 @@
         return os;
     }
 
-    /* Defines G4UIcommand to be used with this inspector. */
+    /**
+     * Define commands to be used with this inspector.
+     */
     void defineCommands()
     {
         _dir = new G4UIdirectory(std::string("/stores/" + _name + "/").c_str());
@@ -159,9 +203,11 @@
     }
 
     /**
-     * Hook for the G4UIcommand 'print' on this inspector.
+     * Execute Geant4 UI command on this inspector using its messenger.
+     * @param[in] cmd     The UI command.
+     * @param[in] newVals The command arguments.
      */
-    virtual void SetNewValue(G4UIcommand*, G4String newVals)
+    virtual void SetNewValue(G4UIcommand* cmd, G4String newVals)
     {
         std::string name = (std::string) newVals;
         if (name != std::string("")) {
@@ -184,7 +230,7 @@
 };
 
 /**
- * Declarations of specific types of object store inspectors.
+ * Following are declarations of specific types of object store inspectors:
  */
 typedef StoreInspector<G4Material, G4MaterialTable> G4MaterialStoreInspector;
 typedef StoreInspector<G4VSolid, G4SolidStore> G4SolidStoreInspector;
@@ -198,6 +244,12 @@
 typedef StoreInspector<SensitiveDetector, LCDDProcessor::SensitiveDetectors> G4SensitiveDetectorInspector;
 typedef StoreInspector<G4MagneticField, LCDDProcessor::MagneticFields> G4MagneticFieldInspector;
 
+/**
+ * Overloaded print operator for PhysicsLimitSet.
+ * @param[in] os     An output stream.
+ * @param[in] limset The PhysicsLimitSet to print.
+ * @return The same output stream.
+ */
 std::ostream& operator<<(std::ostream& os, PhysicsLimitSet& limset)
 {
     os << endl;
@@ -232,16 +284,17 @@
     return os;
 }
 
-/* G4LogicalVolume stream operator */
+/**
+ * Overloaded stream operator for G4LogicalVolume.
+ * @param[in] os An output stream.
+ * @param[in] lv The volume to print.
+ * @return The same output stream.
+ */
 std::ostream& operator<<(std::ostream &os, G4LogicalVolume &lv)
 {
     os << "solid: " << lv.GetSolid()->GetName() << endl;
     os << "material: " << lv.GetMaterial()->GetName() << endl;
-
-#ifdef HAVE_G4LOGICALVOLUME_GETMASS
     os << "mass: " << G4BestUnit(lv.GetMass(), "Mass") << endl;
-#endif
-
     os << "daughters: " << lv.GetNoDaughters() << endl;
 
     G4UserLimits* lim = lv.GetUserLimits();
@@ -283,6 +336,12 @@
     return os;
 }
 
+/**
+ * Overloaded print stream operator for G4VPhysicalVolume class.
+ * @param[in] os An output stream.
+ * @param[in] pv The volume to print.
+ * @return The same output stream.
+ */
 std::ostream& operator<<(std::ostream &os, G4VPhysicalVolume &pv)
 {
     os << "lvolume: " << pv.GetLogicalVolume()->GetName() << endl;
@@ -298,7 +357,12 @@
     os << "# copies: " << pv.GetMultiplicity() << endl;
     return os;
 }
-
+/**
+ * Overloaded print stream operator for IdSpec class.
+ * @param[in] os An output stream.
+ * @param[in] id The IdSpec to print.
+ * @return The same output stream.
+ */
 std::ostream& operator<<(std::ostream& os, IdSpec& id)
 {
     os << "# fields: " << id.getNumFields() << endl;
@@ -311,6 +375,12 @@
     return os;
 }
 
+/**
+ * Overloaded print stream operator for SensitiveDetector class.
+ * @param[in] os An output stream.
+ * @param[in] sd The SensitiveDetector to print.
+ * @return The same output stream.
+ */
 std::ostream& operator<<(std::ostream& os, SensitiveDetector& sd)
 {
     os << "fullPath: " << sd.GetFullPathName() << endl;
@@ -324,7 +394,12 @@
     return os;
 }
 
-/* G4Region stream operator */
+/**
+ * Overloaded print stream operator for G4Region class.
+ * @param[in] os  An output stream.
+ * @param[in] reg The region to print.
+ * @return The same output stream.
+ */
 std::ostream& operator<<(std::ostream &os, G4Region &reg)
 {
     os << "prod cut: " << reg.GetProductionCuts()->GetProductionCut(0) << endl;
@@ -338,13 +413,24 @@
     return os;
 }
 
-std::ostream& operator<<(std::ostream& os, G4MagneticField&)
+/**
+ * Overloaded print stream operator for G4MagneticField class.
+ * @param[in] os An output stream.
+ * @param[in] f  The field to print.
+ * @return The same output stream.
+ */
+std::ostream& operator<<(std::ostream& os, G4MagneticField& f)
 {
     /* Generic B-fields have no displayable data attributes! */
     return os;
 }
 
-/* G4VisAttributes stream operator */
+/**
+ * Overloaded print stream operator for G4VisAttribute objects.
+ * @param[in] os  An output stream.
+ * @param[in] vis The G4VisAttributes to print.
+ * @return The same output stream.
+ */
 std::ostream& operator<<(std::ostream& os, G4VisAttributes &vis)
 {
     const G4Color& color = vis.GetColor();

lcdd/include/lcdd/util
StringUtil.hh 1.3 -> 1.4
diff -u -r1.3 -r1.4
--- StringUtil.hh	1 Jul 2013 22:10:34 -0000	1.3
+++ StringUtil.hh	3 Jul 2013 23:33:51 -0000	1.4
@@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/include/lcdd/util/StringUtil.hh,v 1.3 2013/07/01 22:10:34 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/include/lcdd/util/StringUtil.hh,v 1.4 2013/07/03 23:33:51 jeremy Exp $
 
 #ifndef LCDD_UTIL_STRINGUTIL_HH
 #define LCDD_UTIL_STRINGUTIL_HH 1
@@ -9,15 +9,17 @@
 #include <vector>
 
 /**
- * @brief String utilities.
- * @note  Used by both LCDD and SLIC.
+ * A collection of various static string utility functions.
  */
 class StringUtil
 {
 
 private:
 
-    // should not be instantiated
+    /**
+     * Class constructor.
+     * Should not be instantiated.
+     */
     virtual ~StringUtil()
     {
     }
@@ -37,27 +39,106 @@
     static const std::string NULL_STR;
 
 public:
+
+    /**
+     * Convert double value to string.
+     * @param[in] d The double value.
+     * @return The string value.
+     */
     static std::string toString(double d);
+
+    /**
+     * Convert float value to string.
+     * @param[in] f The float value.
+     * @return The string value.
+     */
     static std::string toString(float f);
+
+    /**
+     * Convert int value to string.
+     * @param[in] i The int value.
+     * @return The string value.
+     */
     static std::string toString(int i);
-    static std::string toString(bool b);
 
-    static std::string& toLower(std::string&);
-    static std::string& toLower(const std::string&);
+    /**
+     * Convert bool value to string.
+     * @param[in] b The bool value.
+     * @return The string value.
+     */
+    static std::string toString(bool b);
 
+    /**
+     * Convert string to all lower case.
+     * @param[in] s The string to be converted.
+     * @return The string converted to all lower case.
+     */
+    static std::string& toLower(std::string& s);
+
+    /**
+     * Convert string to all lower case, const version.
+     * @param[in] s The string to be converted.
+     * @return The string converted to all lower case.
+     */
+    static std::string& toLower(const std::string& s);
+
+    /**
+     * Convert string to double value.
+     * @param[in] s The string to be converted.
+     * @return The converted double value.
+     */
     static double toDouble(std::string& s);
+
+    /**
+     * Convert string to double value, const version.
+     * @param[in] s The string to be converted.
+     * @return The converted double value.
+     */
     static double toDouble(const std::string& s);
 
+    /**
+     * Convert string to int value.
+     * @param[in] s The string to be converted.
+     * @return The converted in value.
+     */
     static int toInt(std::string& s);
 
+    /**
+     * Convert string to bool value.
+     * @param[in] s The string to be converted.
+     * @return The converted bool value.
+     */
     static bool toBool(std::string& s);
+
+    /**
+     * Convert string to bool value, const version.
+     * @param[in] s The string to be converted.
+     * @return The converted bool value.
+     */
     static bool toBool(const std::string& s);
 
+    /**
+     * Trim whitespace from string.
+     * @param[out] str Trim whitespace from string, in place.
+     */
     static void trim(std::string& str);
 
-    static std::string concatStrVec(const std::vector<std::string>& s_vec, const std::string& sep = " ");
-
-    static void split(const std::string& str, const std::string& delimiters, std::vector<std::string>& tokens);
+    /**
+     * Concatenate a vector of strings into one string, separated by sep character.
+     * @param[in] strings The vector of strings.
+     * @param[in] sep     The separator between elements.
+     */
+    static std::string concatStrVec(const std::vector<std::string>& strings, const std::string& sep = " ");
+
+    /**
+     * Split a string into tokens based on list of delimiters.
+     * @param[in]  str        The string to be split.
+     * @param[in]  delimiters The list of single character delimiters.
+     * @param[out] tokens     The output list of string tokens.
+     */
+    static void split(const std::string& str,
+            const std::string& delimiters,
+            std::vector<std::string>& tokens);
 };
 
 #endif

lcdd/include/lcdd/util
Verbose.hh 1.2 -> 1.3
diff -u -r1.2 -r1.3
--- Verbose.hh	1 Jul 2013 21:00:44 -0000	1.2
+++ Verbose.hh	3 Jul 2013 23:33:51 -0000	1.3
@@ -1,41 +1,57 @@
-// $Header: /cvs/lcd/lcdd/include/lcdd/util/Verbose.hh,v 1.2 2013/07/01 21:00:44 jeremy Exp $
-
+// $Header: /cvs/lcd/lcdd/include/lcdd/util/Verbose.hh,v 1.3 2013/07/03 23:33:51 jeremy Exp $
 #ifndef LCDD_UTIL_VERBOSE_HH
 #define LCDD_UTIL_VERBOSE_HH 1
 
 /**
- * @brief Mixin class for setting and retrieving verbosity level.
+ * This is a simple mixin class for setting and retrieving verbosity level.
+ * @todo Move code to source file.
  */
 class Verbose
 {
+
 public:
     typedef unsigned int LevelType;
 
 public:
-    Verbose(LevelType lt = m_defaultLevel)
+
+    /**
+     * Class constructor.
+     */
+    Verbose(LevelType lt = _defaultLevel)
     {
-        m_level = lt;
+        _level = lt;
     }
 
+    /**
+     * Class destructor.
+     */
     virtual ~Verbose()
     {
     }
 
 public:
 
+    /**
+     * Get the verbosity level.
+     * @return The verbosity level.
+     */
     virtual inline LevelType verbose() const
     {
-        return m_level;
+        return _level;
     }
 
+    /**
+     * Set the verbosity level.
+     * @param[in] lt The new verbosity level.
+     */
     virtual inline void setVerbose(LevelType lt)
     {
-        m_level = lt;
+        _level = lt;
     }
 
 protected:
-    LevelType m_level;
-    static const LevelType m_defaultLevel;
+    LevelType _level;
+    static const LevelType _defaultLevel;
 };
 
 #endif

lcdd/src/lcdd/processes
box_dipoleProcess.cc 1.2 -> 1.3
diff -u -r1.2 -r1.3
--- box_dipoleProcess.cc	1 Jul 2013 22:10:34 -0000	1.2
+++ box_dipoleProcess.cc	3 Jul 2013 23:33:51 -0000	1.3
@@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/src/lcdd/processes/box_dipoleProcess.cc,v 1.2 2013/07/01 22:10:34 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/src/lcdd/processes/box_dipoleProcess.cc,v 1.3 2013/07/03 23:33:51 jeremy Exp $
 
 // GDML
 #include "Saxana/ProcessingConfigurator.h"
@@ -48,7 +48,7 @@
         x->set_by(attrs.getValue("by"));
         x->set_bz(attrs.getValue("bz"));
 
-        m_obj = x;
+        _obj = x;
         *obj = x;
 
         FieldTypeProcess::StartElement(name, attrs);

lcdd/src/lcdd/processes
calorimeterProcess.cc 1.1 -> 1.2
diff -u -r1.1 -r1.2
--- calorimeterProcess.cc	27 Jun 2013 00:05:57 -0000	1.1
+++ calorimeterProcess.cc	3 Jul 2013 23:33:51 -0000	1.2
@@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/src/lcdd/processes/calorimeterProcess.cc,v 1.1 2013/06/27 00:05:57 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/src/lcdd/processes/calorimeterProcess.cc,v 1.2 2013/07/03 23:33:51 jeremy Exp $
 
 // LCDD
 #include "lcdd/processes/calorimeterProcess.hh"
@@ -19,7 +19,7 @@
 
     cal->set_compare(attrs.getValue("hit_aggregation"));
 
-    m_obj = cal;
+    _obj = cal;
     *obj = cal;
 
     // parent type to set name and hitsCollectionName

lcdd/src/lcdd/processes
field_map_3dProcess.cc 1.2 -> 1.3
diff -u -r1.2 -r1.3
--- field_map_3dProcess.cc	1 Jul 2013 22:10:34 -0000	1.2
+++ field_map_3dProcess.cc	3 Jul 2013 23:33:51 -0000	1.3
@@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/src/lcdd/processes/field_map_3dProcess.cc,v 1.2 2013/07/01 22:10:34 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/src/lcdd/processes/field_map_3dProcess.cc,v 1.3 2013/07/03 23:33:51 jeremy Exp $
 
 // LCDD
 #include "lcdd/processes/FieldMapTypeProcess.hh"
@@ -37,7 +37,7 @@
         fmap->set_filename(attrs.getValue("filename"));
 
         // Top-level caller needs to setup the SAXObject references.
-        m_obj = fmap;
+        _obj = fmap;
         *obj = fmap;
 
         // Call next process UP in inheritance chain, after the SAXObject is set.

lcdd/src/lcdd/processes
rz_field_mapProcess.cc 1.1 -> 1.2
diff -u -r1.1 -r1.2
--- rz_field_mapProcess.cc	27 Jun 2013 00:05:58 -0000	1.1
+++ rz_field_mapProcess.cc	3 Jul 2013 23:33:51 -0000	1.2
@@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/src/lcdd/processes/rz_field_mapProcess.cc,v 1.1 2013/06/27 00:05:58 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/src/lcdd/processes/rz_field_mapProcess.cc,v 1.2 2013/07/03 23:33:51 jeremy Exp $
 
 // LCDD
 #include "lcdd/processes/FieldMapTypeProcess.hh"
@@ -40,7 +40,7 @@
         rzmap->set_grid_size_z(attrs.getValue("grid_size_z"));
 
         /* Top-level caller needs to setup the SAXObject references. */
-        m_obj = rzmap;
+        _obj = rzmap;
         *obj = rzmap;
 
         /* Call next process UP in inheritance chain, after the SAXObject is set. */

lcdd/src/lcdd/processes
scorerProcess.cc 1.1 -> 1.2
diff -u -r1.1 -r1.2
--- scorerProcess.cc	27 Jun 2013 00:05:58 -0000	1.1
+++ scorerProcess.cc	3 Jul 2013 23:33:51 -0000	1.2
@@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/src/lcdd/processes/scorerProcess.cc,v 1.1 2013/06/27 00:05:58 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/src/lcdd/processes/scorerProcess.cc,v 1.2 2013/07/03 23:33:51 jeremy Exp $
 
 // GDML
 #include "Saxana/ProcessingConfigurator.h"
@@ -43,7 +43,7 @@
          scr->set_kill_tracks(attrs.getValue("kill_tracks") );
          */
 
-        m_obj = scr;
+        _obj = scr;
         *obj = scr;
 
         SensitiveDetectorTypeProcess::StartElement(name, attrs);

lcdd/src/lcdd/processes
solenoidProcess.cc 1.1 -> 1.2
diff -u -r1.1 -r1.2
--- solenoidProcess.cc	27 Jun 2013 00:05:58 -0000	1.1
+++ solenoidProcess.cc	3 Jul 2013 23:33:51 -0000	1.2
@@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/src/lcdd/processes/solenoidProcess.cc,v 1.1 2013/06/27 00:05:58 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/src/lcdd/processes/solenoidProcess.cc,v 1.2 2013/07/03 23:33:51 jeremy Exp $
 
 // LCDD
 #include "lcdd/schema/solenoid.hh"
@@ -47,7 +47,7 @@
         sol->set_innerRadius(attrs.getValue("inner_radius"));
         sol->set_outerRadius(attrs.getValue("outer_radius"));
 
-        m_obj = sol;
+        _obj = sol;
         *obj = sol;
 
         FieldTypeProcess::StartElement(name, attrs);

lcdd/src/lcdd/processes
trackerProcess.cc 1.1 -> 1.2
diff -u -r1.1 -r1.2
--- trackerProcess.cc	27 Jun 2013 00:05:58 -0000	1.1
+++ trackerProcess.cc	3 Jul 2013 23:33:51 -0000	1.2
@@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/src/lcdd/processes/trackerProcess.cc,v 1.1 2013/06/27 00:05:58 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/src/lcdd/processes/trackerProcess.cc,v 1.2 2013/07/03 23:33:51 jeremy Exp $
 
 // LCDD
 #include "lcdd/schema/tracker.hh"
@@ -40,7 +40,7 @@
         tracker* trk = new tracker;
         trk->set_combine_hits(attrs.getValue("combine_hits"));
 
-        m_obj = trk;
+        _obj = trk;
         *obj = trk;
 
         SensitiveDetectorTypeProcess::StartElement(name, attrs);

lcdd/src/lcdd/util
GDMLWriterMessenger.cc 1.1 -> 1.2
diff -u -r1.1 -r1.2
--- GDMLWriterMessenger.cc	26 Jun 2013 23:51:02 -0000	1.1
+++ GDMLWriterMessenger.cc	3 Jul 2013 23:33:51 -0000	1.2
@@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/src/lcdd/util/GDMLWriterMessenger.cc,v 1.1 2013/06/26 23:51:02 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/src/lcdd/util/GDMLWriterMessenger.cc,v 1.2 2013/07/03 23:33:51 jeremy Exp $
 
 // LCDD
 #include "lcdd/util/GDMLWriterMessenger.hh"
@@ -35,12 +35,12 @@
 
 void GDMLWriterMessenger::defineCommands()
 {
-    m_dumpGDMLCmd = new G4UIcommand("/lcdd/dumpGDML", this);
-    m_dumpGDMLCmd->SetGuidance("Dump current geometry to GDML output file.");
+    _dumpGDMLCmd = new G4UIcommand("/lcdd/dumpGDML", this);
+    _dumpGDMLCmd->SetGuidance("Dump current geometry to GDML output file.");
     G4UIparameter* p = new G4UIparameter("outputFile", 's', false);
-    m_dumpGDMLCmd->SetParameter(p);
+    _dumpGDMLCmd->SetParameter(p);
     p = new G4UIparameter("topVolume", 's', true);
-    m_dumpGDMLCmd->SetParameter(p);
-    m_dumpGDMLCmd->AvailableForStates(G4State_Idle);
+    _dumpGDMLCmd->SetParameter(p);
+    _dumpGDMLCmd->AvailableForStates(G4State_Idle);
 }
 

lcdd/src/lcdd/util
Verbose.cc 1.1 -> 1.2
diff -u -r1.1 -r1.2
--- Verbose.cc	26 Jun 2013 23:51:02 -0000	1.1
+++ Verbose.cc	3 Jul 2013 23:33:51 -0000	1.2
@@ -1,6 +1,6 @@
-// $Header: /cvs/lcd/lcdd/src/lcdd/util/Verbose.cc,v 1.1 2013/06/26 23:51:02 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/src/lcdd/util/Verbose.cc,v 1.2 2013/07/03 23:33:51 jeremy Exp $
 
 // LCDD
 #include "lcdd/util/Verbose.hh"
 
-const Verbose::LevelType Verbose::m_defaultLevel = 0;
+const Verbose::LevelType Verbose::_defaultLevel = 0;
CVSspam 0.2.12


Use REPLY-ALL to reply to list

To unsubscribe from the LCD-CVS list, click the following link:
https://listserv.slac.stanford.edu/cgi-bin/wa?SUBED1=LCD-CVS&A=1