Commit in lcdd on MAIN
include/lcdd/bfield/BoxDipole.hh+31.1 -> 1.2
                   /Cartesian3DMagneticFieldMap.hh+5-61.2 -> 1.3
                   /FieldManager.hh+4-11.1 -> 1.2
                   /MagneticFieldOverlay.hh+7-31.2 -> 1.3
                   /RZBData.hh+2-31.2 -> 1.3
                   /RZFieldMap.hh+2-11.1 -> 1.2
include/lcdd/core/LCDDMessenger.hh+2-31.2 -> 1.3
                 /LCDDParser.hh+2-31.2 -> 1.3
                 /LCDDProcessor.hh+3-41.2 -> 1.3
include/lcdd/detectors/CalorimeterHitProcessor.hh+5-11.2 -> 1.3
                      /CellReadout.hh+4-21.2 -> 1.3
                      /CellReadout2D.hh+3-21.2 -> 1.3
                      /CellReadout2DSegmentation.hh+1-11.2 -> 1.3
                      /Cerenkov.hh+4-11.2 -> 1.3
                      /HitComparator.hh+4-11.2 -> 1.3
                      /PositionComparator.hh+4-11.2 -> 1.3
include/lcdd/geant4/PhysVolIdMap.hh+4-11.2 -> 1.3
include/lcdd/id/IdComparator.hh+4-11.2 -> 1.3
include/lcdd/schema/CellReadout2DSegmentationType.hh+4-11.2 -> 1.3
                   /cell_readout_2d.hh+4-11.2 -> 1.3
include/lcdd/util/GDMLWriter.hh+4-11.2 -> 1.3
                 /NistElementsDump.hh+4-11.2 -> 1.3
                 /StoreInspector.hh+5-41.3 -> 1.4
                 /StringUtil.hh+3-41.2 -> 1.3
src/lcdd/core/GeometryManager.cc+1-21.2 -> 1.3
src/lcdd/processes/box_dipoleProcess.cc+4-11.1 -> 1.2
                  /cell_readout_2dProcess.cc+4-11.1 -> 1.2
                  /field_map_3dProcess.cc+2-21.1 -> 1.2
                  /global_grid_xyProcess.cc+2-31.1 -> 1.2
                  /limitProcess.cc+2-31.1 -> 1.2
                  /limitsetProcess.cc+4-11.1 -> 1.2
                  /limitsetrefProcess.cc+1-31.1 -> 1.2
src/lcdd/subscribers/box_dipoleSubscriber.cc+4-11.2 -> 1.3
                    /field_map_3dSubscriber.cc+3-41.1 -> 1.2
                    /limitsetSubscriber.cc+2-11.2 -> 1.3
+116-69
35 modified files
add doxygen brief class descriptions where missing; also minor cleaup of comments

lcdd/include/lcdd/bfield
BoxDipole.hh 1.1 -> 1.2
diff -u -r1.1 -r1.2
--- BoxDipole.hh	1 Jul 2013 21:00:40 -0000	1.1
+++ BoxDipole.hh	1 Jul 2013 22:10:34 -0000	1.2
@@ -4,6 +4,9 @@
 // Geant4
 #include "G4MagneticField.hh"
 
+/**
+ * @brief This is a magnetic field implementation that assigns a fixed set of B-field components to a box-like region.
+ */
 class BoxDipole: public G4MagneticField
 {
 public:

lcdd/include/lcdd/bfield
Cartesian3DMagneticFieldMap.hh 1.2 -> 1.3
diff -u -r1.2 -r1.3
--- Cartesian3DMagneticFieldMap.hh	1 Jul 2013 21:00:40 -0000	1.2
+++ Cartesian3DMagneticFieldMap.hh	1 Jul 2013 22:10:34 -0000	1.3
@@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/include/lcdd/bfield/Cartesian3DMagneticFieldMap.hh,v 1.2 2013/07/01 21:00:40 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/include/lcdd/bfield/Cartesian3DMagneticFieldMap.hh,v 1.3 2013/07/01 22:10:34 jeremy Exp $
 
 #ifndef LCDD_BFIELD_CARTESIAN3DMAGNETICFIELDMAP_HH
 #define LCDD_BFIELD_CARTESIAN3DMAGNETICFIELDMAP_HH 1
@@ -10,11 +10,10 @@
 #include <vector>
 using std::vector;
 
-//
-// Original PurgMagTabulatedField3D code developed by:
-//  S.Larsson and J. Generowicz.
-//
-
+/**
+ * @brief Original PurgMagTabulatedField3D code developed by: S.Larsson and J. Generowicz.
+ * @author Norman Graf
+ */
 class Cartesian3DMagneticFieldMap: public G4MagneticField
 {
 private:

lcdd/include/lcdd/bfield
FieldManager.hh 1.1 -> 1.2
diff -u -r1.1 -r1.2
--- FieldManager.hh	1 Jul 2013 21:00:40 -0000	1.1
+++ FieldManager.hh	1 Jul 2013 22:10:34 -0000	1.2
@@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/include/lcdd/bfield/FieldManager.hh,v 1.1 2013/07/01 21:00:40 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/include/lcdd/bfield/FieldManager.hh,v 1.2 2013/07/01 22:10:34 jeremy Exp $
 #ifndef LCDD_BFIELD_FIELDMANAGER_HH
 #define LCDD_BFIELD_FIELDMANAGER_HH 1
 
@@ -11,6 +11,9 @@
 
 class LCDDProcessor;
 
+/**
+ * @brief Manages LCDD B-field classes.
+ */
 class FieldManager
 {
 

lcdd/include/lcdd/bfield
MagneticFieldOverlay.hh 1.2 -> 1.3
diff -u -r1.2 -r1.3
--- MagneticFieldOverlay.hh	1 Jul 2013 21:00:40 -0000	1.2
+++ MagneticFieldOverlay.hh	1 Jul 2013 22:10:34 -0000	1.3
@@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/include/lcdd/bfield/MagneticFieldOverlay.hh,v 1.2 2013/07/01 21:00:40 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/include/lcdd/bfield/MagneticFieldOverlay.hh,v 1.3 2013/07/01 22:10:34 jeremy Exp $
 #ifndef LCDD_BFIELD_MAGNETICFIELDOVERLAY_HH
 #define LCDD_BFIELD_MAGNETICFIELDOVERLAY_HH 1
 
@@ -18,10 +18,14 @@
 
 public:
 
-    /** Add a G4MagneticField to the fields vector. */
+    /**
+     * Add a G4MagneticField to the fields vector.
+     */
     void addMagneticField(G4MagneticField* field);
 
-    /** Call GetFieldValue of each field in fields. */
+    /**
+     * Call GetFieldValue of each field in fields.
+     */
     void GetFieldValue(const double Point[3], double *Bfield) const;
 
 private:

lcdd/include/lcdd/bfield
RZBData.hh 1.2 -> 1.3
diff -u -r1.2 -r1.3
--- RZBData.hh	1 Jul 2013 21:00:40 -0000	1.2
+++ RZBData.hh	1 Jul 2013 22:10:34 -0000	1.3
@@ -1,10 +1,9 @@
-// $Header: /cvs/lcd/lcdd/include/lcdd/bfield/RZBData.hh,v 1.2 2013/07/01 21:00:40 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/include/lcdd/bfield/RZBData.hh,v 1.3 2013/07/01 22:10:34 jeremy Exp $
 
 #ifndef LCDD_BFIELD_RZBDATA_HH
 #define LCDD_BFIELD_RZBDATA_HH 1
 
 /**
- * @class RZBData
  * @brief Represents a single row of a magnetic field defined by radius, z dimension, radial B-field strength, and z dimension B-field strength.
  * @note Double values are multiplied by the field unit from the rz_field_map before they are inserted using this class.
  */
@@ -12,7 +11,7 @@
 {
 public:
 
-    /*
+    /**
      * @param r  Radius
      * @param z  Z dimension
      * @param Br Radial field strength

lcdd/include/lcdd/bfield
RZFieldMap.hh 1.1 -> 1.2
diff -u -r1.1 -r1.2
--- RZFieldMap.hh	1 Jul 2013 21:00:40 -0000	1.1
+++ RZFieldMap.hh	1 Jul 2013 22:10:34 -0000	1.2
@@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/include/lcdd/bfield/RZFieldMap.hh,v 1.1 2013/07/01 21:00:40 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/include/lcdd/bfield/RZFieldMap.hh,v 1.2 2013/07/01 22:10:34 jeremy Exp $
 
 #ifndef LCDD_BFIELD_RZFIELDMAP_HH
 #define LCDD_BFIELD_RZFIELDMAP_HH 1
@@ -9,6 +9,7 @@
 // LCDD
 #include "RZBData.hh"
 
+// STL
 #include <iostream>
 #include <vector>
 

lcdd/include/lcdd/core
LCDDMessenger.hh 1.2 -> 1.3
diff -u -r1.2 -r1.3
--- LCDDMessenger.hh	1 Jul 2013 21:00:41 -0000	1.2
+++ LCDDMessenger.hh	1 Jul 2013 22:10:34 -0000	1.3
@@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/include/lcdd/core/LCDDMessenger.hh,v 1.2 2013/07/01 21:00:41 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/include/lcdd/core/LCDDMessenger.hh,v 1.3 2013/07/01 22:10:34 jeremy Exp $
 
 #ifndef LCDD_CORE_LCDDMESSENGER_HH
 #define LCDD_CORE_LCDDMESSENGER_HH 1
@@ -11,8 +11,7 @@
 class LCDDDetectorConstruction;
 
 /**
- @class LCDDMessenger
- @brief G4UImessenger for LCDD commands.
+ * @brief G4UImessenger for LCDD commands.
  */
 class LCDDMessenger: public G4UImessenger
 {

lcdd/include/lcdd/core
LCDDParser.hh 1.2 -> 1.3
diff -u -r1.2 -r1.3
--- LCDDParser.hh	1 Jul 2013 21:00:41 -0000	1.2
+++ LCDDParser.hh	1 Jul 2013 22:10:34 -0000	1.3
@@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/include/lcdd/core/LCDDParser.hh,v 1.2 2013/07/01 21:00:41 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/include/lcdd/core/LCDDParser.hh,v 1.3 2013/07/01 22:10:34 jeremy Exp $
 
 #ifndef LCDD_CORE_LCDDPARSER_HH
 #define LCDD_CORE_LCDDPARSER_HH 1
@@ -10,8 +10,7 @@
 class G4VPhysicalVolume;
 
 /**
- @class LCDDParser
- @brief Parser for LCDD format.
+ * @brief Parser for LCDD format.
  */
 class LCDDParser
 {

lcdd/include/lcdd/core
LCDDProcessor.hh 1.2 -> 1.3
diff -u -r1.2 -r1.3
--- LCDDProcessor.hh	1 Jul 2013 21:00:41 -0000	1.2
+++ LCDDProcessor.hh	1 Jul 2013 22:10:34 -0000	1.3
@@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/include/lcdd/core/LCDDProcessor.hh,v 1.2 2013/07/01 21:00:41 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/include/lcdd/core/LCDDProcessor.hh,v 1.3 2013/07/01 22:10:34 jeremy Exp $
 
 #ifndef LCDD_CORE_LCDDPROCESSOR_HH
 #define LCDD_CORE_LCDDPROCESSOR_HH 1
@@ -19,9 +19,8 @@
 class G4Run;
 
 /**
- @class LCDDProcessor
- @brief Register and find LCDD elements, except idspecs which have own manager.
- @note  This is the LCDD equivalent of the GDMLProcessor class.
+ * @brief Register and find LCDD elements, except idspecs which have own manager.
+ * @note  This is the LCDD equivalent of the GDMLProcessor class.
  */
 class LCDDProcessor
 {

lcdd/include/lcdd/detectors
CalorimeterHitProcessor.hh 1.2 -> 1.3
diff -u -r1.2 -r1.3
--- CalorimeterHitProcessor.hh	1 Jul 2013 21:00:41 -0000	1.2
+++ CalorimeterHitProcessor.hh	1 Jul 2013 22:10:34 -0000	1.3
@@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/include/lcdd/detectors/CalorimeterHitProcessor.hh,v 1.2 2013/07/01 21:00:41 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/include/lcdd/detectors/CalorimeterHitProcessor.hh,v 1.3 2013/07/01 22:10:34 jeremy Exp $
 
 #ifndef LCDD_DETECTORS_CALORIMETERHITPROCESSOR_HH
 #define LCDD_DETECTORS_CALORIMETERHITPROCESSOR_HH 1
@@ -9,6 +9,10 @@
 // LCDD
 #include "lcdd/detectors/CellReadout.hh"
 
+/**
+ * @brief This is a class for use with future infrastructure to separate hit processing from SD classes.
+ * @note  This class is not currently used in the code base.
+ */
 class CalorimeterHitProcessor
 {
 

lcdd/include/lcdd/detectors
CellReadout.hh 1.2 -> 1.3
diff -u -r1.2 -r1.3
--- CellReadout.hh	1 Jul 2013 21:00:41 -0000	1.2
+++ CellReadout.hh	1 Jul 2013 22:10:34 -0000	1.3
@@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/include/lcdd/detectors/CellReadout.hh,v 1.2 2013/07/01 21:00:41 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/include/lcdd/detectors/CellReadout.hh,v 1.3 2013/07/01 22:10:34 jeremy Exp $
 
 #ifndef LCDD_DETECTORS_CELLREADOUT_HH
 #define LCDD_DETECTORS_CELLREADOUT_HH 1
@@ -9,7 +9,9 @@
 #include <string>
 
 /**
- * Pure virtual base class for cell readouts to implement.
+ * @brief This is a pure virtual base class for cell readouts to implement.
+ * @note Not currently usable by the SD classes.
+ * @fixme Move to DDSegmentation package.
  */
 class CellReadout
 {

lcdd/include/lcdd/detectors
CellReadout2D.hh 1.2 -> 1.3
diff -u -r1.2 -r1.3
--- CellReadout2D.hh	1 Jul 2013 21:00:41 -0000	1.2
+++ CellReadout2D.hh	1 Jul 2013 22:10:34 -0000	1.3
@@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/include/lcdd/detectors/CellReadout2D.hh,v 1.2 2013/07/01 21:00:41 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/include/lcdd/detectors/CellReadout2D.hh,v 1.3 2013/07/01 22:10:34 jeremy Exp $
 
 #ifndef LCDD_DETECTORS_CELLREADOUT2D_HH
 #define LCDD_DETECTORS_CELLREADOUT2D_HH 1
@@ -11,7 +11,8 @@
 #include <map>
 
 /**
- *
+ * @brief A concrete implementation of CellReadout using a 2D grid.
+ * @fixme Move to DDSegmentation package.
  */
 class CellReadout2D: public CellReadout
 {

lcdd/include/lcdd/detectors
CellReadout2DSegmentation.hh 1.2 -> 1.3
diff -u -r1.2 -r1.3
--- CellReadout2DSegmentation.hh	1 Jul 2013 21:00:41 -0000	1.2
+++ CellReadout2DSegmentation.hh	1 Jul 2013 22:10:34 -0000	1.3
@@ -11,7 +11,7 @@
 class G4Step;
 
 /**
- * Adapt a CellReadout2D to the LCDD Segmentation interface.
+ * @brief Adapt a CellReadout2D to the LCDD Segmentation interface.
  */
 class CellReadout2DSegmentation: public Segmentation
 {

lcdd/include/lcdd/detectors
Cerenkov.hh 1.2 -> 1.3
diff -u -r1.2 -r1.3
--- Cerenkov.hh	1 Jul 2013 21:00:41 -0000	1.2
+++ Cerenkov.hh	1 Jul 2013 22:10:34 -0000	1.3
@@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/include/lcdd/detectors/Cerenkov.hh,v 1.2 2013/07/01 21:00:41 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/include/lcdd/detectors/Cerenkov.hh,v 1.3 2013/07/01 22:10:34 jeremy Exp $
 
 /* ------------------------------------------------------------------------
  |\___/|       
@@ -28,6 +28,9 @@
 
 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
 
+/**
+ * @brief A physics utility class for use by OpticalCalorimeterSD.
+ */
 class Cerenkov
 {
 public:

lcdd/include/lcdd/detectors
HitComparator.hh 1.2 -> 1.3
diff -u -r1.2 -r1.3
--- HitComparator.hh	1 Jul 2013 21:00:41 -0000	1.2
+++ HitComparator.hh	1 Jul 2013 22:10:34 -0000	1.3
@@ -1,10 +1,13 @@
-// $Header: /cvs/lcd/lcdd/include/lcdd/detectors/HitComparator.hh,v 1.2 2013/07/01 21:00:41 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/include/lcdd/detectors/HitComparator.hh,v 1.3 2013/07/01 22:10:34 jeremy Exp $
 #ifndef LCDD_DETECTORS_HITCOMPARATOR_HH
 #define LCDD_DETECTORS_HITCOMPARATOR_HH 1
 
 // LCDD
 #include "lcdd/hits/CalorimeterHit.hh"
 
+/**
+ * @brief Interface for comparing LCDD CalorimeterHit objects.
+ */
 class HitComparator
 {
 public:

lcdd/include/lcdd/detectors
PositionComparator.hh 1.2 -> 1.3
diff -u -r1.2 -r1.3
--- PositionComparator.hh	1 Jul 2013 21:00:41 -0000	1.2
+++ PositionComparator.hh	1 Jul 2013 22:10:34 -0000	1.3
@@ -1,10 +1,13 @@
-// $Header: /cvs/lcd/lcdd/include/lcdd/detectors/PositionComparator.hh,v 1.2 2013/07/01 21:00:41 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/include/lcdd/detectors/PositionComparator.hh,v 1.3 2013/07/01 22:10:34 jeremy Exp $
 #ifndef LCDD_DETECTORS_POSITIONCOMPARATOR_HH
 #define LCDD_DETECTORS_POSITIONCOMPARATOR_HH 1
 
 // LCDD
 #include "HitComparator.hh"
 
+/**
+ * @brief Compare the positions of two LCDD CalorimeterHit objects.
+ */
 class PositionComparator: public HitComparator
 {
 

lcdd/include/lcdd/geant4
PhysVolIdMap.hh 1.2 -> 1.3
diff -u -r1.2 -r1.3
--- PhysVolIdMap.hh	1 Jul 2013 21:00:42 -0000	1.2
+++ PhysVolIdMap.hh	1 Jul 2013 22:10:34 -0000	1.3
@@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/include/lcdd/geant4/PhysVolIdMap.hh,v 1.2 2013/07/01 21:00:42 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/include/lcdd/geant4/PhysVolIdMap.hh,v 1.3 2013/07/01 22:10:34 jeremy Exp $
 
 #ifndef LCDD_GEANT4_PHYSVOLTOIDMAP_HH
 #define LCDD_GEANT4_PHYSVOLTOIDMAP_HH 1
@@ -18,6 +18,9 @@
  */
 typedef std::map<G4VPhysicalVolume*, PhysVolId::PhysVolIds> PhysVolIdMapType;
 
+/**
+ * @brief Maps pointers of G4VPhysicalVolume objects to PhysVolIds.
+ */
 class PhysVolIdMap: private PhysVolIdMapType
 {
 

lcdd/include/lcdd/id
IdComparator.hh 1.2 -> 1.3
diff -u -r1.2 -r1.3
--- IdComparator.hh	1 Jul 2013 21:00:42 -0000	1.2
+++ IdComparator.hh	1 Jul 2013 22:10:34 -0000	1.3
@@ -1,9 +1,12 @@
-// $Header: /cvs/lcd/lcdd/include/lcdd/id/IdComparator.hh,v 1.2 2013/07/01 21:00:42 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/include/lcdd/id/IdComparator.hh,v 1.3 2013/07/01 22:10:34 jeremy Exp $
 #ifndef LCDD_IDCOMPARATOR_HH
 #define LCDD_IDCOMPARATOR_HH 1
 
 #include "lcdd/detectors/HitComparator.hh"
 
+/**
+ * @brief Compare the IDs of two LCDD CalorimeterHit objects.
+ */
 class IdComparator: public HitComparator
 {
 

lcdd/include/lcdd/schema
CellReadout2DSegmentationType.hh 1.2 -> 1.3
diff -u -r1.2 -r1.3
--- CellReadout2DSegmentationType.hh	1 Jul 2013 21:00:42 -0000	1.2
+++ CellReadout2DSegmentationType.hh	1 Jul 2013 22:10:34 -0000	1.3
@@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/include/lcdd/schema/CellReadout2DSegmentationType.hh,v 1.2 2013/07/01 21:00:42 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/include/lcdd/schema/CellReadout2DSegmentationType.hh,v 1.3 2013/07/01 22:10:34 jeremy Exp $
 
 #ifndef LCDD_CELLREADOUT2DSEGMENTATIONTYPE_HH
 #define LCDD_CELLREADOUT2DSEGMENTATIONTYPE_HH 1
@@ -9,6 +9,9 @@
 // STL
 #include <string>
 
+/**
+ * @brief The class corresponding to CellReadout2DSegmentationType in the XML schema.
+ */
 class CellReadout2DSegmentationType: public SegmentationType
 {
 

lcdd/include/lcdd/schema
cell_readout_2d.hh 1.2 -> 1.3
diff -u -r1.2 -r1.3
--- cell_readout_2d.hh	1 Jul 2013 21:00:43 -0000	1.2
+++ cell_readout_2d.hh	1 Jul 2013 22:10:34 -0000	1.3
@@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/include/lcdd/schema/cell_readout_2d.hh,v 1.2 2013/07/01 21:00:43 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/include/lcdd/schema/cell_readout_2d.hh,v 1.3 2013/07/01 22:10:34 jeremy Exp $
 
 #ifndef LCDD_SCHEMA_CELL_READOUT_2D_HH
 #define LCDD_SCHEMA_CELL_READOUT_2D_HH 1
@@ -9,6 +9,9 @@
 // GDML
 #include "Saxana/SAXObject.h"
 
+/**
+ * @brief The SAX element for cell readout 2D.
+ */
 class cell_readout_2d: public SAXObject, public CellReadout2DSegmentationType
 {
 

lcdd/include/lcdd/util
GDMLWriter.hh 1.2 -> 1.3
diff -u -r1.2 -r1.3
--- GDMLWriter.hh	1 Jul 2013 21:00:44 -0000	1.2
+++ GDMLWriter.hh	1 Jul 2013 22:10:34 -0000	1.3
@@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/include/lcdd/util/GDMLWriter.hh,v 1.2 2013/07/01 21:00:44 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/include/lcdd/util/GDMLWriter.hh,v 1.3 2013/07/01 22:10:34 jeremy Exp $
 #ifndef LCDD_UTIL_GDMLWRITER_HH
 #define LCDD_UTIL_GDMLWRITER_HH 1
 
@@ -6,6 +6,9 @@
 #include <string>
 #include <vector>
 
+/**
+ * @brief Wrapper for the GDML package's writer.
+ */
 class GDMLWriter
 {
 public:

lcdd/include/lcdd/util
NistElementsDump.hh 1.2 -> 1.3
diff -u -r1.2 -r1.3
--- NistElementsDump.hh	1 Jul 2013 21:00:44 -0000	1.2
+++ NistElementsDump.hh	1 Jul 2013 22:10:34 -0000	1.3
@@ -1,4 +1,4 @@
-// $Id: NistElementsDump.hh,v 1.2 2013/07/01 21:00:44 jeremy Exp $
+// $Id: NistElementsDump.hh,v 1.3 2013/07/01 22:10:34 jeremy Exp $
 
 #ifndef LCDD_UTIL_NISTELEMENTSDUMP_HH
 #define LCDD_UTIL_NISTELEMENTSDUMP_HH 1
@@ -7,6 +7,9 @@
 #include <iostream>
 #include <string>
 
+/**
+ * @brief Utility class for dumping NIST element data from Geant4.
+ */
 class NistElementsDump
 {
 private:

lcdd/include/lcdd/util
StoreInspector.hh 1.3 -> 1.4
diff -u -r1.3 -r1.4
--- StoreInspector.hh	1 Jul 2013 21:00:44 -0000	1.3
+++ StoreInspector.hh	1 Jul 2013 22:10:34 -0000	1.4
@@ -1,4 +1,5 @@
-// $Header: /cvs/lcd/lcdd/include/lcdd/util/StoreInspector.hh,v 1.3 2013/07/01 21:00:44 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/include/lcdd/util/StoreInspector.hh,v 1.4 2013/07/01 22:10:34 jeremy Exp $
+
 #ifndef LCDD_UTIL_STOREINSPECTOR_HH
 #define LCDD_UTIL_STOREINSPECTOR_HH 1
 
@@ -41,8 +42,8 @@
 using std::endl;
 
 /**
- * StoreInspector is a templated class for printing the contents
- * of a vector or map-based object store using a G4UIcommand.
+ * @brief StoreInspector is a templated class for printing the contents
+ *        of a Geant4 or LCDD object store using a G4UIcommand.
  */
 template<class Object, class ObjectContainer>
 class StoreInspector: public G4UImessenger
@@ -58,7 +59,7 @@
     StoreInspector(const std::string& name, const ObjectContainer* container) :
             G4UImessenger()
     {
-        assert(container != 0);
+        //assert(container != 0);
         _name = name;
         _container = container;
         defineCommands();

lcdd/include/lcdd/util
StringUtil.hh 1.2 -> 1.3
diff -u -r1.2 -r1.3
--- StringUtil.hh	1 Jul 2013 21:00:44 -0000	1.2
+++ StringUtil.hh	1 Jul 2013 22:10:34 -0000	1.3
@@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/include/lcdd/util/StringUtil.hh,v 1.2 2013/07/01 21:00:44 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/include/lcdd/util/StringUtil.hh,v 1.3 2013/07/01 22:10:34 jeremy Exp $
 
 #ifndef LCDD_UTIL_STRINGUTIL_HH
 #define LCDD_UTIL_STRINGUTIL_HH 1
@@ -9,9 +9,8 @@
 #include <vector>
 
 /**
- @class StringUtil
- @brief String utilities.
- @note  Used by both LCDD and SLIC.
+ * @brief String utilities.
+ * @note  Used by both LCDD and SLIC.
  */
 class StringUtil
 {

lcdd/src/lcdd/core
GeometryManager.cc 1.2 -> 1.3
diff -u -r1.2 -r1.3
--- GeometryManager.cc	1 Jul 2013 21:00:44 -0000	1.2
+++ GeometryManager.cc	1 Jul 2013 22:10:34 -0000	1.3
@@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/src/lcdd/core/GeometryManager.cc,v 1.2 2013/07/01 21:00:44 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/src/lcdd/core/GeometryManager.cc,v 1.3 2013/07/01 22:10:34 jeremy Exp $
 
 // LCDD
 #include "lcdd/core/GeometryManager.hh"
@@ -24,7 +24,6 @@
 GeometryManager::GeometryManager() :
         m_worldRegionIsSetup(false)
 {
-    //G4StoreManager::instance();
 }
 
 GeometryManager::~GeometryManager()

lcdd/src/lcdd/processes
box_dipoleProcess.cc 1.1 -> 1.2
diff -u -r1.1 -r1.2
--- box_dipoleProcess.cc	27 Jun 2013 00:05:57 -0000	1.1
+++ box_dipoleProcess.cc	1 Jul 2013 22:10:34 -0000	1.2
@@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/src/lcdd/processes/box_dipoleProcess.cc,v 1.1 2013/06/27 00:05:57 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/src/lcdd/processes/box_dipoleProcess.cc,v 1.2 2013/07/01 22:10:34 jeremy Exp $
 
 // GDML
 #include "Saxana/ProcessingConfigurator.h"
@@ -16,6 +16,9 @@
 // STL
 #include <iostream>
 
+/**
+ * @brief SAX process for box_dipole element.
+ */
 class box_dipoleProcess: public FieldTypeProcess
 {
 public:

lcdd/src/lcdd/processes
cell_readout_2dProcess.cc 1.1 -> 1.2
diff -u -r1.1 -r1.2
--- cell_readout_2dProcess.cc	27 Jun 2013 00:05:57 -0000	1.1
+++ cell_readout_2dProcess.cc	1 Jul 2013 22:10:34 -0000	1.2
@@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/src/lcdd/processes/cell_readout_2dProcess.cc,v 1.1 2013/06/27 00:05:57 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/src/lcdd/processes/cell_readout_2dProcess.cc,v 1.2 2013/07/01 22:10:34 jeremy Exp $
 
 // GDML
 #include "Saxana/ProcessingConfigurator.h"
@@ -15,6 +15,9 @@
 // STL
 #include <iostream>
 
+/**
+ * @brief The SAX process for cell_readout_2d elements.
+ */
 class cell_readout_2dProcess: public SAXStateProcess
 {
 

lcdd/src/lcdd/processes
field_map_3dProcess.cc 1.1 -> 1.2
diff -u -r1.1 -r1.2
--- field_map_3dProcess.cc	27 Jun 2013 00:05:58 -0000	1.1
+++ field_map_3dProcess.cc	1 Jul 2013 22:10:34 -0000	1.2
@@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/src/lcdd/processes/field_map_3dProcess.cc,v 1.1 2013/06/27 00:05:58 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/src/lcdd/processes/field_map_3dProcess.cc,v 1.2 2013/07/01 22:10:34 jeremy Exp $
 
 // LCDD
 #include "lcdd/processes/FieldMapTypeProcess.hh"
@@ -11,7 +11,7 @@
 #include "globals.hh"
 
 /**
- * @brief
+ * @brief The SAX process for field_map_3d elements.
  */
 class field_map_3dProcess: public FieldMapTypeProcess
 {

lcdd/src/lcdd/processes
global_grid_xyProcess.cc 1.1 -> 1.2
diff -u -r1.1 -r1.2
--- global_grid_xyProcess.cc	27 Jun 2013 00:05:58 -0000	1.1
+++ global_grid_xyProcess.cc	1 Jul 2013 22:10:34 -0000	1.2
@@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/src/lcdd/processes/global_grid_xyProcess.cc,v 1.1 2013/06/27 00:05:58 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/src/lcdd/processes/global_grid_xyProcess.cc,v 1.2 2013/07/01 22:10:34 jeremy Exp $
 
 // GDML
 #include "Saxana/ProcessingConfigurator.h"
@@ -16,8 +16,7 @@
 #include <iostream>
 
 /**
- @class grid_xyzProcess
- @brief SAX process for grid_xyz element.
+ * @brief SAX process for global_grid_xyz elements.
  */
 class global_grid_xyProcess: public SAXStateProcess
 {

lcdd/src/lcdd/processes
limitProcess.cc 1.1 -> 1.2
diff -u -r1.1 -r1.2
--- limitProcess.cc	27 Jun 2013 00:05:58 -0000	1.1
+++ limitProcess.cc	1 Jul 2013 22:10:34 -0000	1.2
@@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/src/lcdd/processes/limitProcess.cc,v 1.1 2013/06/27 00:05:58 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/src/lcdd/processes/limitProcess.cc,v 1.2 2013/07/01 22:10:34 jeremy Exp $
 
 
 // GDML
@@ -14,9 +14,8 @@
 #include "lcdd/schema/limit.hh"
 
 /**
- *
+ * @brief SAX process for limit elements.
  */
-
 class limitProcess: public SAXStateProcess
 {
 

lcdd/src/lcdd/processes
limitsetProcess.cc 1.1 -> 1.2
diff -u -r1.1 -r1.2
--- limitsetProcess.cc	27 Jun 2013 00:05:58 -0000	1.1
+++ limitsetProcess.cc	1 Jul 2013 22:10:34 -0000	1.2
@@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/src/lcdd/processes/limitsetProcess.cc,v 1.1 2013/06/27 00:05:58 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/src/lcdd/processes/limitsetProcess.cc,v 1.2 2013/07/01 22:10:34 jeremy Exp $
 
 // LCDD
 #include "lcdd/schema/limitset.hh"
@@ -16,6 +16,9 @@
 // Geant4
 #include "globals.hh"
 
+/**
+ * @brief SAX process for limitset elements.
+ */
 class limitsetProcess: public SAXStateProcess
 {
 public:

lcdd/src/lcdd/processes
limitsetrefProcess.cc 1.1 -> 1.2
diff -u -r1.1 -r1.2
--- limitsetrefProcess.cc	27 Jun 2013 00:05:58 -0000	1.1
+++ limitsetrefProcess.cc	1 Jul 2013 22:10:34 -0000	1.2
@@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/src/lcdd/processes/limitsetrefProcess.cc,v 1.1 2013/06/27 00:05:58 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/src/lcdd/processes/limitsetrefProcess.cc,v 1.2 2013/07/01 22:10:34 jeremy Exp $
 
 // GDML
 #include "Processes/ReferenceTypeProcess.h"
@@ -23,8 +23,6 @@
 
     virtual void StartElement(const std::string& name, const ASCIIAttributeList& attrs)
     {
-        //std::cout << "limitsetrefProcess" << std::endl;
-
         SAXObject** obj = Context()->GetTopObject();
 
         LimitSetType::limitsetref* lref = new LimitSetType::limitsetref;

lcdd/src/lcdd/subscribers
box_dipoleSubscriber.cc 1.2 -> 1.3
diff -u -r1.2 -r1.3
--- box_dipoleSubscriber.cc	1 Jul 2013 21:00:45 -0000	1.2
+++ box_dipoleSubscriber.cc	1 Jul 2013 22:10:35 -0000	1.3
@@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/src/lcdd/subscribers/box_dipoleSubscriber.cc,v 1.2 2013/07/01 21:00:45 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/src/lcdd/subscribers/box_dipoleSubscriber.cc,v 1.3 2013/07/01 22:10:35 jeremy Exp $
 
 // LCDD
 #include "lcdd/core/LCDDProcessor.hh"
@@ -11,6 +11,9 @@
 #include "G4Processor/GDMLProcessor.h"
 #include "G4Evaluator/GDMLExpressionEvaluator.h"
 
+/**
+ * @brief Instantiate BoxDipole objects from box_dipole SAX elements.
+ */
 class box_dipoleSubscriber: virtual public SAXSubscriber
 {
 

lcdd/src/lcdd/subscribers
field_map_3dSubscriber.cc 1.1 -> 1.2
diff -u -r1.1 -r1.2
--- field_map_3dSubscriber.cc	26 Jun 2013 23:51:02 -0000	1.1
+++ field_map_3dSubscriber.cc	1 Jul 2013 22:10:35 -0000	1.2
@@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/src/lcdd/subscribers/field_map_3dSubscriber.cc,v 1.1 2013/06/26 23:51:02 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/src/lcdd/subscribers/field_map_3dSubscriber.cc,v 1.2 2013/07/01 22:10:35 jeremy Exp $
 
 // lcdd
 #include "lcdd/core/LCDDProcessor.hh"
@@ -13,9 +13,8 @@
 // Geant4
 #include "G4Processor/GDMLProcessor.h"
 
-/*
- * @class
- * @brief
+/**
+ * @brief Instantiates FieldMap3D objects from field_map_3d elements.
  */
 class field_map_3dSubscriber: virtual public SAXSubscriber
 {

lcdd/src/lcdd/subscribers
limitsetSubscriber.cc 1.2 -> 1.3
diff -u -r1.2 -r1.3
--- limitsetSubscriber.cc	1 Jul 2013 21:00:45 -0000	1.2
+++ limitsetSubscriber.cc	1 Jul 2013 22:10:35 -0000	1.3
@@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/src/lcdd/subscribers/limitsetSubscriber.cc,v 1.2 2013/07/01 21:00:45 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/src/lcdd/subscribers/limitsetSubscriber.cc,v 1.3 2013/07/01 22:10:35 jeremy Exp $
 
 // GDML
 #include "Saxana/SAXSubscriber.h"
@@ -19,6 +19,7 @@
 using std::vector;
 
 /**
+ * @brief Instantiates PhysicsLimitSet objects for limitset elements.
  */
 class limitsetSubscriber: virtual public SAXSubscriber
 {
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