Author: [log in to unmask]
Date: Thu Mar 10 18:02:36 2016
New Revision: 4288

Log:
More javadoc fixes.

Modified:
    java/trunk/analysis/src/main/java/org/hps/analysis/ecal/cosmic/RawModeSignalFitDriver.java
    java/trunk/analysis/src/main/java/org/hps/analysis/trigger/data/TriggerEvent.java
    java/trunk/conditions/src/main/java/org/hps/conditions/database/ConditionsTagConverter.java
    java/trunk/detector-model/src/main/java/org/lcsim/geometry/compact/converter/HPSTracker2014GeometryDefinition.java
    java/trunk/ecal-recon/src/main/java/org/hps/recon/ecal/EcalCalibrationsDriver.java
    java/trunk/ecal-recon/src/main/java/org/hps/recon/ecal/cluster/CopyClusterCollectionDriver.java
    java/trunk/monitoring-util/src/main/java/org/hps/monitoring/subsys/et/package-info.java
    java/trunk/tracking/src/main/java/org/hps/recon/tracking/gbl/FittedGblTrajectory.java

Modified: java/trunk/analysis/src/main/java/org/hps/analysis/ecal/cosmic/RawModeSignalFitDriver.java
 =============================================================================
--- java/trunk/analysis/src/main/java/org/hps/analysis/ecal/cosmic/RawModeSignalFitDriver.java	(original)
+++ java/trunk/analysis/src/main/java/org/hps/analysis/ecal/cosmic/RawModeSignalFitDriver.java	Thu Mar 10 18:02:36 2016
@@ -168,7 +168,7 @@
      * Process the event, performing a signal fit for every raw data hit in the input collection.
      * The hits that pass the sigma selection cut are added to a new hits collection, which can be
      * converted to a CalorimeterHit collection and then clustered.
-     * @throw NextEventException if there are not enough hits that pass the selection cut.
+     * @throws NextEventException if there are not enough hits that pass the selection cut.
      */
     public void process(EventHeader event) {
         if (event.hasCollection(RawTrackerHit.class, inputHitsCollectionName)) {

Modified: java/trunk/analysis/src/main/java/org/hps/analysis/trigger/data/TriggerEvent.java
 =============================================================================
--- java/trunk/analysis/src/main/java/org/hps/analysis/trigger/data/TriggerEvent.java	(original)
+++ java/trunk/analysis/src/main/java/org/hps/analysis/trigger/data/TriggerEvent.java	Thu Mar 10 18:02:36 2016
@@ -80,8 +80,6 @@
      * successfully matched to a trigger in the SSP bank.
      * @param tiFlags - An array of size 6 indicating which TI bank
      * flags are active and which are not.
-     * @param triggerTypeID - An identifier indicating the type of
-     * trigger that was matched.
      */
     public void matchedSSPTrigger(boolean[] tiFlags) {
         matchedTriggers(tiFlags, SSP);

Modified: java/trunk/conditions/src/main/java/org/hps/conditions/database/ConditionsTagConverter.java
 =============================================================================
--- java/trunk/conditions/src/main/java/org/hps/conditions/database/ConditionsTagConverter.java	(original)
+++ java/trunk/conditions/src/main/java/org/hps/conditions/database/ConditionsTagConverter.java	Thu Mar 10 18:02:36 2016
@@ -23,10 +23,9 @@
     private static final String SELECT_SQL = "SELECT conditions_id, tag from conditions_tags where tag = ?";
    
     /**
-     * Get a {@link org.hps.conditions.api.ConditionsTag#ConditionsTagCollection} which specifies a group of collections
-     * that are tagged in the <i>conditions_tags</i> table in the database.
-     * <p>
-     * The run number is not used, and the <code>name</code> argument specifies the tag name.
+     * Get a {@link org.hps.conditions.api.ConditionsTag.ConditionsTagCollection} which specifies a group of 
+     * collections that are tagged in the <i>conditions_tags</i> table in the database.  The <code>name</code> 
+     * argument is the tag name.
      *
      * @param manager the current conditions manager
      * @param name the name of the conditions set

Modified: java/trunk/detector-model/src/main/java/org/lcsim/geometry/compact/converter/HPSTracker2014GeometryDefinition.java
 =============================================================================
--- java/trunk/detector-model/src/main/java/org/lcsim/geometry/compact/converter/HPSTracker2014GeometryDefinition.java	(original)
+++ java/trunk/detector-model/src/main/java/org/lcsim/geometry/compact/converter/HPSTracker2014GeometryDefinition.java	Thu Mar 10 18:02:36 2016
@@ -746,7 +746,7 @@
   
     /**
      * {@link SurveyVolume} volume defining the coordinate system of the u-channel 
-     * Reference: {@link #SVTBox} coordinate system
+     * Reference: {@link HPSTracker2014GeometryDefinition.SVTBox} coordinate system
      * Origin: midpoint between upstream survey cones
      * Orientation: u - width pointing towards electron side, v - pointing along the U-channel in the beam direction
      */

Modified: java/trunk/ecal-recon/src/main/java/org/hps/recon/ecal/EcalCalibrationsDriver.java
 =============================================================================
--- java/trunk/ecal-recon/src/main/java/org/hps/recon/ecal/EcalCalibrationsDriver.java	(original)
+++ java/trunk/ecal-recon/src/main/java/org/hps/recon/ecal/EcalCalibrationsDriver.java	Thu Mar 10 18:02:36 2016
@@ -91,7 +91,7 @@
     /**
      * Set the end run number for the conditions record.  
      * It must be >= the runEnd.
-     * @param runStart The run start number.
+     * @param runEnd The run end number.
      */
     public void setRunEnd(int runEnd) {
         if (runEnd < 0) {

Modified: java/trunk/ecal-recon/src/main/java/org/hps/recon/ecal/cluster/CopyClusterCollectionDriver.java
 =============================================================================
--- java/trunk/ecal-recon/src/main/java/org/hps/recon/ecal/cluster/CopyClusterCollectionDriver.java	(original)
+++ java/trunk/ecal-recon/src/main/java/org/hps/recon/ecal/cluster/CopyClusterCollectionDriver.java	Thu Mar 10 18:02:36 2016
@@ -112,7 +112,7 @@
     /**
      * Set to <code>true</code> to store hits in the output clusters.
      * 
-     * @param store <code>true</code> to store hits; <code>false</code> to not store hits
+     * @param storeHits <code>true</code> to store hits; <code>false</code> to not store hits
      */
     public void setStoreHits(final boolean storeHits) {
         this.storeHits = storeHits;

Modified: java/trunk/monitoring-util/src/main/java/org/hps/monitoring/subsys/et/package-info.java
 =============================================================================
--- java/trunk/monitoring-util/src/main/java/org/hps/monitoring/subsys/et/package-info.java	(original)
+++ java/trunk/monitoring-util/src/main/java/org/hps/monitoring/subsys/et/package-info.java	Thu Mar 10 18:02:36 2016
@@ -2,6 +2,5 @@
  * ET subsystem monitoring
  * 
  * @author Jeremy McCormick, SLAC
- * @see EtSystemMonitor
  */
 package org.hps.monitoring.subsys.et;

Modified: java/trunk/tracking/src/main/java/org/hps/recon/tracking/gbl/FittedGblTrajectory.java
 =============================================================================
--- java/trunk/tracking/src/main/java/org/hps/recon/tracking/gbl/FittedGblTrajectory.java	(original)
+++ java/trunk/tracking/src/main/java/org/hps/recon/tracking/gbl/FittedGblTrajectory.java	Thu Mar 10 18:02:36 2016
@@ -196,7 +196,7 @@
      * @param htf - helix to be corrected
      * @param point - {@link GBLPOINT} on the trajectory
      * @param bfield - magnitude of B-field.
-     * @return
+     * @return the corrected perigee parameters and covariance matrix
      */
     public Pair<double[], SymmetricMatrix> getCorrectedPerigeeParameters(HelicalTrackFit htf, GBLPOINT point, double bfield) {