Commit in GeomConverter/src/org/lcsim on MAIN
detector/IGeometryInfo.java+6-51.13 -> 1.14
detector/identifier/IExpandedIdentifier.java+3-31.5 -> 1.6
                   /IIdentifiable.java+301.3 -> 1.4
                   /IIdentifierDictionary.java+2-21.2 -> 1.3
                   /IIdentifierDictionaryManager.java+20-31.2 -> 1.3
                   /IIdentifierField.java+29-21.1 -> 1.2
                   /IIdentifierHelper.java+10-101.3 -> 1.4
                   /IdentifierDictionary.java+2-21.2 -> 1.3
                   /IdentifierDictionaryManager.java+2-21.2 -> 1.3
                   /IdentifierField.java+2-21.1 -> 1.2
                   /IdentifierHelper.java+2-81.6 -> 1.7
                   /IdentifierUtil.java+5-51.2 -> 1.3
detector/material/BetheBlochCalculator.java+1-11.3 -> 1.4
geometry/CylindricalSubdetector.java+21.10 -> 1.11
        /FieldMap.java+2-21.4 -> 1.5
        /Subdetector.java+6-11.19 -> 1.20
geometry/compact/Detector.java+1-11.24 -> 1.25
geometry/segmentation/BarrelCylinderSegmentationBase.java+1-11.2 -> 1.3
                     /GridXYZ.java+4-31.21 -> 1.22
                     /NonprojectiveCylinder.java+4-31.22 -> 1.23
                     /ProjectiveCylinder.java+4-21.24 -> 1.25
                     /ProjectiveZPlane.java+4-21.21 -> 1.22
                     /SegmentationBase.java+4-21.9 -> 1.10
geometry/subdetector/SiTrackerBarrel.java+5-91.11 -> 1.12
material/MaterialCalculator.java+8-31.18 -> 1.19
        /MaterialManager.java+1-11.12 -> 1.13
+160-75
26 modified files
JM: Fix javadoc errors.

GeomConverter/src/org/lcsim/detector
IGeometryInfo.java 1.13 -> 1.14
diff -u -r1.13 -r1.14
--- IGeometryInfo.java	9 May 2007 00:59:57 -0000	1.13
+++ IGeometryInfo.java	11 May 2007 00:21:09 -0000	1.14
@@ -9,7 +9,6 @@
  * 
  * <ul>
  * <li>{@link #getLogicalVolume()} - associated {@link ILogicalVolume}</li>
- * <li>{@link #getLogicalVolumeName()} - name of associated {@link LogicalVolume}</li>
  * <li>{@link #getGlobalToLocal()} - global to local {@link Transform3D}</li>
  * <li>{@link #getLocalToGlobal()} - local to global {@link Transform3D}</li>
  * <li>{@link #getParentToLocal()} - parent to local {@link Transform3D}</li>
@@ -17,12 +16,14 @@
  * <li>{@link #isInside(Hep3Vector)} - check if a global point is inside this geometry</li>
  * </ul>
  *
- * An {@link IDetectorElement} may have an IGeometryInfo, which means that it has support 
- * in the geometry tree.  Those DetectorElements without IGeometryInfo are ghost volumes 
- * that have no geometric correspondence, but fill a logical roll in the detector hierarchy.
+ * An {@link IDetectorElement} may have an {@link IGeometryInfo}, which means that it has a
+ * corresponding node in the geometry tree.  Those DetectorElements without IGeometryInfo 
+ * are ghost volumes that have no geometric correspondence, but may fill a logical roll 
+ * in the detector hierarchy.
  *
  * @author Jeremy McCormick 
- * @author Tim Nelson 
+ * @author Tim Nelson  
+ * @version $Id: IGeometryInfo.java,v 1.14 2007/05/11 00:21:09 jeremy Exp $
  */
 public interface IGeometryInfo 
 {

GeomConverter/src/org/lcsim/detector/identifier
IExpandedIdentifier.java 1.5 -> 1.6
diff -u -r1.5 -r1.6
--- IExpandedIdentifier.java	9 May 2007 00:59:58 -0000	1.5
+++ IExpandedIdentifier.java	11 May 2007 00:21:09 -0000	1.6
@@ -6,11 +6,11 @@
  * An ID that has been unpacked from an {@link IIdentifier}
  * so that individual field values are available by index.
  *
- * Use the appropriate {@link IIdentifierDictionary} to
- * see which indices correspond to which field labels.
+ * Use the associated {@link IIdentifierDictionary} to
+ * see which indices correspond to which field labels. 
  * 
  * @author  jeremym
- * @version $Id: IExpandedIdentifier.java,v 1.5 2007/05/09 00:59:58 jeremy Exp $
+ * @version $Id: IExpandedIdentifier.java,v 1.6 2007/05/11 00:21:09 jeremy Exp $
  */
 
 public interface IExpandedIdentifier

GeomConverter/src/org/lcsim/detector/identifier
IIdentifiable.java 1.3 -> 1.4
diff -u -r1.3 -r1.4
--- IIdentifiable.java	6 May 2007 07:19:09 -0000	1.3
+++ IIdentifiable.java	11 May 2007 00:21:09 -0000	1.4
@@ -1,8 +1,38 @@
 package org.lcsim.detector.identifier;
 
+/**
+ * A mix-in interface for objects that have an associated
+ * 64-bit detector identifier or {@link IIdentifier}.
+ * 
+ * Each {@link IIdentifiable} object can also return the
+ * unpacked {@link IExpandedIdentifier} object and the
+ * {@link IIdentifierHelper} that contains the 
+ * {@link IIdentifierDictionary} for packing and
+ * unpacking identifiers of this object.
+ *  
+ * @author jeremym
+ * @version $Id: IIdentifiable.java,v 1.4 2007/05/11 00:21:09 jeremy Exp $
+ */
 public interface IIdentifiable 
 {
+    /**
+     * Get the {@link IIdentifier} associated with this object.
+     * @return The Identifier.
+     */
     public IIdentifier getIdentifier();
+    
+    /**
+     * Get the {@link IExpandedIdentifier} associated with this object.
+     * Should use {@link IIdentifierHelper} to unpack the 
+     * {@link IIdentifier}.
+     * 
+     * @return The ExpandedIdentifier.
+     */
     public IExpandedIdentifier getExpandedIdentifier();
+    
+    /**
+     * Get the {@link IIdentifierHelper} associated with this object. 
+     * @return The IdentifierHelper.
+     */
     public IIdentifierHelper getIdentifierHelper();
 }

GeomConverter/src/org/lcsim/detector/identifier
IIdentifierDictionary.java 1.2 -> 1.3
diff -u -r1.2 -r1.3
--- IIdentifierDictionary.java	10 May 2007 00:12:24 -0000	1.2
+++ IIdentifierDictionary.java	11 May 2007 00:21:09 -0000	1.3
@@ -3,10 +3,10 @@
 import java.util.Map;
 
 /**
- * COMMENT
+ * Holds the specification for the fields of an identifier.
  *
  * @author Jeremy McCormick
- * @version $Id: IIdentifierDictionary.java,v 1.2 2007/05/10 00:12:24 jeremy Exp $
+ * @version $Id: IIdentifierDictionary.java,v 1.3 2007/05/11 00:21:09 jeremy Exp $
  */
 
 public interface IIdentifierDictionary

GeomConverter/src/org/lcsim/detector/identifier
IIdentifierDictionaryManager.java 1.2 -> 1.3
diff -u -r1.2 -r1.3
--- IIdentifierDictionaryManager.java	10 May 2007 07:55:15 -0000	1.2
+++ IIdentifierDictionaryManager.java	11 May 2007 00:21:09 -0000	1.3
@@ -1,14 +1,31 @@
 package org.lcsim.detector.identifier;
+
 /**
- * COMMENT
+ * A manager for {@link IIdentifierDictionary} objects.
  *
  * @author Jeremy McCormick
- * @version $Id: IIdentifierDictionaryManager.java,v 1.2 2007/05/10 07:55:15 jeremy Exp $
+ * @version $Id: IIdentifierDictionaryManager.java,v 1.3 2007/05/11 00:21:09 jeremy Exp $
  */
 
 public interface IIdentifierDictionaryManager
-{    
+{
+    /**
+     * Get an {@link IIdentifierDictionary} by name.
+     * @param name The name of the IdentifierDictionary.
+     * @return The IdentifierDictionary with matching name.
+     */
     public IIdentifierDictionary getIdentifierDictionary(String name);
+    
+    /**
+     * Add an {@link IIdentifierDictionary}.
+     * @param dict The IdentifierDictionary to be added.
+     */
     public void addIdentifierDictionary(IIdentifierDictionary dict);
+    
+    /**
+     * Clear the list of {@link IIdentifierDictionary}s.
+     */
+    // FIXME: This should probably not be part of the public interface,
+    //        but it is required to be available for DetectorStore.clear().
     public void clear();
 }

GeomConverter/src/org/lcsim/detector/identifier
IIdentifierField.java 1.1 -> 1.2
diff -u -r1.1 -r1.2
--- IIdentifierField.java	2 May 2007 01:58:19 -0000	1.1
+++ IIdentifierField.java	11 May 2007 00:21:09 -0000	1.2
@@ -1,15 +1,42 @@
 package org.lcsim.detector.identifier;
+
 /**
- * COMMENT
+ * Represents a single field in an identifier.
+ * An {@link IIdentifierDictionary} is composed of
+ * an ordered collection of these fields.
  *
  * @author Jeremy McCormick
- * @version $Id: IIdentifierField.java,v 1.1 2007/05/02 01:58:19 jeremy Exp $
+ * @version $Id: IIdentifierField.java,v 1.2 2007/05/11 00:21:09 jeremy Exp $
  */
 public interface IIdentifierField
 {
+    /**
+     * Get the string label associated with this field.
+     * @return The label.
+     */
     public String getLabel();
+    
+    /**
+     * Get the number of bits in this field. 
+     * @return The number of bits in this field.
+     */
     public int getNumberOfBits();
+    
+    /**
+     * Get offset, or starting position, of this field.
+     * @return The offset of the field.
+     */
     public int getOffset();
+    
+    /**
+     * Get a bit mask for this field.
+     * @return The mask for this field.
+     */
     public long getMaskOn();
+    
+    /**
+     * True if field is capable of holding signed values.
+     * @return True if field is signed.
+     */
     public boolean isSigned();
 }
\ No newline at end of file

GeomConverter/src/org/lcsim/detector/identifier
IIdentifierHelper.java 1.3 -> 1.4
diff -u -r1.3 -r1.4
--- IIdentifierHelper.java	10 May 2007 00:12:24 -0000	1.3
+++ IIdentifierHelper.java	11 May 2007 00:21:09 -0000	1.4
@@ -1,8 +1,8 @@
 package org.lcsim.detector.identifier;
 
 /**
- * This class has a reference to a single {@IIdentifierDictionary}
- * that specifies the fields for a 64-bit [log in to unmask]
+ * This class has a reference to a single {@link IIdentifierDictionary}
+ * that specifies the fields for a 64-bit {@link IIdentifier}.
  * 
  * The {{@link #pack(IExpandedIdentifier)} method is used to turn
  * an {@link IExpandedIdentifier} of field values into a compact,
@@ -17,13 +17,13 @@
  * for using an index in the dictionary or a field label to retrieve a single
  * field value.
  * 
- * @see org.lcsim.detector.identifier;
+ * @see org.lcsim.detector.identifier
  * @see IIdentifier
  * @see IExpandedIdentifier
  * @see IIdentifierDictionary
  *
  * @author Jeremy McCormick
- * @version $Id: IIdentifierHelper.java,v 1.3 2007/05/10 00:12:24 jeremy Exp $
+ * @version $Id: IIdentifierHelper.java,v 1.4 2007/05/11 00:21:09 jeremy Exp $
  */
 
 public interface IIdentifierHelper
@@ -45,7 +45,7 @@
     public IIdentifier pack( IExpandedIdentifier id );
         
     /**
-     * Get a single field value using an [log in to unmask] 
+     * Get a single field value using an {@link IIdentifierField}. 
      * 
      * @param compact The compact Identifier.
      * @param desc    The field description.
@@ -91,7 +91,7 @@
     public IIdentifier pack(IExpandedIdentifier id, int startIndex, int endIndex );   
     
     /**
-     * Upack the {@link IIdentifier} into an {@link IExpandedIdentifer}
+     * Upack the {@link IIdentifier} into an {@link IExpandedIdentifier}
      * containing field values.
      * 
      * @param id The Identifier.
@@ -101,11 +101,11 @@
     
     /**
      * 
-     * Upack the {@link IIdentifier} into an {@link IExpandedIdentifer}
+     * Upack the {@link IIdentifier} into an {@link IExpandedIdentifier}
      * containing the fields starting at index start and 
      * unpacking nfields fields.  The {@link IExpandedIdentifier} is
      * padded with zero values to match the full specification in the
-     * [log in to unmask]
+     * {@link IIdentifierDictionary}.
      * 
      * @param id          The identifier.
      * @param startIndex  The start index.
@@ -115,11 +115,11 @@
     public IExpandedIdentifier unpack(IIdentifier id, int startIndex, int endIndex );
  
    /**
-    * Upack the {@link IIdentifier} into an {@link IExpandedIdentifer}
+    * Upack the {@link IIdentifier} into an {@link IExpandedIdentifier}
     * containing the fields starting at index start and 
     * unpacking all fields to the end.  The {@link IExpandedIdentifier} is
     * padded with zero values to match the full specification in the
-    * [log in to unmask]
+    * {@link IIdentifierDictionary}.
     * 
     * @param id          The identifier.
     * @param startIndex  The start field index.

GeomConverter/src/org/lcsim/detector/identifier
IdentifierDictionary.java 1.2 -> 1.3
diff -u -r1.2 -r1.3
--- IdentifierDictionary.java	10 May 2007 00:12:24 -0000	1.2
+++ IdentifierDictionary.java	11 May 2007 00:21:09 -0000	1.3
@@ -5,10 +5,10 @@
 import java.util.Map;
 
 /**
- * COMMENT
+ * Implementation of {@link IIdentifierDictionary}.
  *
  * @author Jeremy McCormick
- * @version $Id: IdentifierDictionary.java,v 1.2 2007/05/10 00:12:24 jeremy Exp $
+ * @version $Id: IdentifierDictionary.java,v 1.3 2007/05/11 00:21:09 jeremy Exp $
  */
 
 public class IdentifierDictionary implements IIdentifierDictionary

GeomConverter/src/org/lcsim/detector/identifier
IdentifierDictionaryManager.java 1.2 -> 1.3
diff -u -r1.2 -r1.3
--- IdentifierDictionaryManager.java	10 May 2007 07:55:15 -0000	1.2
+++ IdentifierDictionaryManager.java	11 May 2007 00:21:09 -0000	1.3
@@ -4,10 +4,10 @@
 import java.util.Map;
 
 /**
- * COMMENT
+ * Implementation of {@link IIdentifierDictionaryManager}.
  *
  * @author Jeremy McCormick
- * @version $Id: IdentifierDictionaryManager.java,v 1.2 2007/05/10 07:55:15 jeremy Exp $
+ * @version $Id: IdentifierDictionaryManager.java,v 1.3 2007/05/11 00:21:09 jeremy Exp $
  */
 
 public class IdentifierDictionaryManager

GeomConverter/src/org/lcsim/detector/identifier
IdentifierField.java 1.1 -> 1.2
diff -u -r1.1 -r1.2
--- IdentifierField.java	2 May 2007 01:58:19 -0000	1.1
+++ IdentifierField.java	11 May 2007 00:21:09 -0000	1.2
@@ -1,10 +1,10 @@
 package org.lcsim.detector.identifier;
 
 /**
- * COMMENT
+ * Implementation of {@link IIdentifierField}.
  *
  * @author Jeremy McCormick
- * @version $Id: IdentifierField.java,v 1.1 2007/05/02 01:58:19 jeremy Exp $
+ * @version $Id: IdentifierField.java,v 1.2 2007/05/11 00:21:09 jeremy Exp $
  */
 
 public class IdentifierField implements IIdentifierField

GeomConverter/src/org/lcsim/detector/identifier
IdentifierHelper.java 1.6 -> 1.7
diff -u -r1.6 -r1.7
--- IdentifierHelper.java	10 May 2007 00:12:24 -0000	1.6
+++ IdentifierHelper.java	11 May 2007 00:21:09 -0000	1.7
@@ -1,17 +1,11 @@
 package org.lcsim.detector.identifier;
 
 /**
- * A helper class for packing {@link IExpandedIdentifier} objects
- * and unpacking {@link IIdentifier} objects using information from
- * an associated {@link IIdentifierDictionary}.
  * 
- * @see IIdentifierDictionary
- * @see IIdentifier
- * @see IExpandedIdentifier
- * @see IdentifierUtil
+ *  Implementation of {@link IIdentifierHelper}.
  *
  * @author Jeremy McCormick
- * @version $Id: IdentifierHelper.java,v 1.6 2007/05/10 00:12:24 jeremy Exp $
+ * @version $Id: IdentifierHelper.java,v 1.7 2007/05/11 00:21:09 jeremy Exp $
  */
 
 public class IdentifierHelper

GeomConverter/src/org/lcsim/detector/identifier
IdentifierUtil.java 1.2 -> 1.3
diff -u -r1.2 -r1.3
--- IdentifierUtil.java	10 May 2007 00:12:24 -0000	1.2
+++ IdentifierUtil.java	11 May 2007 00:21:09 -0000	1.3
@@ -1,11 +1,11 @@
 package org.lcsim.detector.identifier;
 
 /**
- * Identifier utility methods for packing {@IIdentifier}s and 
- * unpacking {@IExpandedIdentifier}s using information from an 
- * [log in to unmask]
+ * Identifier utility methods for packing {@link IIdentifier}s and 
+ * unpacking {@link IExpandedIdentifier}s using information from an 
+ * {@link IIdentifierDictionary}.
  * 
- * Most of the methods in {@IIdentifierHelper} use the static 
+ * Most of the methods in {@link IIdentifierHelper} use the static 
  * utility functions defined here.
  * 
  * @see org.lcsim.detector.identifier
@@ -15,7 +15,7 @@
  * @see IExpandedIdentifier
  *
  * @author Jeremy McCormick
- * @version $Id: IdentifierUtil.java,v 1.2 2007/05/10 00:12:24 jeremy Exp $
+ * @version $Id: IdentifierUtil.java,v 1.3 2007/05/11 00:21:09 jeremy Exp $
  */
 public final class IdentifierUtil
 {

GeomConverter/src/org/lcsim/detector/material
BetheBlochCalculator.java 1.3 -> 1.4
diff -u -r1.3 -r1.4
--- BetheBlochCalculator.java	4 May 2007 10:23:38 -0000	1.3
+++ BetheBlochCalculator.java	11 May 2007 00:21:09 -0000	1.4
@@ -50,7 +50,7 @@
 	/**
 	 * Calculate Bethe-Bloch using an IMaterial.
 	 * 
-	 * @param m
+	 * @param material
 	 * @param p
 	 * @param mass
 	 * @param charge

GeomConverter/src/org/lcsim/geometry
CylindricalSubdetector.java 1.10 -> 1.11
diff -u -r1.10 -r1.11
--- CylindricalSubdetector.java	8 Feb 2006 01:01:38 -0000	1.10
+++ CylindricalSubdetector.java	11 May 2007 00:21:09 -0000	1.11
@@ -6,7 +6,9 @@
  *
  * FIXME: Subdetectors should have a "has a" rather than "is a" relationship to shapes.
  * FIXME: Need Cylinder shape extending Solid.
+ * 
  */
+@Deprecated
 public interface CylindricalSubdetector
 {
     public double getInnerRadius();

GeomConverter/src/org/lcsim/geometry
FieldMap.java 1.4 -> 1.5
diff -u -r1.4 -r1.5
--- FieldMap.java	9 Apr 2007 05:04:28 -0000	1.4
+++ FieldMap.java	11 May 2007 00:21:09 -0000	1.5
@@ -20,7 +20,7 @@
     * requires allocation of a new object on each call, and should therefore not
     * be used if it we be called many times.
     * @param position The position at which the field is requested
-    * @returns The field.
+    * @return The field.
     * @deprecated @use getField(double[], double[])
     */
    public double[] getField(double[] position);
@@ -29,7 +29,7 @@
     * Get the field magnitude and direction at a particular point.
     * @param position The position at which the field is requested.
     * @param field The field. If not <code>null</code> this is passed by reference and updated
-    * @returns The field. This will be the same object passed as field, unless field was <code>null</code>
+    * @return The field. This will be the same object passed as field, unless field was <code>null</code>
     */
    public Hep3Vector getField(Hep3Vector position, BasicHep3Vector field);
    /**

GeomConverter/src/org/lcsim/geometry
Subdetector.java 1.19 -> 1.20
diff -u -r1.19 -r1.20
--- Subdetector.java	2 May 2007 01:58:20 -0000	1.19
+++ Subdetector.java	11 May 2007 00:21:09 -0000	1.20
@@ -15,6 +15,12 @@
     public int getSystemID();
     
     public IDDecoder getIDDecoder();
+    
+    /**
+     * @deprecated Use functionality provided by {@link org.lcsim.detector.IDetectorElement}.
+     * @return The layering.
+     */
+    @Deprecated
     public Layering getLayering();
     public ParameterSet getParameterSet();
     public VisAttributes getVisAttributes();
@@ -27,7 +33,6 @@
     /**
      * 
      * @param localPos
-     * @return
      * @deprecated Use {@link org.lcsim.detector.IGeometryInfo#getLocalToGlobal()}
      */
     @Deprecated

GeomConverter/src/org/lcsim/geometry/compact
Detector.java 1.24 -> 1.25
diff -u -r1.24 -r1.25
--- Detector.java	9 May 2007 20:42:20 -0000	1.24
+++ Detector.java	11 May 2007 00:21:09 -0000	1.25
@@ -162,7 +162,7 @@
     
     /**
      * Get a Subdetector by system ID.
-     * @param system ID
+     * @param sysid The system identifier.
      */    
     public Subdetector getSubdetector(int sysid)
     {

GeomConverter/src/org/lcsim/geometry/segmentation
BarrelCylinderSegmentationBase.java 1.2 -> 1.3
diff -u -r1.2 -r1.3
--- BarrelCylinderSegmentationBase.java	7 Feb 2006 17:10:36 -0000	1.2
+++ BarrelCylinderSegmentationBase.java	11 May 2007 00:21:09 -0000	1.3
@@ -13,7 +13,7 @@
  * implementation.
  * 
  * @author Guilherme Lima
- * @versoin $Id: BarrelCylinderSegmentationBase.java,v 1.1 2005/12/07 10:39:37
+ * @version $Id: BarrelCylinderSegmentationBase.java,v 1.1 2005/12/07 10:39:37
  *          lima Exp $
  */
 public abstract class BarrelCylinderSegmentationBase extends SegmentationBase

GeomConverter/src/org/lcsim/geometry/segmentation
GridXYZ.java 1.21 -> 1.22
diff -u -r1.21 -r1.22
--- GridXYZ.java	22 Jul 2006 00:09:03 -0000	1.21
+++ GridXYZ.java	11 May 2007 00:21:10 -0000	1.22
@@ -70,7 +70,6 @@
      * based on the direction (theta,phi) of the reference cell w.r.t the
      * origin.
      *
-     * @see org.lcsim.geometry.segmentation.SegmentationBase#setID()
      * @return array of cellIDs for the neighbouring cells
      */
     public long[] getNeighbourIDs(int layerRange, int xRange, int yRange)
@@ -357,8 +356,10 @@
      * Return the cell which contains a given point (x,y,z). If point is not
      * contained in this component, zero is returned.
      *
-     * @param x,y,z
-     *            cartesian coordinates of the point
+     * @param x Cartesian X coordinate.
+     * @param y Cartesian Y coordinate.
+     * @param z Cartesian Z coordinate.
+     *            
      * @return ID of cell containing the point (maybe either in absorber or live
      *         material)
      */

GeomConverter/src/org/lcsim/geometry/segmentation
NonprojectiveCylinder.java 1.22 -> 1.23
diff -u -r1.22 -r1.23
--- NonprojectiveCylinder.java	5 Jul 2006 15:30:41 -0000	1.22
+++ NonprojectiveCylinder.java	11 May 2007 00:21:10 -0000	1.23
@@ -131,7 +131,6 @@
      * based on the direction (theta,phi) of the reference cell w.r.t the
      * origin.
      *
-     * @see org.lcsim.geometry.segmentation.SegmentationBase#setID()
      * @return array of cellIDs for the neighbouring cells
      */
     public long[] getNeighbourIDs(int layerRange, int zRange, int phiRange)
@@ -211,8 +210,10 @@
     /**
      * Return the cell which contains a given point (x,y,z), or zero.
      *
-     * @param x,y,z
-     *            cartesian coordinates of the point
+     * @param x Cartesian X coordinate.
+     * @param y Cartesian Y coordinate.
+     * @param z Cartesian Z coordinate.
+     *         
      * @return ID of cell containing the point (maybe either in absorber or live
      *         material)
      */

GeomConverter/src/org/lcsim/geometry/segmentation
ProjectiveCylinder.java 1.24 -> 1.25
diff -u -r1.24 -r1.25
--- ProjectiveCylinder.java	15 Mar 2006 23:47:33 -0000	1.24
+++ ProjectiveCylinder.java	11 May 2007 00:21:10 -0000	1.25
@@ -124,8 +124,10 @@
     /**
      * Return the cell which contains a given point (x,y,z), or zero.
      *
-     * @param x,y,z
-     *            cartesian coordinates of the point
+     * @param x Cartesian X coordinate.
+     * @param y Cartesian Y coordinate.
+     * @param z Cartesian Z coordinate.     
+     * 
      * @return ID of cell containing the point (maybe either in absorber
      *         or live material)
      */

GeomConverter/src/org/lcsim/geometry/segmentation
ProjectiveZPlane.java 1.21 -> 1.22
diff -u -r1.21 -r1.22
--- ProjectiveZPlane.java	15 Mar 2006 23:47:33 -0000	1.21
+++ ProjectiveZPlane.java	11 May 2007 00:21:10 -0000	1.22
@@ -140,8 +140,10 @@
     /**
      * Return the cell which contains a given point (x,y,z), or zero.
      *
-     * @param x,y,z
-     *            cartesian coordinates of the point
+     * @param x Cartesian X coordinate.
+     * @param y Cartesian Y coordinate.
+     * @param z Cartesian Z coordinate.     
+     *            
      * @return ID of cell containing the point (maybe either in absorber or live
      *         material)
      */

GeomConverter/src/org/lcsim/geometry/segmentation
SegmentationBase.java 1.9 -> 1.10
diff -u -r1.9 -r1.10
--- SegmentationBase.java	7 Feb 2006 17:11:25 -0000	1.9
+++ SegmentationBase.java	11 May 2007 00:21:10 -0000	1.10
@@ -34,8 +34,10 @@
     /**
      * Returns the cell which contains a given point (x,y,z).
      * 
-     * @param x,y,z
-     *            cartesian coordinates of the point
+     * @param x Cartesian X coordinate.
+     * @param y Cartesian Y coordinate.
+     * @param z Cartesian Z coordinate.     
+     *
      * @return ID of cell containing the point (maybe either in absorber or live
      *         material), or <em>zero</em> if the point is not inside this
      *         component.

GeomConverter/src/org/lcsim/geometry/subdetector
SiTrackerBarrel.java 1.11 -> 1.12
diff -u -r1.11 -r1.12
--- SiTrackerBarrel.java	4 May 2007 10:23:38 -0000	1.11
+++ SiTrackerBarrel.java	11 May 2007 00:21:10 -0000	1.12
@@ -3,7 +3,6 @@
 import hep.graphics.heprep.HepRep;
 import hep.graphics.heprep.HepRepFactory;
 
-import org.jdom.DataConversionException;
 import org.jdom.Element;
 import org.jdom.JDOMException;
 import org.lcsim.detector.converter.heprep.DetectorElementToHepRepConverter;
@@ -14,19 +13,16 @@
  * which uses the raw XML from the compact description.
  *
  * This class also allows SiTrackerBarrel to be visualized
- * with other the other {@link org.lcsim.geometry.Subdetector}s.
+ * with the other {@link org.lcsim.geometry.Subdetector}s.
  *
  * @see org.lcsim.detector.converter.heprep.DetectorElementToHepRepConverter
- * @see org.lcsim.detector.tracker
+ * @see org.lcsim.detector.tracker.silicon
  *
- * @author jeremym 
- * @author tknelson 
- 
- * @version $Id: SiTrackerBarrel.java,v 1.11 2007/05/04 10:23:38 jeremy Exp $
+ * @author Jeremy McCormick  
+ * @version $Id: SiTrackerBarrel.java,v 1.12 2007/05/11 00:21:10 jeremy Exp $
  */
 public class SiTrackerBarrel extends AbstractTracker
 {
-
 	SiTrackerBarrel(Element node) throws JDOMException
 	{
 		super(node);
@@ -42,4 +38,4 @@
 	{
 		return true;
 	}
-}
+}
\ No newline at end of file

GeomConverter/src/org/lcsim/material
MaterialCalculator.java 1.18 -> 1.19
diff -u -r1.18 -r1.19
--- MaterialCalculator.java	4 May 2007 10:23:39 -0000	1.18
+++ MaterialCalculator.java	11 May 2007 00:21:10 -0000	1.19
@@ -11,9 +11,14 @@
 import org.lcsim.material.MaterialState;
 
 /**
- *
- * @deprecated Use {@link org.lcsim.detector.material.IMaterial} and {@link org.lcsim.detector.material.BetheBlocheCalculator}.
- * @author jeremym
+ * 
+ * Old class for material property calculations.
+ * 
+ * @deprecated Use functionality provided by
+ *             {@link org.lcsim.detector.material.IMaterial} and 
+ *             {@link org.lcsim.detector.material.BetheBlochCalculator}.
+ *             
+ * @author Jeremy McCormick
  */
 @Deprecated
 abstract public class MaterialCalculator

GeomConverter/src/org/lcsim/material
MaterialManager.java 1.12 -> 1.13
diff -u -r1.12 -r1.13
--- MaterialManager.java	2 May 2007 23:44:02 -0000	1.12
+++ MaterialManager.java	11 May 2007 00:21:10 -0000	1.13
@@ -86,7 +86,7 @@
     /**
      * 
      * @param materialName
-     * @return
+     * @return The material with name materialName.
      * @deprecated Bugged!  Please use @link{#MaterialManager.instance().findMaterial()}
      */
     public static Material getMaterial(String materialName)
CVSspam 0.2.8