Author: [log in to unmask] Date: Fri Sep 11 14:12:11 2015 New Revision: 3588 Log: add missing package-info.java files Added: java/trunk/analysis/src/main/java/org/hps/analysis/dataquality/package-info.java java/trunk/analysis/src/main/java/org/hps/analysis/ecal/cosmic/package-info.java java/trunk/analysis/src/main/java/org/hps/analysis/ecal/package-info.java java/trunk/analysis/src/main/java/org/hps/analysis/examples/package-info.java java/trunk/analysis/src/main/java/org/hps/analysis/muon/package-info.java java/trunk/analysis/src/main/java/org/hps/analysis/trigger/data/package-info.java java/trunk/analysis/src/main/java/org/hps/analysis/trigger/event/package-info.java java/trunk/analysis/src/main/java/org/hps/analysis/trigger/package-info.java java/trunk/analysis/src/main/java/org/hps/analysis/trigger/util/package-info.java java/trunk/conditions/src/main/java/org/hps/conditions/dummy/package-info.java java/trunk/conditions/src/main/java/org/hps/conditions/run/package-info.java java/trunk/datacat-client/src/main/java/org/hps/datacat/client/package-info.java java/trunk/detector-model/src/main/java/org/lcsim/detector/converter/compact/package-info.java java/trunk/detector-model/src/main/java/org/lcsim/geometry/compact/converter/lcdd/package-info.java java/trunk/detector-model/src/main/java/org/lcsim/geometry/compact/converter/package-info.java java/trunk/detector-model/src/main/java/org/lcsim/geometry/subdetector/package-info.java java/trunk/ecal-event-display/src/main/java/org/hps/monitoring/ecal/eventdisplay/event/package-info.java java/trunk/ecal-event-display/src/main/java/org/hps/monitoring/ecal/eventdisplay/exec/package-info.java java/trunk/ecal-event-display/src/main/java/org/hps/monitoring/ecal/eventdisplay/io/package-info.java java/trunk/ecal-event-display/src/main/java/org/hps/monitoring/ecal/eventdisplay/lcsim/package-info.java java/trunk/ecal-event-display/src/main/java/org/hps/monitoring/ecal/eventdisplay/ui/package-info.java java/trunk/ecal-event-display/src/main/java/org/hps/monitoring/ecal/eventdisplay/util/package-info.java java/trunk/ecal-readout-sim/src/main/java/org/hps/readout/ecal/package-info.java java/trunk/ecal-recon/src/main/java/org/hps/recon/ecal/cluster/package-info.java java/trunk/ecal-recon/src/main/java/org/hps/recon/ecal/package-info.java java/trunk/evio/src/main/java/org/hps/evio/package-info.java java/trunk/integration-tests/src/main/java/org/hps/test/util/package-info.java java/trunk/monitoring-app/src/main/java/org/hps/monitoring/application/model/package-info.java java/trunk/monitoring-app/src/main/java/org/hps/monitoring/application/util/package-info.java java/trunk/monitoring-drivers/src/main/java/org/hps/monitoring/drivers/example/package-info.java java/trunk/monitoring-drivers/src/main/java/org/hps/monitoring/drivers/scalers/package-info.java java/trunk/monitoring-drivers/src/main/java/org/hps/monitoring/drivers/svt/package-info.java java/trunk/monitoring-drivers/src/main/java/org/hps/monitoring/drivers/trackrecon/package-info.java java/trunk/monitoring-drivers/src/main/java/org/hps/monitoring/ecal/plots/package-info.java java/trunk/monitoring-util/src/main/java/org/hps/monitoring/plotting/package-info.java java/trunk/monitoring-util/src/main/java/org/hps/monitoring/subsys/ecal/package-info.java 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/package-info.java java/trunk/monitoring-util/src/main/java/org/hps/monitoring/subsys/svt/package-info.java java/trunk/monitoring-util/src/main/java/org/hps/monitoring/trigger/package-info.java java/trunk/plugin/src/main/java/org/hps/plugin/package-info.java java/trunk/recon/src/main/java/org/hps/recon/filtering/package-info.java java/trunk/recon/src/main/java/org/hps/recon/particle/package-info.java java/trunk/recon/src/main/java/org/hps/recon/utils/package-info.java java/trunk/recon/src/main/java/org/hps/recon/vertexing/package-info.java java/trunk/record-util/src/main/java/org/hps/record/daqconfig/package-info.java java/trunk/record-util/src/main/java/org/hps/record/triggerbank/package-info.java java/trunk/tracking/src/main/java/org/hps/readout/svt/package-info.java java/trunk/tracking/src/main/java/org/hps/recon/tracking/axial/package-info.java java/trunk/tracking/src/main/java/org/hps/recon/tracking/gbl/matrix/package-info.java java/trunk/tracking/src/main/java/org/hps/recon/tracking/gbl/package-info.java java/trunk/tracking/src/main/java/org/hps/recon/tracking/package-info.java java/trunk/tracking/src/main/java/org/hps/recon/tracking/straighttracks/package-info.java java/trunk/tracking/src/main/java/org/hps/svt/alignment/package-info.java java/trunk/util/src/main/java/org/hps/util/package-info.java Modified: java/trunk/conditions/src/main/java/org/hps/conditions/api/package-info.java java/trunk/conditions/src/main/java/org/hps/conditions/cli/package-info.java java/trunk/conditions/src/main/java/org/hps/conditions/database/package-info.java java/trunk/conditions/src/main/java/org/hps/conditions/ecal/package-info.java java/trunk/conditions/src/main/java/org/hps/conditions/package-info.java java/trunk/conditions/src/main/java/org/hps/conditions/svt/package-info.java java/trunk/monitoring-app/src/main/java/org/hps/monitoring/application/package-info.java Added: java/trunk/analysis/src/main/java/org/hps/analysis/dataquality/package-info.java ============================================================================= --- java/trunk/analysis/src/main/java/org/hps/analysis/dataquality/package-info.java (added) +++ java/trunk/analysis/src/main/java/org/hps/analysis/dataquality/package-info.java Fri Sep 11 14:12:11 2015 @@ -0,0 +1,4 @@ +/** + * Data Quality Management (DQM) Framework + */ +package org.hps.analysis.dataquality; Added: java/trunk/analysis/src/main/java/org/hps/analysis/ecal/cosmic/package-info.java ============================================================================= --- java/trunk/analysis/src/main/java/org/hps/analysis/ecal/cosmic/package-info.java (added) +++ java/trunk/analysis/src/main/java/org/hps/analysis/ecal/cosmic/package-info.java Fri Sep 11 14:12:11 2015 @@ -0,0 +1,4 @@ +/** + * ECal cosmic analysis Drivers + */ +package org.hps.analysis.ecal.cosmic; Added: java/trunk/analysis/src/main/java/org/hps/analysis/ecal/package-info.java ============================================================================= --- java/trunk/analysis/src/main/java/org/hps/analysis/ecal/package-info.java (added) +++ java/trunk/analysis/src/main/java/org/hps/analysis/ecal/package-info.java Fri Sep 11 14:12:11 2015 @@ -0,0 +1,4 @@ +/** + * ECal physics analysis (includes some old monitoring Drivers) + */ +package org.hps.analysis.ecal; Added: java/trunk/analysis/src/main/java/org/hps/analysis/examples/package-info.java ============================================================================= --- java/trunk/analysis/src/main/java/org/hps/analysis/examples/package-info.java (added) +++ java/trunk/analysis/src/main/java/org/hps/analysis/examples/package-info.java Fri Sep 11 14:12:11 2015 @@ -0,0 +1,4 @@ +/** + * Example analysis Drivers + */ +package org.hps.analysis.examples; Added: java/trunk/analysis/src/main/java/org/hps/analysis/muon/package-info.java ============================================================================= --- java/trunk/analysis/src/main/java/org/hps/analysis/muon/package-info.java (added) +++ java/trunk/analysis/src/main/java/org/hps/analysis/muon/package-info.java Fri Sep 11 14:12:11 2015 @@ -0,0 +1,4 @@ +/** + * Muon analysis Drivers + */ +package org.hps.analysis.muon; Added: java/trunk/analysis/src/main/java/org/hps/analysis/trigger/data/package-info.java ============================================================================= --- java/trunk/analysis/src/main/java/org/hps/analysis/trigger/data/package-info.java (added) +++ java/trunk/analysis/src/main/java/org/hps/analysis/trigger/data/package-info.java Fri Sep 11 14:12:11 2015 @@ -0,0 +1,4 @@ +/** + * Classes for modeling trigger data in analysis jobs + */ +package org.hps.analysis.trigger.data; Added: java/trunk/analysis/src/main/java/org/hps/analysis/trigger/event/package-info.java ============================================================================= --- java/trunk/analysis/src/main/java/org/hps/analysis/trigger/event/package-info.java (added) +++ java/trunk/analysis/src/main/java/org/hps/analysis/trigger/event/package-info.java Fri Sep 11 14:12:11 2015 @@ -0,0 +1,4 @@ +/** + * Trigger analysis event plots + */ +package org.hps.analysis.trigger.event; Added: java/trunk/analysis/src/main/java/org/hps/analysis/trigger/package-info.java ============================================================================= --- java/trunk/analysis/src/main/java/org/hps/analysis/trigger/package-info.java (added) +++ java/trunk/analysis/src/main/java/org/hps/analysis/trigger/package-info.java Fri Sep 11 14:12:11 2015 @@ -0,0 +1,4 @@ +/** + * Trigger analysis Drivers and utility classes + */ +package org.hps.analysis.trigger; Added: java/trunk/analysis/src/main/java/org/hps/analysis/trigger/util/package-info.java ============================================================================= --- java/trunk/analysis/src/main/java/org/hps/analysis/trigger/util/package-info.java (added) +++ java/trunk/analysis/src/main/java/org/hps/analysis/trigger/util/package-info.java Fri Sep 11 14:12:11 2015 @@ -0,0 +1,4 @@ +/** + * Trigger analysis event plots + */ +package org.hps.analysis.trigger.util; Modified: java/trunk/conditions/src/main/java/org/hps/conditions/api/package-info.java ============================================================================= --- java/trunk/conditions/src/main/java/org/hps/conditions/api/package-info.java (original) +++ java/trunk/conditions/src/main/java/org/hps/conditions/api/package-info.java Fri Sep 11 14:12:11 2015 @@ -1,5 +1,5 @@ /** - * Interfaces, abstract classes and implementations of the conditions system API for HPS. + * User interface to the database conditions system * * @author Jeremy McCormick, SLAC * @see ConditionsObject Modified: java/trunk/conditions/src/main/java/org/hps/conditions/cli/package-info.java ============================================================================= --- java/trunk/conditions/src/main/java/org/hps/conditions/cli/package-info.java (original) +++ java/trunk/conditions/src/main/java/org/hps/conditions/cli/package-info.java Fri Sep 11 14:12:11 2015 @@ -1,5 +1,5 @@ /** - * Command line interface to the conditions system. + * Command line interface to the conditions system * * @author Jeremy McCormick, SLAC */ Modified: java/trunk/conditions/src/main/java/org/hps/conditions/database/package-info.java ============================================================================= --- java/trunk/conditions/src/main/java/org/hps/conditions/database/package-info.java (original) +++ java/trunk/conditions/src/main/java/org/hps/conditions/database/package-info.java Fri Sep 11 14:12:11 2015 @@ -1,12 +1,7 @@ /** - * This package contains classes for converting database information into conditions classes as well as updating the - * records from the objects. + * Implementation of database API to detector conditions * * @author Jeremy McCormick, SLAC - * @see DatabaseConditionsManager - * @see TableMetaData - * @see AbstractConditionsObjectConverter - * @see ConditionsSeriesConverter */ package org.hps.conditions.database; Added: java/trunk/conditions/src/main/java/org/hps/conditions/dummy/package-info.java ============================================================================= --- java/trunk/conditions/src/main/java/org/hps/conditions/dummy/package-info.java (added) +++ java/trunk/conditions/src/main/java/org/hps/conditions/dummy/package-info.java Fri Sep 11 14:12:11 2015 @@ -0,0 +1,5 @@ +/** + * Dummy conditions classes for testing + */ +package org.hps.conditions.dummy; + Modified: java/trunk/conditions/src/main/java/org/hps/conditions/ecal/package-info.java ============================================================================= --- java/trunk/conditions/src/main/java/org/hps/conditions/ecal/package-info.java (original) +++ java/trunk/conditions/src/main/java/org/hps/conditions/ecal/package-info.java Fri Sep 11 14:12:11 2015 @@ -1,23 +1,5 @@ /** - * <p> - * The classes in this package represent detector conditions in the HPS ECAL subsystem. - * <p> - * Each {@link EcalChannel} represents one physical crystal in the detector. - * <p> - * The {@link EcalBadChannel} is a channel that is malfunctioning or dead and should not be used for reconstruction. It - * is up to the reconstruction Drivers to filter out these channels. - * <p> - * The {@link EcalCalibration} contains the pedestal and noise values for a channel, which are the mean and the standard - * deviation of the digitized preamplifier output. - * <p> - * The {@link EcalGain} is the channel gain in units of MeV/ADC counts. - * <p> - * The {@link EcalTimeShift} is a time shift in the electronics response. - * <p> - * The {@link EcalLedCalibration} is calibration information for the LED attached to an ECAL channel. - * <p> - * The energy of a hit is reconstructed by multiplying the gain by the pedestal-subtracted ADC integral (e.g. in Test - * Run 2012 data). + * Ecal detector conditions * * @author Jeremy McCormick, SLAC */ Modified: java/trunk/conditions/src/main/java/org/hps/conditions/package-info.java ============================================================================= --- java/trunk/conditions/src/main/java/org/hps/conditions/package-info.java (original) +++ java/trunk/conditions/src/main/java/org/hps/conditions/package-info.java Fri Sep 11 14:12:11 2015 @@ -1,4 +1,6 @@ /** + * Database conditions system + * <p> * The HPS conditions module provides facilities for accessing time dependent conditions for a detector at runtime using * a framework built on the LCSim conditions system. The {@link DatabaseConditionsReader} has a set of converters for * reading data from tables using SQL queries and creating appropriate, typed objects for them. @@ -8,4 +10,3 @@ * @see org.hps.conditions.database */ package org.hps.conditions; - Added: java/trunk/conditions/src/main/java/org/hps/conditions/run/package-info.java ============================================================================= --- java/trunk/conditions/src/main/java/org/hps/conditions/run/package-info.java (added) +++ java/trunk/conditions/src/main/java/org/hps/conditions/run/package-info.java Fri Sep 11 14:12:11 2015 @@ -0,0 +1,5 @@ +/** + * A few utilities for working with a spreadsheet of run data + */ +package org.hps.conditions.run; + Modified: java/trunk/conditions/src/main/java/org/hps/conditions/svt/package-info.java ============================================================================= --- java/trunk/conditions/src/main/java/org/hps/conditions/svt/package-info.java (original) +++ java/trunk/conditions/src/main/java/org/hps/conditions/svt/package-info.java Fri Sep 11 14:12:11 2015 @@ -1,17 +1,7 @@ /** - * Implementation of detector conditions API for the HPS SVT. + * SVT detector conditions * * @author Omar Moreno, UCSC * @author Jeremy McCormick, SLAC - * @see org.hps.conditions.api - * @see org.hps.conditions.api.ConditionsObject - * @see org.hps.conditions.api.ConditionsObjectCollection - * @see SvtChannel - * @see SvtConditions - * @see SvtGain - * @see SvtCalibration - * @see SvtT0Shift - * @see SvtBadChannel */ package org.hps.conditions.svt; - Added: java/trunk/datacat-client/src/main/java/org/hps/datacat/client/package-info.java ============================================================================= --- java/trunk/datacat-client/src/main/java/org/hps/datacat/client/package-info.java (added) +++ java/trunk/datacat-client/src/main/java/org/hps/datacat/client/package-info.java Fri Sep 11 14:12:11 2015 @@ -0,0 +1,5 @@ +/** + * Java wrapper of SRS data catalog REST API + */ +package org.hps.datacat.client; + Added: java/trunk/detector-model/src/main/java/org/lcsim/detector/converter/compact/package-info.java ============================================================================= --- java/trunk/detector-model/src/main/java/org/lcsim/detector/converter/compact/package-info.java (added) +++ java/trunk/detector-model/src/main/java/org/lcsim/detector/converter/compact/package-info.java Fri Sep 11 14:12:11 2015 @@ -0,0 +1,4 @@ +/** + * Converters from compact XML format to Java runtime objects modeling the detector + */ +package org.lcsim.detector.converter.compact; Added: java/trunk/detector-model/src/main/java/org/lcsim/geometry/compact/converter/lcdd/package-info.java ============================================================================= --- java/trunk/detector-model/src/main/java/org/lcsim/geometry/compact/converter/lcdd/package-info.java (added) +++ java/trunk/detector-model/src/main/java/org/lcsim/geometry/compact/converter/lcdd/package-info.java Fri Sep 11 14:12:11 2015 @@ -0,0 +1,4 @@ +/** + * Converts HPS detector classes from the compact XML description to LCDD for SLIC + */ +package org.lcsim.geometry.compact.converter.lcdd; Added: java/trunk/detector-model/src/main/java/org/lcsim/geometry/compact/converter/package-info.java ============================================================================= --- java/trunk/detector-model/src/main/java/org/lcsim/geometry/compact/converter/package-info.java (added) +++ java/trunk/detector-model/src/main/java/org/lcsim/geometry/compact/converter/package-info.java Fri Sep 11 14:12:11 2015 @@ -0,0 +1,6 @@ +/** + * Detailed classes for modeling the HPS detector at runtime + * <p> + * These classes model the SVT detector only. + */ +package org.lcsim.geometry.compact.converter; Added: java/trunk/detector-model/src/main/java/org/lcsim/geometry/subdetector/package-info.java ============================================================================= --- java/trunk/detector-model/src/main/java/org/lcsim/geometry/subdetector/package-info.java (added) +++ java/trunk/detector-model/src/main/java/org/lcsim/geometry/subdetector/package-info.java Fri Sep 11 14:12:11 2015 @@ -0,0 +1,6 @@ +/** + * Compact detector implementation + * <p> + * These are mostly stub classes and do not provide much functionality. + */ +package org.lcsim.geometry.subdetector; Added: java/trunk/ecal-event-display/src/main/java/org/hps/monitoring/ecal/eventdisplay/event/package-info.java ============================================================================= --- java/trunk/ecal-event-display/src/main/java/org/hps/monitoring/ecal/eventdisplay/event/package-info.java (added) +++ java/trunk/ecal-event-display/src/main/java/org/hps/monitoring/ecal/eventdisplay/event/package-info.java Fri Sep 11 14:12:11 2015 @@ -0,0 +1,6 @@ +/** + * Simple event modeling classes for the ECal event display + * + * @author Kyle McCarty + */ +package org.hps.monitoring.ecal.eventdisplay.event; Added: java/trunk/ecal-event-display/src/main/java/org/hps/monitoring/ecal/eventdisplay/exec/package-info.java ============================================================================= --- java/trunk/ecal-event-display/src/main/java/org/hps/monitoring/ecal/eventdisplay/exec/package-info.java (added) +++ java/trunk/ecal-event-display/src/main/java/org/hps/monitoring/ecal/eventdisplay/exec/package-info.java Fri Sep 11 14:12:11 2015 @@ -0,0 +1,6 @@ +/** + * Implementation of main method and Driver for ECal event display + * + * @author Kyle McCarty + */ +package org.hps.monitoring.ecal.eventdisplay.exec; Added: java/trunk/ecal-event-display/src/main/java/org/hps/monitoring/ecal/eventdisplay/io/package-info.java ============================================================================= --- java/trunk/ecal-event-display/src/main/java/org/hps/monitoring/ecal/eventdisplay/io/package-info.java (added) +++ java/trunk/ecal-event-display/src/main/java/org/hps/monitoring/ecal/eventdisplay/io/package-info.java Fri Sep 11 14:12:11 2015 @@ -0,0 +1,6 @@ +/** + * IO backend for ECal event display + * + * @author Kyle McCarty + */ +package org.hps.monitoring.ecal.eventdisplay.io; Added: java/trunk/ecal-event-display/src/main/java/org/hps/monitoring/ecal/eventdisplay/lcsim/package-info.java ============================================================================= --- java/trunk/ecal-event-display/src/main/java/org/hps/monitoring/ecal/eventdisplay/lcsim/package-info.java (added) +++ java/trunk/ecal-event-display/src/main/java/org/hps/monitoring/ecal/eventdisplay/lcsim/package-info.java Fri Sep 11 14:12:11 2015 @@ -0,0 +1,6 @@ +/** + * ECal event display classes for exporting data to/from lcsim + * + * @author Kyle McCarty + */ +package org.hps.monitoring.ecal.eventdisplay.lcsim; Added: java/trunk/ecal-event-display/src/main/java/org/hps/monitoring/ecal/eventdisplay/ui/package-info.java ============================================================================= --- java/trunk/ecal-event-display/src/main/java/org/hps/monitoring/ecal/eventdisplay/ui/package-info.java (added) +++ java/trunk/ecal-event-display/src/main/java/org/hps/monitoring/ecal/eventdisplay/ui/package-info.java Fri Sep 11 14:12:11 2015 @@ -0,0 +1,6 @@ +/** + * GUI for the ECal event display + * + * @author Kyle McCarty + */ +package org.hps.monitoring.ecal.eventdisplay.ui; Added: java/trunk/ecal-event-display/src/main/java/org/hps/monitoring/ecal/eventdisplay/util/package-info.java ============================================================================= --- java/trunk/ecal-event-display/src/main/java/org/hps/monitoring/ecal/eventdisplay/util/package-info.java (added) +++ java/trunk/ecal-event-display/src/main/java/org/hps/monitoring/ecal/eventdisplay/util/package-info.java Fri Sep 11 14:12:11 2015 @@ -0,0 +1,6 @@ +/** + * Utility classes for the ECal event display + * + * @author Kyle McCarty + */ +package org.hps.monitoring.ecal.eventdisplay.util; Added: java/trunk/ecal-readout-sim/src/main/java/org/hps/readout/ecal/package-info.java ============================================================================= --- java/trunk/ecal-readout-sim/src/main/java/org/hps/readout/ecal/package-info.java (added) +++ java/trunk/ecal-readout-sim/src/main/java/org/hps/readout/ecal/package-info.java Fri Sep 11 14:12:11 2015 @@ -0,0 +1,6 @@ +/** + * Trigger simulation which reads in physics events and models pile-up + * + * @author Sho Uemura + */ +package org.hps.readout.ecal; Added: java/trunk/ecal-recon/src/main/java/org/hps/recon/ecal/cluster/package-info.java ============================================================================= --- java/trunk/ecal-recon/src/main/java/org/hps/recon/ecal/cluster/package-info.java (added) +++ java/trunk/ecal-recon/src/main/java/org/hps/recon/ecal/cluster/package-info.java Fri Sep 11 14:12:11 2015 @@ -0,0 +1,4 @@ +/** + * ECal cluster reconstruction Drivers and utilities + */ +package org.hps.recon.ecal.cluster; Added: java/trunk/ecal-recon/src/main/java/org/hps/recon/ecal/package-info.java ============================================================================= --- java/trunk/ecal-recon/src/main/java/org/hps/recon/ecal/package-info.java (added) +++ java/trunk/ecal-recon/src/main/java/org/hps/recon/ecal/package-info.java Fri Sep 11 14:12:11 2015 @@ -0,0 +1,4 @@ +/** + * ECal physics reconstruction, including conversion of raw data to {@link org.lcsim.event.CalorimeterHit} collections + */ +package org.hps.recon.ecal; Added: java/trunk/evio/src/main/java/org/hps/evio/package-info.java ============================================================================= --- java/trunk/evio/src/main/java/org/hps/evio/package-info.java (added) +++ java/trunk/evio/src/main/java/org/hps/evio/package-info.java Fri Sep 11 14:12:11 2015 @@ -0,0 +1,4 @@ +/** + * Provides classes to convert from raw EVIO data to LCIO for physics reconstruction + */ +package org.hps.evio; Added: java/trunk/integration-tests/src/main/java/org/hps/test/util/package-info.java ============================================================================= --- java/trunk/integration-tests/src/main/java/org/hps/test/util/package-info.java (added) +++ java/trunk/integration-tests/src/main/java/org/hps/test/util/package-info.java Fri Sep 11 14:12:11 2015 @@ -0,0 +1,4 @@ +/** + * Integration test utilities + */ +package org.hps.test.util; Added: java/trunk/monitoring-app/src/main/java/org/hps/monitoring/application/model/package-info.java ============================================================================= --- java/trunk/monitoring-app/src/main/java/org/hps/monitoring/application/model/package-info.java (added) +++ java/trunk/monitoring-app/src/main/java/org/hps/monitoring/application/model/package-info.java Fri Sep 11 14:12:11 2015 @@ -0,0 +1,7 @@ +/** + * Backing data model for monitoring application + * + * @author Jeremy McCormick, SLAC + */ +package org.hps.monitoring.application.model; + Modified: java/trunk/monitoring-app/src/main/java/org/hps/monitoring/application/package-info.java ============================================================================= --- java/trunk/monitoring-app/src/main/java/org/hps/monitoring/application/package-info.java (original) +++ java/trunk/monitoring-app/src/main/java/org/hps/monitoring/application/package-info.java Fri Sep 11 14:12:11 2015 @@ -1,4 +1,6 @@ /** + * Monitoring application GUI implemented in Swing framework + * <p> * The Monitoring Application is a flexible framework for monitoring the event processing chain of the HPS experiment in * an online environment. It implements the conversion of ET byte buffers to EVIO and then the building of LCIO events * from the raw EVIO data. Added: java/trunk/monitoring-app/src/main/java/org/hps/monitoring/application/util/package-info.java ============================================================================= --- java/trunk/monitoring-app/src/main/java/org/hps/monitoring/application/util/package-info.java (added) +++ java/trunk/monitoring-app/src/main/java/org/hps/monitoring/application/util/package-info.java Fri Sep 11 14:12:11 2015 @@ -0,0 +1,7 @@ +/** + * Utility classes for the monitoring GUI + * + * @author Jeremy McCormick, SLAC + */ +package org.hps.monitoring.application.util; + Added: java/trunk/monitoring-drivers/src/main/java/org/hps/monitoring/drivers/example/package-info.java ============================================================================= --- java/trunk/monitoring-drivers/src/main/java/org/hps/monitoring/drivers/example/package-info.java (added) +++ java/trunk/monitoring-drivers/src/main/java/org/hps/monitoring/drivers/example/package-info.java Fri Sep 11 14:12:11 2015 @@ -0,0 +1,7 @@ +/** + * Example monitoring Drivers + * + * @author Jeremy McCormick, SLAC + */ +package org.hps.monitoring.drivers.example; + Added: java/trunk/monitoring-drivers/src/main/java/org/hps/monitoring/drivers/scalers/package-info.java ============================================================================= --- java/trunk/monitoring-drivers/src/main/java/org/hps/monitoring/drivers/scalers/package-info.java (added) +++ java/trunk/monitoring-drivers/src/main/java/org/hps/monitoring/drivers/scalers/package-info.java Fri Sep 11 14:12:11 2015 @@ -0,0 +1,7 @@ +/** + * Deadtime monitoring plots + * + * @author Jeremy McCormick, SLAC + */ +package org.hps.monitoring.drivers.scalers; + Added: java/trunk/monitoring-drivers/src/main/java/org/hps/monitoring/drivers/svt/package-info.java ============================================================================= --- java/trunk/monitoring-drivers/src/main/java/org/hps/monitoring/drivers/svt/package-info.java (added) +++ java/trunk/monitoring-drivers/src/main/java/org/hps/monitoring/drivers/svt/package-info.java Fri Sep 11 14:12:11 2015 @@ -0,0 +1,7 @@ +/** + * SVT monitoring plots + * + * @author Jeremy McCormick, SLAC + */ +package org.hps.monitoring.drivers.svt; + Added: java/trunk/monitoring-drivers/src/main/java/org/hps/monitoring/drivers/trackrecon/package-info.java ============================================================================= --- java/trunk/monitoring-drivers/src/main/java/org/hps/monitoring/drivers/trackrecon/package-info.java (added) +++ java/trunk/monitoring-drivers/src/main/java/org/hps/monitoring/drivers/trackrecon/package-info.java Fri Sep 11 14:12:11 2015 @@ -0,0 +1,7 @@ +/** + * Track reconstruction monitoring plots + * + * @author Jeremy McCormick, SLAC + */ +package org.hps.monitoring.drivers.trackrecon; + Added: java/trunk/monitoring-drivers/src/main/java/org/hps/monitoring/ecal/plots/package-info.java ============================================================================= --- java/trunk/monitoring-drivers/src/main/java/org/hps/monitoring/ecal/plots/package-info.java (added) +++ java/trunk/monitoring-drivers/src/main/java/org/hps/monitoring/ecal/plots/package-info.java Fri Sep 11 14:12:11 2015 @@ -0,0 +1,7 @@ +/** + * ECal monitoring plots + * + * @author Jeremy McCormick, SLAC + */ +package org.hps.monitoring.ecal.plots; + Added: java/trunk/monitoring-util/src/main/java/org/hps/monitoring/plotting/package-info.java ============================================================================= --- java/trunk/monitoring-util/src/main/java/org/hps/monitoring/plotting/package-info.java (added) +++ java/trunk/monitoring-util/src/main/java/org/hps/monitoring/plotting/package-info.java Fri Sep 11 14:12:11 2015 @@ -0,0 +1,6 @@ +/** + * Plotting utilities for the monitoring application + * + * @author Jeremy McCormick, SLAC + */ +package org.hps.monitoring.plotting; Added: java/trunk/monitoring-util/src/main/java/org/hps/monitoring/subsys/ecal/package-info.java ============================================================================= --- java/trunk/monitoring-util/src/main/java/org/hps/monitoring/subsys/ecal/package-info.java (added) +++ java/trunk/monitoring-util/src/main/java/org/hps/monitoring/subsys/ecal/package-info.java Fri Sep 11 14:12:11 2015 @@ -0,0 +1,9 @@ +/** + * ECal subsystem monitoring + * <p> + * Classes in this package are actually not currently implementing any subsystem monitoring + * and should be moved elsewhere! + * + * @author Jeremy McCormick, SLAC + */ +package org.hps.monitoring.subsys.ecal; Added: 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 (added) +++ java/trunk/monitoring-util/src/main/java/org/hps/monitoring/subsys/et/package-info.java Fri Sep 11 14:12:11 2015 @@ -0,0 +1,8 @@ +/** + * ET subsystem monitoring + * <p> + * {@link EtSystemMonitor} implements basic status checks of the ET system. + * + * @author Jeremy McCormick, SLAC + */ +package org.hps.monitoring.subsys.et; Added: java/trunk/monitoring-util/src/main/java/org/hps/monitoring/subsys/package-info.java ============================================================================= --- java/trunk/monitoring-util/src/main/java/org/hps/monitoring/subsys/package-info.java (added) +++ java/trunk/monitoring-util/src/main/java/org/hps/monitoring/subsys/package-info.java Fri Sep 11 14:12:11 2015 @@ -0,0 +1,6 @@ +/** + * Subsystem monitoring implementation for activating soft alarms and status checks in the monitoring application + * + * @author Jeremy McCormick, SLAC + */ +package org.hps.monitoring.subsys; Added: java/trunk/monitoring-util/src/main/java/org/hps/monitoring/subsys/svt/package-info.java ============================================================================= --- java/trunk/monitoring-util/src/main/java/org/hps/monitoring/subsys/svt/package-info.java (added) +++ java/trunk/monitoring-util/src/main/java/org/hps/monitoring/subsys/svt/package-info.java Fri Sep 11 14:12:11 2015 @@ -0,0 +1,6 @@ +/** + * SVT subsystem monitoring + * + * @author Jeremy McCormick, SLAC + */ +package org.hps.monitoring.subsys.svt; Added: java/trunk/monitoring-util/src/main/java/org/hps/monitoring/trigger/package-info.java ============================================================================= --- java/trunk/monitoring-util/src/main/java/org/hps/monitoring/trigger/package-info.java (added) +++ java/trunk/monitoring-util/src/main/java/org/hps/monitoring/trigger/package-info.java Fri Sep 11 14:12:11 2015 @@ -0,0 +1,6 @@ +/** + * Trigger monitoring GUI + * + * @author Jeremy McCormick, SLAC + */ +package org.hps.monitoring.trigger; Added: java/trunk/plugin/src/main/java/org/hps/plugin/package-info.java ============================================================================= --- java/trunk/plugin/src/main/java/org/hps/plugin/package-info.java (added) +++ java/trunk/plugin/src/main/java/org/hps/plugin/package-info.java Fri Sep 11 14:12:11 2015 @@ -0,0 +1,6 @@ +/** + * Provides a stub plugin class for JAS3 + * + * @author Jeremy McCormick, SLAC + */ +package org.hps.plugin; Added: java/trunk/recon/src/main/java/org/hps/recon/filtering/package-info.java ============================================================================= --- java/trunk/recon/src/main/java/org/hps/recon/filtering/package-info.java (added) +++ java/trunk/recon/src/main/java/org/hps/recon/filtering/package-info.java Fri Sep 11 14:12:11 2015 @@ -0,0 +1,4 @@ +/** + * Utilities and Drivers for filtering and skimming physics events + */ +package org.hps.recon.filtering; Added: java/trunk/recon/src/main/java/org/hps/recon/particle/package-info.java ============================================================================= --- java/trunk/recon/src/main/java/org/hps/recon/particle/package-info.java (added) +++ java/trunk/recon/src/main/java/org/hps/recon/particle/package-info.java Fri Sep 11 14:12:11 2015 @@ -0,0 +1,4 @@ +/** + * Reconstructed particle Drivers and utilities + */ +package org.hps.recon.particle; Added: java/trunk/recon/src/main/java/org/hps/recon/utils/package-info.java ============================================================================= --- java/trunk/recon/src/main/java/org/hps/recon/utils/package-info.java (added) +++ java/trunk/recon/src/main/java/org/hps/recon/utils/package-info.java Fri Sep 11 14:12:11 2015 @@ -0,0 +1,6 @@ +/** + * Reconstruction utilities + * <p> + * Currently provides a track-cluster matcher. + */ +package org.hps.recon.utils; Added: java/trunk/recon/src/main/java/org/hps/recon/vertexing/package-info.java ============================================================================= --- java/trunk/recon/src/main/java/org/hps/recon/vertexing/package-info.java (added) +++ java/trunk/recon/src/main/java/org/hps/recon/vertexing/package-info.java Fri Sep 11 14:12:11 2015 @@ -0,0 +1,4 @@ +/** + * Vertex reconstruction framework based on Billior + */ +package org.hps.recon.vertexing; Added: java/trunk/record-util/src/main/java/org/hps/record/daqconfig/package-info.java ============================================================================= --- java/trunk/record-util/src/main/java/org/hps/record/daqconfig/package-info.java (added) +++ java/trunk/record-util/src/main/java/org/hps/record/daqconfig/package-info.java Fri Sep 11 14:12:11 2015 @@ -0,0 +1,6 @@ +/** + * Set of classes for modeling information in the DAQ config from EVIO + * + * @author Jeremy McCormick, SLAC + */ +package org.hps.record.daqconfig; Added: java/trunk/record-util/src/main/java/org/hps/record/triggerbank/package-info.java ============================================================================= --- java/trunk/record-util/src/main/java/org/hps/record/triggerbank/package-info.java (added) +++ java/trunk/record-util/src/main/java/org/hps/record/triggerbank/package-info.java Fri Sep 11 14:12:11 2015 @@ -0,0 +1,6 @@ +/** + * Models the information contained in the EVIO SSP trigger banks + * + * @author Jeremy McCormick, SLAC + */ +package org.hps.record.triggerbank; Added: java/trunk/tracking/src/main/java/org/hps/readout/svt/package-info.java ============================================================================= --- java/trunk/tracking/src/main/java/org/hps/readout/svt/package-info.java (added) +++ java/trunk/tracking/src/main/java/org/hps/readout/svt/package-info.java Fri Sep 11 14:12:11 2015 @@ -0,0 +1,4 @@ +/** + * SVT DAQ simulation + */ +package org.hps.readout.svt; Added: java/trunk/tracking/src/main/java/org/hps/recon/tracking/axial/package-info.java ============================================================================= --- java/trunk/tracking/src/main/java/org/hps/recon/tracking/axial/package-info.java (added) +++ java/trunk/tracking/src/main/java/org/hps/recon/tracking/axial/package-info.java Fri Sep 11 14:12:11 2015 @@ -0,0 +1,4 @@ +/** + * Track reconstruction using only axial layers + */ +package org.hps.recon.tracking.axial; Added: java/trunk/tracking/src/main/java/org/hps/recon/tracking/gbl/matrix/package-info.java ============================================================================= --- java/trunk/tracking/src/main/java/org/hps/recon/tracking/gbl/matrix/package-info.java (added) +++ java/trunk/tracking/src/main/java/org/hps/recon/tracking/gbl/matrix/package-info.java Fri Sep 11 14:12:11 2015 @@ -0,0 +1,4 @@ +/** + * Matrix utilities for GBL + */ +package org.hps.recon.tracking.gbl.matrix; Added: java/trunk/tracking/src/main/java/org/hps/recon/tracking/gbl/package-info.java ============================================================================= --- java/trunk/tracking/src/main/java/org/hps/recon/tracking/gbl/package-info.java (added) +++ java/trunk/tracking/src/main/java/org/hps/recon/tracking/gbl/package-info.java Fri Sep 11 14:12:11 2015 @@ -0,0 +1,6 @@ +/** + * Generalized Broken Lines (GBL) track fitting algorithm, originally ported from C++ + * <p> + * <a href="http://www.desy.de/~kleinwrt/GBL/doc/cpp/html/">GBL C++ documentation</a> + */ +package org.hps.recon.tracking.gbl; Added: java/trunk/tracking/src/main/java/org/hps/recon/tracking/package-info.java ============================================================================= --- java/trunk/tracking/src/main/java/org/hps/recon/tracking/package-info.java (added) +++ java/trunk/tracking/src/main/java/org/hps/recon/tracking/package-info.java Fri Sep 11 14:12:11 2015 @@ -0,0 +1,4 @@ +/** + * Track reconstruction framework + */ +package org.hps.recon.tracking; Added: java/trunk/tracking/src/main/java/org/hps/recon/tracking/straighttracks/package-info.java ============================================================================= --- java/trunk/tracking/src/main/java/org/hps/recon/tracking/straighttracks/package-info.java (added) +++ java/trunk/tracking/src/main/java/org/hps/recon/tracking/straighttracks/package-info.java Fri Sep 11 14:12:11 2015 @@ -0,0 +1,4 @@ +/** + * Straight track reconstruction (no B-field) + */ +package org.hps.recon.tracking.straighttracks; Added: java/trunk/tracking/src/main/java/org/hps/svt/alignment/package-info.java ============================================================================= --- java/trunk/tracking/src/main/java/org/hps/svt/alignment/package-info.java (added) +++ java/trunk/tracking/src/main/java/org/hps/svt/alignment/package-info.java Fri Sep 11 14:12:11 2015 @@ -0,0 +1,4 @@ +/** + * SVT detector alignment classes + */ +package org.hps.svt.alignment; Added: java/trunk/util/src/main/java/org/hps/util/package-info.java ============================================================================= --- java/trunk/util/src/main/java/org/hps/util/package-info.java (added) +++ java/trunk/util/src/main/java/org/hps/util/package-info.java Fri Sep 11 14:12:11 2015 @@ -0,0 +1,6 @@ +/** + * Miscellaneous utility classes + */ +// FIXME: This package has a bunch of classes that are not really related to each other. +// Most should be moved elsewhere. +package org.hps.util;