diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 6a176de988..4b08ffd154 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -18,7 +18,6 @@ env: JAVA_VERSION: 21 # must be consistent with POM; see also dependabot config for any version limits JAVA_VERSION_LATEST: 25 # the latest `JAVA_VERSION` that we test with CI java_distribution: zulu - javadoc_version: 25 # newer than `JAVA_VERSION` for better javadoc groovy_version: 4.x CCDB_CONNECTION: 'sqlite:///${{ github.workspace }}/coatjava/etc/data/sqlite/ccdb.sqlite' nthreads: 1 @@ -353,7 +352,7 @@ jobs: - name: set up JDK uses: actions/setup-java@v5 with: - java-version: ${{ env.javadoc_version }} + java-version: ${{ env.JAVA_VERSION }} distribution: ${{ env.java_distribution }} cache: maven - name: build coatjava javadocs # javadoc:aggregate output dir cannot be controlled, so assume the latest "standard" path and `mv` it diff --git a/common-tools/clas-decay-tools/src/main/java/org/jlab/clas/decay/analysis/Particle.java b/common-tools/clas-decay-tools/src/main/java/org/jlab/clas/decay/analysis/Particle.java index cbea622750..f66dc17943 100644 --- a/common-tools/clas-decay-tools/src/main/java/org/jlab/clas/decay/analysis/Particle.java +++ b/common-tools/clas-decay-tools/src/main/java/org/jlab/clas/decay/analysis/Particle.java @@ -571,7 +571,7 @@ public double getRecMass() { } /** - * @param _recmass the _mass to set + * @param _mass the _mass to set */ public void setRecMass(double _mass) { this._recmass = _mass; diff --git a/common-tools/clas-detector/src/main/java/org/jlab/detector/helicity/HelicityGenerator.java b/common-tools/clas-detector/src/main/java/org/jlab/detector/helicity/HelicityGenerator.java index f8af32d471..737c335c8b 100644 --- a/common-tools/clas-detector/src/main/java/org/jlab/detector/helicity/HelicityGenerator.java +++ b/common-tools/clas-detector/src/main/java/org/jlab/detector/helicity/HelicityGenerator.java @@ -145,11 +145,11 @@ public void addState(HelicityBit bit) { * Let the user add a state to initialize the sequence. * * This just calls {@link #addState(HelicityBit)} with the raw - * {@link #HelicityBit} from the given {@link #HelicityState}. + * {@link HelicityBit} from the given {@link HelicityState}. * * This must be the first helicity state in the next pattern. States * must be added serially and without skipped patterns. Requires - * {@link initialized} is false and a defined {@link #HelicityState}. + * {@link initialized} is false and a defined {@link HelicityState}. * * @param state the HelicityState to add to the sequence. */ diff --git a/common-tools/clas-detector/src/main/java/org/jlab/detector/helicity/HelicitySequence.java b/common-tools/clas-detector/src/main/java/org/jlab/detector/helicity/HelicitySequence.java index 1b18a38ebd..11ff2f9ea0 100644 --- a/common-tools/clas-detector/src/main/java/org/jlab/detector/helicity/HelicitySequence.java +++ b/common-tools/clas-detector/src/main/java/org/jlab/detector/helicity/HelicitySequence.java @@ -297,7 +297,7 @@ public HelicityBit predictGenerated(long timestamp) { * Get whether the pseudo-random generator is initialized. This must be * true before calling the predict methods, because they require a working * generator. The number of valid states required to intialize the generator - * is {@link HelicityGenerator.REGISTER_SIZE}. + * is {@link HelicityGenerator#REGISTER_SIZE}. * * @return whether initialized */ diff --git a/common-tools/clas-geometry/src/main/java/org/jlab/geom/detector/alert/AHDC/AlertDCWireIdentifier.java b/common-tools/clas-geometry/src/main/java/org/jlab/geom/detector/alert/AHDC/AlertDCWireIdentifier.java index fcf4caad2f..42b25fefba 100644 --- a/common-tools/clas-geometry/src/main/java/org/jlab/geom/detector/alert/AHDC/AlertDCWireIdentifier.java +++ b/common-tools/clas-geometry/src/main/java/org/jlab/geom/detector/alert/AHDC/AlertDCWireIdentifier.java @@ -171,7 +171,7 @@ else if (digit == 51) { /** * Convert layer number (from 0 to 7) to the superlayer-layer id (11,21,...,51) * - * @param digit between 0 and 7 + * @param num between 0 and 7 * @return layer number between (11,21,...,51) */ public static int number2layer(int num) { diff --git a/common-tools/clas-geometry/src/main/java/org/jlab/geom/detector/fmt/FMTSuperlayer.java b/common-tools/clas-geometry/src/main/java/org/jlab/geom/detector/fmt/FMTSuperlayer.java index 8bc20e0846..ca80eef8e1 100644 --- a/common-tools/clas-geometry/src/main/java/org/jlab/geom/detector/fmt/FMTSuperlayer.java +++ b/common-tools/clas-geometry/src/main/java/org/jlab/geom/detector/fmt/FMTSuperlayer.java @@ -7,13 +7,13 @@ /** * A Forward Micromegas Tracker (FMT) {@link org.jlab.geom.base.Superlayer Superlayer}. *

- * Factory: {@link org.jlab.geom.detector.cnd.FMTFactory FMTFactory}
+ * Factory: {@link org.jlab.geom.detector.fmt.FMTFactory FMTFactory}
* Hierarchy: * - * {@link org.jlab.geom.detector.cnd.FMTDetector FMTDetector} → - * {@link org.jlab.geom.detector.cnd.FMTSector FMTSector} → - * {@link org.jlab.geom.detector.cnd.FMTSuperlayer FMTSuperlayer} → - * {@link org.jlab.geom.detector.cnd.FMTLayer FMTLayer} → + * {@link org.jlab.geom.detector.fmt.FMTDetector FMTDetector} → + * {@link org.jlab.geom.detector.fmt.FMTSector FMTSector} → + * {@link org.jlab.geom.detector.fmt.FMTSuperlayer FMTSuperlayer} → + * {@link org.jlab.geom.detector.fmt.FMTLayer FMTLayer} → * {@link org.jlab.geom.component.TrackerStrip TrackerStrip} * * diff --git a/common-tools/clas-io/src/main/java/org/jlab/io/base/BasicDataBank.java b/common-tools/clas-io/src/main/java/org/jlab/io/base/BasicDataBank.java index 3d702c148b..05a63d2489 100644 --- a/common-tools/clas-io/src/main/java/org/jlab/io/base/BasicDataBank.java +++ b/common-tools/clas-io/src/main/java/org/jlab/io/base/BasicDataBank.java @@ -565,13 +565,13 @@ public TableModel getTableModel(String mask) { if(entryMask.contains(columns[loop])==true||entryMask.size()<2){ for(int row = 0; row < nrows; row++){ if(this.byteContainer.containsKey(columns[loop])==true){ - objects[row][loop] = new Byte(this.getByte(columns[loop], row)); + objects[row][loop] = this.getByte(columns[loop], row); } if(this.shortContainer.containsKey(columns[loop])==true){ - objects[row][loop] = new Short(this.getShort(columns[loop], row)); + objects[row][loop] = this.getShort(columns[loop], row); } if(this.intContainer.containsKey(columns[loop])==true){ - objects[row][loop] = new Integer(this.getInt(columns[loop], row)); + objects[row][loop] = this.getInt(columns[loop], row); } if(this.floatContainer.containsKey(columns[loop])==true){ //objects[row][loop] = new Float(this.getFloat(columns[loop], row)); @@ -581,7 +581,7 @@ public TableModel getTableModel(String mask) { objects[row][loop] = String.format("%12.5f",this.getDouble(columns[loop], row)); } if(this.longContainer.containsKey(columns[loop])==true){ - objects[row][loop] = new Long(this.getLong(columns[loop], row)); + objects[row][loop] = this.getLong(columns[loop], row); } } } diff --git a/common-tools/clas-jcsg/src/main/java/eu/mihosoft/vrl/v3d/VFX3DUtil.java b/common-tools/clas-jcsg/src/main/java/eu/mihosoft/vrl/v3d/VFX3DUtil.java index 0cf9a93388..81183edd78 100644 --- a/common-tools/clas-jcsg/src/main/java/eu/mihosoft/vrl/v3d/VFX3DUtil.java +++ b/common-tools/clas-jcsg/src/main/java/eu/mihosoft/vrl/v3d/VFX3DUtil.java @@ -40,12 +40,12 @@ import javafx.scene.transform.Rotate; /** - * Utility class that allows to visualize meshes created with null {@link MathUtil#evaluateFunction( + * Utility class that allows to visualize meshes created with null {@code MathUtil#evaluateFunction( * eu.mihosoft.vrl.javaone2013.math.Function2D, * int, int, float, float, float, double, double, double, double) * }. * - * @author Michael Hoffer + * written by Michael Hoffer (info@michaelhoffer.de) */ public class VFX3DUtil { diff --git a/common-tools/clas-jcsg/src/main/java/eu/mihosoft/vrl/v3d/Vector3d.java b/common-tools/clas-jcsg/src/main/java/eu/mihosoft/vrl/v3d/Vector3d.java index c09e23d45d..7d5cd20164 100644 --- a/common-tools/clas-jcsg/src/main/java/eu/mihosoft/vrl/v3d/Vector3d.java +++ b/common-tools/clas-jcsg/src/main/java/eu/mihosoft/vrl/v3d/Vector3d.java @@ -669,7 +669,7 @@ public Vector3d rotateZ(double angle) { * @param vector the vector to rotate * @param angle the angle of rotation * - * @author pdavies + * written by pdavies */ public void rotate(Vector3d vector, double angle) { double m = vector.magnitude(); @@ -695,7 +695,7 @@ public void rotate(Vector3d vector, double angle) { * @param point the other point * @return a point at the geometric mean of the two given points * - * @author pdavies + * written by pdavies */ public Vector3d midpoint(Vector3d point) { return lerp(point, 0.5); @@ -703,7 +703,7 @@ public Vector3d midpoint(Vector3d point) { /** * @return theta elevation (angle between vector and z axis) - * @author pdavies + * written by pdavies */ public double theta() { return (this.magnitude() < 2e-6) ? 1.0 : Math.acos(this.z / this.magnitude()); // special case at mag = 0 @@ -711,7 +711,7 @@ public double theta() { /** * @return phi azimuth (angle between projection onto xy plane and x axis) - * @author pdavies + * written by pdavies */ public double phi() { return Math.atan2(this.y, this.x); diff --git a/common-tools/clas-jcsg/src/main/java/eu/mihosoft/vrl/v3d/ext/openjfx/importers/obj/FloatArrayList.java b/common-tools/clas-jcsg/src/main/java/eu/mihosoft/vrl/v3d/ext/openjfx/importers/obj/FloatArrayList.java index 89f7853d89..d32d4d2b2a 100644 --- a/common-tools/clas-jcsg/src/main/java/eu/mihosoft/vrl/v3d/ext/openjfx/importers/obj/FloatArrayList.java +++ b/common-tools/clas-jcsg/src/main/java/eu/mihosoft/vrl/v3d/ext/openjfx/importers/obj/FloatArrayList.java @@ -94,7 +94,7 @@ * @see Collection * @see List * @see LinkedList - * @see Vector + * @see cnuphys.adaptiveSwim.geometry.Vector * * TODO replace with ObservableFloatArray */ @@ -358,7 +358,6 @@ public float[] toFloatArray() { * * @param index index of the element to return * @return the element at the specified position in this list - * @throws IndexOutOfBoundsException {@inheritDoc} */ @Override public Float get(int index) { rangeCheck(index); @@ -372,7 +371,6 @@ public float[] toFloatArray() { * @param index index of the element to replace * @param element element to be stored at the specified position * @return the element previously at the specified position - * @throws IndexOutOfBoundsException {@inheritDoc} */ @Override public Float set(int index, Float element) { rangeCheck(index); @@ -400,7 +398,7 @@ public float[] toFloatArray() { * * @param index index at which the specified element is to be inserted * @param element element to be inserted - * @throws IndexOutOfBoundsException {@inheritDoc} + * @throws IndexOutOfBoundsException */ @Override public void add(int index, Float element) { rangeCheckForAdd(index); @@ -419,7 +417,7 @@ public float[] toFloatArray() { * * @param index the index of the element to be removed * @return the element that was removed from the list - * @throws IndexOutOfBoundsException {@inheritDoc} + * @throws IndexOutOfBoundsException */ @Override public Float remove(int index) { rangeCheck(index); @@ -511,7 +509,7 @@ private void fastRemove(int index) { * @param index index at which to insert the first element from the specified collection * @param c collection containing elements to be added to this list * @return true if this list changed as a result of the call - * @throws IndexOutOfBoundsException {@inheritDoc} + * @throws IndexOutOfBoundsException * @throws NullPointerException if the specified collection is null */ @Override public boolean addAll(int index, Collection c) { @@ -687,7 +685,7 @@ private void readObject(java.io.ObjectInputStream s) *

*

The returned list iterator is fail-fast. * - * @throws IndexOutOfBoundsException {@inheritDoc} + * @throws IndexOutOfBoundsException */ @Override public ListIterator listIterator(int index) { if (index < 0 || index > size) @@ -840,8 +838,8 @@ private class ListItr extends Itr implements ListIterator { * that change the size of this list, or otherwise perturb it in such a fashion that iterations in progress may * yield incorrect results.) * - * @throws IndexOutOfBoundsException {@inheritDoc} - * @throws IllegalArgumentException {@inheritDoc} + * @throws IndexOutOfBoundsException + * @throws IllegalArgumentException */ @Override public List subList(int fromIndex, int toIndex) { subListRangeCheck(fromIndex, toIndex, size); diff --git a/common-tools/clas-jcsg/src/main/java/eu/mihosoft/vrl/v3d/ext/openjfx/importers/obj/IntegerArrayList.java b/common-tools/clas-jcsg/src/main/java/eu/mihosoft/vrl/v3d/ext/openjfx/importers/obj/IntegerArrayList.java index 1a8aa48469..26100b0471 100644 --- a/common-tools/clas-jcsg/src/main/java/eu/mihosoft/vrl/v3d/ext/openjfx/importers/obj/IntegerArrayList.java +++ b/common-tools/clas-jcsg/src/main/java/eu/mihosoft/vrl/v3d/ext/openjfx/importers/obj/IntegerArrayList.java @@ -359,7 +359,7 @@ public int[] toIntArray() { * * @param index index of the element to return * @return the element at the specified position in this list - * @throws IndexOutOfBoundsException {@inheritDoc} + * @throws IndexOutOfBoundsException */ @Override public Integer get(int index) { rangeCheck(index); @@ -373,7 +373,7 @@ public int[] toIntArray() { * @param index index of the element to replace * @param element element to be stored at the specified position * @return the element previously at the specified position - * @throws IndexOutOfBoundsException {@inheritDoc} + * @throws IndexOutOfBoundsException */ @Override public Integer set(int index, Integer element) { rangeCheck(index); @@ -401,7 +401,7 @@ public int[] toIntArray() { * * @param index index at which the specified element is to be inserted * @param element element to be inserted - * @throws IndexOutOfBoundsException {@inheritDoc} + * @throws IndexOutOfBoundsException */ @Override public void add(int index, Integer element) { rangeCheckForAdd(index); @@ -420,7 +420,7 @@ public int[] toIntArray() { * * @param index the index of the element to be removed * @return the element that was removed from the list - * @throws IndexOutOfBoundsException {@inheritDoc} + * @throws IndexOutOfBoundsException */ @Override public Integer remove(int index) { rangeCheck(index); @@ -512,7 +512,7 @@ private void fastRemove(int index) { * @param index index at which to insert the first element from the specified collection * @param c collection containing elements to be added to this list * @return true if this list changed as a result of the call - * @throws IndexOutOfBoundsException {@inheritDoc} + * @throws IndexOutOfBoundsException * @throws NullPointerException if the specified collection is null */ @Override public boolean addAll(int index, Collection c) { @@ -688,7 +688,7 @@ private void readObject(java.io.ObjectInputStream s) *

*

The returned list iterator is fail-fast. * - * @throws IndexOutOfBoundsException {@inheritDoc} + * @throws IndexOutOfBoundsException */ @Override public ListIterator listIterator(int index) { if (index < 0 || index > size) @@ -841,8 +841,8 @@ private class ListItr extends Itr implements ListIterator { * that change the size of this list, or otherwise perturb it in such a fashion that iterations in progress may * yield incorrect results.) * - * @throws IndexOutOfBoundsException {@inheritDoc} - * @throws IllegalArgumentException {@inheritDoc} + * @throws IndexOutOfBoundsException + * @throws IllegalArgumentException */ @Override public List subList(int fromIndex, int toIndex) { subListRangeCheck(fromIndex, toIndex, size); diff --git a/common-tools/clas-jcsg/src/main/java/org/jlab/detector/geant4/v2/MPGD/trapezoid/MPGDTrapezoidStripFactory.java b/common-tools/clas-jcsg/src/main/java/org/jlab/detector/geant4/v2/MPGD/trapezoid/MPGDTrapezoidStripFactory.java index 2902e80b14..81311d15a4 100644 --- a/common-tools/clas-jcsg/src/main/java/org/jlab/detector/geant4/v2/MPGD/trapezoid/MPGDTrapezoidStripFactory.java +++ b/common-tools/clas-jcsg/src/main/java/org/jlab/detector/geant4/v2/MPGD/trapezoid/MPGDTrapezoidStripFactory.java @@ -33,8 +33,8 @@ protected MPGDTrapezoidStripFactory(MPGDTrapezoidConstants constants) { /** * Detector-specific hook: Must return the volume object given its - * name.Typically implemented by indexing geo.getAllVolumes() into a - * Map. + * name.Typically implemented by indexing {@code geo.getAllVolumes()} into a + * {@code Map}. * * @param name * @return diff --git a/common-tools/clas-jcsg/src/main/java/org/jlab/detector/geant4/v2/RICHGeant4Factory.java b/common-tools/clas-jcsg/src/main/java/org/jlab/detector/geant4/v2/RICHGeant4Factory.java index 7a6d2047fb..4ca4611e94 100644 --- a/common-tools/clas-jcsg/src/main/java/org/jlab/detector/geant4/v2/RICHGeant4Factory.java +++ b/common-tools/clas-jcsg/src/main/java/org/jlab/detector/geant4/v2/RICHGeant4Factory.java @@ -303,8 +303,8 @@ else if(Layernr == 302){ } /** * @author: gangel - * @param layer nr, component nr - * Layer can be (Aerogel) 201,202,203,204, (Planar Mirror) 301, (Spherical Mirror)302 + * @param Layer_nr Layer can be (Aerogel) 201,202,203,204, (Planar Mirror) 301, (Spherical Mirror)302 + * @param Component_nr * @return: the G4Stl file */ public G4Stl getStlComponent(int Layer_nr , int Component_nr){ diff --git a/common-tools/clas-jcsg/src/main/java/org/jlab/detector/geant4/v2/SVT/SVTVolumeFactory.java b/common-tools/clas-jcsg/src/main/java/org/jlab/detector/geant4/v2/SVT/SVTVolumeFactory.java index a30966c03b..61a758d20f 100644 --- a/common-tools/clas-jcsg/src/main/java/org/jlab/detector/geant4/v2/SVT/SVTVolumeFactory.java +++ b/common-tools/clas-jcsg/src/main/java/org/jlab/detector/geant4/v2/SVT/SVTVolumeFactory.java @@ -98,6 +98,7 @@ public class SVTVolumeFactory * Default: false * @deprecated */ + @Deprecated public boolean HALFBOXES = false; diff --git a/common-tools/clas-jcsg/src/main/java/org/jlab/detector/geant4/v2/SVT/Util.java b/common-tools/clas-jcsg/src/main/java/org/jlab/detector/geant4/v2/SVT/Util.java index 0e8629cd74..26e3f9474a 100644 --- a/common-tools/clas-jcsg/src/main/java/org/jlab/detector/geant4/v2/SVT/Util.java +++ b/common-tools/clas-jcsg/src/main/java/org/jlab/detector/geant4/v2/SVT/Util.java @@ -465,30 +465,6 @@ public static void scalePosition( Geant4Basic aVol, double aFactor ) } - /** - * Recursively multiplies each linear dimension of the given volume and its children by the given scale factor. - * - * @param aVol volume - * @param aFactor scale factor - * @deprecated - */ - /* - public static void scaleDimensions( Geant4Basic aVol, double aFactor, boolean bRecursive ) - { - aVol.scaleDimensions( aFactor ); - //aVol.scale( aFactor ); - - if( bRecursive ) - { - List children = aVol.getChildren(); - for( int i = 0; i < children.size(); i++ ) - { - scaleDimensions( children.get(i), aFactor, true ); // tail recursive - } - } - } - */ - /** * Translates the given volume's position by the given shifts. * diff --git a/common-tools/clas-jcsg/src/main/java/org/jlab/detector/volume/Geant4Basic.java b/common-tools/clas-jcsg/src/main/java/org/jlab/detector/volume/Geant4Basic.java index 0afbc77f04..60f02471d4 100644 --- a/common-tools/clas-jcsg/src/main/java/org/jlab/detector/volume/Geant4Basic.java +++ b/common-tools/clas-jcsg/src/main/java/org/jlab/detector/volume/Geant4Basic.java @@ -347,16 +347,12 @@ public Line3d getLineZ() { //return new Line3d(new Vector3d(0, 0, 0), new Vector3d(0, 0, 0)); } - /** - * @author pdavies - */ + // written by pdavies public void setPosition(double x, double y, double z) { setPosition(new Vector3d(x, y, z)); } - /** - * @author pdavies - */ + // written by pdavies public void setPosition(Vector3d position) { this.translate(position.minus(this.getLocalPosition())); } diff --git a/common-tools/clas-jcsg/src/main/java/org/jlab/geometry/prim/Triangle3d.java b/common-tools/clas-jcsg/src/main/java/org/jlab/geometry/prim/Triangle3d.java index 1bab1dc38e..ad0ff0e005 100644 --- a/common-tools/clas-jcsg/src/main/java/org/jlab/geometry/prim/Triangle3d.java +++ b/common-tools/clas-jcsg/src/main/java/org/jlab/geometry/prim/Triangle3d.java @@ -91,7 +91,7 @@ else if(!interpoints.isEmpty()) { } /** - * @author pdavies + * written by pdavies */ public Vector3d center() { double x = 0; @@ -107,7 +107,7 @@ public Vector3d center() { } /** - * @author pdavies + * written by pdavies */ public Vector3d point(int index) { if( index < 0 || index > 2 ) diff --git a/common-tools/clas-logging/src/main/java/org/jlab/logging/SplitLogManager.java b/common-tools/clas-logging/src/main/java/org/jlab/logging/SplitLogManager.java index 8ade3eba96..9740970f49 100644 --- a/common-tools/clas-logging/src/main/java/org/jlab/logging/SplitLogManager.java +++ b/common-tools/clas-logging/src/main/java/org/jlab/logging/SplitLogManager.java @@ -25,7 +25,7 @@ public Logger getLogger(String name) { /** * add a new {@link Logger} instance - * @param name the name of the logger + * @param logger the logger * @return {@code true} if the argument logger was registered successfully, {@code false} if a logger of that name already exists */ @Override diff --git a/common-tools/clas-reco/src/main/java/org/jlab/clas/detector/DetectorParticle.java b/common-tools/clas-reco/src/main/java/org/jlab/clas/detector/DetectorParticle.java index 0f91b9d707..34c1d5d599 100644 --- a/common-tools/clas-reco/src/main/java/org/jlab/clas/detector/DetectorParticle.java +++ b/common-tools/clas-reco/src/main/java/org/jlab/clas/detector/DetectorParticle.java @@ -239,6 +239,7 @@ public int getSector(DetectorType type) { * @deprecated * Just for backward compatibility for any external usage */ + @Deprecated public int getSector(){ return this.getSector(DetectorType.ECAL,1); } @@ -313,6 +314,7 @@ public DetectorResponse getHit(DetectorType type, int layer) { * @deprecated * Just for backward compatibility for any external usage */ + @Deprecated public DetectorResponse getResponse(DetectorType type, int layer){ return this.getHit(type,layer); } diff --git a/common-tools/clas-reco/src/main/java/org/jlab/clas/reco/ReconstructionEngine.java b/common-tools/clas-reco/src/main/java/org/jlab/clas/reco/ReconstructionEngine.java index ca84dda768..fa53b15a1c 100644 --- a/common-tools/clas-reco/src/main/java/org/jlab/clas/reco/ReconstructionEngine.java +++ b/common-tools/clas-reco/src/main/java/org/jlab/clas/reco/ReconstructionEngine.java @@ -259,7 +259,6 @@ protected String getStringConfigParameter(String jsonString, * @param group config parameter group. * @param key the key of the config parameter. * @return parameter: String value - * @throws ClasEngineException org.jlab.clara.clas engine exception */ protected String getStringConfigParameter(String jsonString, String group, diff --git a/common-tools/clas-tracking/src/main/java/org/jlab/clas/tracking/trackrep/Helix.java b/common-tools/clas-tracking/src/main/java/org/jlab/clas/tracking/trackrep/Helix.java index 172e39b070..39582caf7b 100644 --- a/common-tools/clas-tracking/src/main/java/org/jlab/clas/tracking/trackrep/Helix.java +++ b/common-tools/clas-tracking/src/main/java/org/jlab/clas/tracking/trackrep/Helix.java @@ -427,7 +427,7 @@ public Vector3D getMomentumAtZ(double z) { * pathlength = integral of d(l) from l(rMin) to l(rMax) pathlength = * sqrt(R^2omega^2+tanL^2)*(l(rMax)-l(rMin)) * - * @author pilleux + * Written by pilleux * */ public double getPathLength(double rMin, double rMax) { diff --git a/common-tools/cnuphys/magfield/src/main/java/cnuphys/magfield/Cell3D.java b/common-tools/cnuphys/magfield/src/main/java/cnuphys/magfield/Cell3D.java index 7562b86019..ac6210d23a 100644 --- a/common-tools/cnuphys/magfield/src/main/java/cnuphys/magfield/Cell3D.java +++ b/common-tools/cnuphys/magfield/src/main/java/cnuphys/magfield/Cell3D.java @@ -99,9 +99,9 @@ public boolean contained(double q1, double q2, double q3) { /** * Calculate the field in kG by trilinear interpolation * - * @param phi the phi coordinate in degrees - * @param rho the rho coordinate in cm - * @param z the z component in cm + * @param q1 + * @param q2 + * @param q3 * @param result the field in kG */ public void trilinear(double q1, double q2, double q3, float[] result) { @@ -135,9 +135,9 @@ public void trilinear(double q1, double q2, double q3, float[] result) { /** * Calculate the field in kG * - * @param phi the phi coordinate in degrees - * @param rho the rho coordinate in cm - * @param z the z coordinate int cm + * @param q1 + * @param q2 + * @param q3 * @param result the field in kG */ public void calculate(double q1, double q2, double q3, float[] result) { diff --git a/common-tools/cnuphys/magfield/src/main/java/cnuphys/magfield/IField.java b/common-tools/cnuphys/magfield/src/main/java/cnuphys/magfield/IField.java index d448feb4d0..9f4ef3558c 100644 --- a/common-tools/cnuphys/magfield/src/main/java/cnuphys/magfield/IField.java +++ b/common-tools/cnuphys/magfield/src/main/java/cnuphys/magfield/IField.java @@ -32,9 +32,9 @@ public interface IField { * system. The field is returned as a Cartesian vector in kiloGauss. * * @param sector the sector [1..6] - * @param x the x sector coordinate in cm - * @param y the y sector coordinate in cm - * @param z the z sector coordinate in cm + * @param xs the x sector coordinate in cm + * @param ys the y sector coordinate in cm + * @param zs the z sector coordinate in cm * @param result the result is a float array holding the retrieved field in * kiloGauss. The 0,1 and 2 indices correspond to x, y, and z * components. diff --git a/common-tools/cnuphys/magfield/src/main/java/cnuphys/magfield/MagneticFields.java b/common-tools/cnuphys/magfield/src/main/java/cnuphys/magfield/MagneticFields.java index f368a46e44..0e5844a136 100644 --- a/common-tools/cnuphys/magfield/src/main/java/cnuphys/magfield/MagneticFields.java +++ b/common-tools/cnuphys/magfield/src/main/java/cnuphys/magfield/MagneticFields.java @@ -1568,7 +1568,7 @@ public static void sectorToLab(int sector, float lab[], float x, float y, float * Converts the clas (lab) 3D coordinates to sector 3D coordinates to * * @param sector the 1-based sector [1..6] - * @param lab will hold the lab 3D Cartesian coordinates (modified) + * @param sect * @param x the lab x coordinate * @param y the lab y coordinate * @param z the lab z coordinate diff --git a/common-tools/cnuphys/magfield/src/main/java/cnuphys/magfield/RotatedCompositeProbe.java b/common-tools/cnuphys/magfield/src/main/java/cnuphys/magfield/RotatedCompositeProbe.java index d9a9df7caa..59a38cf9bc 100644 --- a/common-tools/cnuphys/magfield/src/main/java/cnuphys/magfield/RotatedCompositeProbe.java +++ b/common-tools/cnuphys/magfield/src/main/java/cnuphys/magfield/RotatedCompositeProbe.java @@ -181,9 +181,9 @@ public void field(float xs, float ys, float zs, float[] result) { * expressed in Cartesian coordinates. The field is returned as a Cartesian * vector in kiloGauss/cm. * - * @param x the x coordinate in cm - * @param y the y coordinate in cm - * @param z the z coordinate in cm + * @param xs the x coordinate in cm + * @param ys the y coordinate in cm + * @param zs the z coordinate in cm * @param result a float array holding the retrieved field in kiloGauss. The 0,1 * and 2 indices correspond to x, y, and z components. */ diff --git a/common-tools/cnuphys/snr/src/main/java/cnuphys/snr/ExtendedWord.java b/common-tools/cnuphys/snr/src/main/java/cnuphys/snr/ExtendedWord.java index 9eac1ad94f..1c46d81520 100644 --- a/common-tools/cnuphys/snr/src/main/java/cnuphys/snr/ExtendedWord.java +++ b/common-tools/cnuphys/snr/src/main/java/cnuphys/snr/ExtendedWord.java @@ -699,7 +699,7 @@ else if (Character.isLowerCase(ch)) { * Encode a long into a base 62 String. Based on the toString implementation in * the Java Long class. * - * @param number the number to encode + * @param num the number to encode * @return a base 62 number */ public static String encode62(long num) { diff --git a/common-tools/cnuphys/snr/src/main/java/cnuphys/snr/NoiseReductionParameters.java b/common-tools/cnuphys/snr/src/main/java/cnuphys/snr/NoiseReductionParameters.java index 24bddcd737..91a9b4ca00 100644 --- a/common-tools/cnuphys/snr/src/main/java/cnuphys/snr/NoiseReductionParameters.java +++ b/common-tools/cnuphys/snr/src/main/java/cnuphys/snr/NoiseReductionParameters.java @@ -353,7 +353,7 @@ public void packHit(int layer, int wire) { /** * Set new raw data. The analyzed flag is set to false. * - * @param rawData the new raw data to set. + * @param packedData */ public void setPackedData(ExtendedWord[] packedData) { _rawData = packedData; diff --git a/common-tools/cnuphys/snr/src/main/java/cnuphys/snr/SNRCluster.java b/common-tools/cnuphys/snr/src/main/java/cnuphys/snr/SNRCluster.java index 64e6a8f209..82eb7b8fc7 100644 --- a/common-tools/cnuphys/snr/src/main/java/cnuphys/snr/SNRCluster.java +++ b/common-tools/cnuphys/snr/src/main/java/cnuphys/snr/SNRCluster.java @@ -54,7 +54,6 @@ public void add(int layer, int wire) { /** * Add a segment (candidate) start wire * @param wire the zero-based wire, for CLAS12 [0..111] - * @param numMissing the number of missing layers required */ public void addSegmentStart(int wire) { segmentStartList.add(wire); diff --git a/common-tools/cnuphys/snr/src/main/java/cnuphys/snr/test/ChamberTest.java b/common-tools/cnuphys/snr/src/main/java/cnuphys/snr/test/ChamberTest.java index 04587397ad..62f996b1d7 100644 --- a/common-tools/cnuphys/snr/src/main/java/cnuphys/snr/test/ChamberTest.java +++ b/common-tools/cnuphys/snr/src/main/java/cnuphys/snr/test/ChamberTest.java @@ -75,8 +75,9 @@ public class ChamberTest { /** * Create a test chamber--rectangular with uniform rectangular cells. * + * @param detectorTest * @param index the index in the DetectorTest collection - * @param name the name of the chamber. + * @param parameters * @param boundary the rectangular boundary in world coordinates. */ public ChamberTest(DetectorTest detectorTest, int index, NoiseReductionParameters parameters, @@ -335,7 +336,6 @@ protected void drawCellOutlines(Graphics g, Rectangle2D.Double world, Rectangle * @param g * @param world * @param local - * @param candidates */ protected void drawLeftSegmentCandidates(Graphics g, Rectangle2D.Double world, Rectangle local) { @@ -366,7 +366,6 @@ protected void drawLeftSegmentCandidates(Graphics g, Rectangle2D.Double world, R * @param g * @param world * @param local - * @param candidates */ protected void drawRightSegmentCandidates(Graphics g, Rectangle2D.Double world, Rectangle local) { @@ -832,8 +831,6 @@ public HitTest findHit(int layer, int wire) { /** * Generate hits from a straight line track * - * @param world the world system. - * @param local the local system. * @param tt the track used to generate hits. */ public void hitsFromTrack(TrackTest tt) { diff --git a/common-tools/cnuphys/snr/src/main/java/cnuphys/snr/test/DetectorTest.java b/common-tools/cnuphys/snr/src/main/java/cnuphys/snr/test/DetectorTest.java index f84b868d05..2be589d555 100644 --- a/common-tools/cnuphys/snr/src/main/java/cnuphys/snr/test/DetectorTest.java +++ b/common-tools/cnuphys/snr/src/main/java/cnuphys/snr/test/DetectorTest.java @@ -341,7 +341,6 @@ public void restoreDefaultWorld() { } /** - * @param name the name of the chamber. * @param boundary the rectangular boundary in world coordinates. */ public void addChamber(Rectangle2D.Double boundary) { diff --git a/common-tools/cnuphys/splot/src/main/java/cnuphys/splot/fit/ANonlinearFit.java b/common-tools/cnuphys/splot/src/main/java/cnuphys/splot/fit/ANonlinearFit.java index 38eec68929..21a6adcdaa 100644 --- a/common-tools/cnuphys/splot/src/main/java/cnuphys/splot/fit/ANonlinearFit.java +++ b/common-tools/cnuphys/splot/src/main/java/cnuphys/splot/fit/ANonlinearFit.java @@ -17,7 +17,6 @@ public abstract class ANonlinearFit implements IValueGetter { * Create a Error function Fit * * @param fit the fit data - * @param tolerance the tolerance */ public ANonlinearFit(Fit fit) throws IllegalArgumentException { diff --git a/common-tools/cnuphys/splot/src/main/java/cnuphys/splot/fit/ErfFit.java b/common-tools/cnuphys/splot/src/main/java/cnuphys/splot/fit/ErfFit.java index 83811d2787..d4dfce36bc 100644 --- a/common-tools/cnuphys/splot/src/main/java/cnuphys/splot/fit/ErfFit.java +++ b/common-tools/cnuphys/splot/src/main/java/cnuphys/splot/fit/ErfFit.java @@ -20,7 +20,6 @@ public class ErfFit extends Fitmrq implements IValueGetter { * Create a Error function Fit and perform the fit * * @param fit the fit data - * @param tolerance the tolerance */ public ErfFit(Fit fit) throws IllegalArgumentException { super(fit.getX(), fit.getY(), fit.getSigmaY(), initialGuess(fit), _funcs, fit.getTolerance()); diff --git a/common-tools/cnuphys/splot/src/main/java/cnuphys/splot/fit/ErfcFit.java b/common-tools/cnuphys/splot/src/main/java/cnuphys/splot/fit/ErfcFit.java index feb0e37c98..fee264d927 100644 --- a/common-tools/cnuphys/splot/src/main/java/cnuphys/splot/fit/ErfcFit.java +++ b/common-tools/cnuphys/splot/src/main/java/cnuphys/splot/fit/ErfcFit.java @@ -15,7 +15,6 @@ public class ErfcFit extends Fitmrq implements IValueGetter { * Create a Error function Fit * * @param fit the fit data - * @param tolerance the tolerance */ public ErfcFit(Fit fit) throws IllegalArgumentException { super(fit.getX(), fit.getY(), fit.getSigmaY(), initialGuess(fit), _funcs, fit.getTolerance()); @@ -132,4 +131,4 @@ public double value(double x) { return A + B * _erf.erfc((x - MU) / S); } -} \ No newline at end of file +} diff --git a/common-tools/cnuphys/splot/src/main/java/cnuphys/splot/fit/FitEditorPanel.java b/common-tools/cnuphys/splot/src/main/java/cnuphys/splot/fit/FitEditorPanel.java index 4eabcff137..3885166c28 100644 --- a/common-tools/cnuphys/splot/src/main/java/cnuphys/splot/fit/FitEditorPanel.java +++ b/common-tools/cnuphys/splot/src/main/java/cnuphys/splot/fit/FitEditorPanel.java @@ -237,7 +237,7 @@ private void carefulAdd(Component comp) { /** * FitEditorPanel Set the choices * - * @param fit the new choices + * @param curve the new choices */ public void setFit(DataColumn curve) { diff --git a/common-tools/cnuphys/splot/src/main/java/cnuphys/splot/fit/FitType.java b/common-tools/cnuphys/splot/src/main/java/cnuphys/splot/fit/FitType.java index fbf5e7ce7c..79a93e2e64 100644 --- a/common-tools/cnuphys/splot/src/main/java/cnuphys/splot/fit/FitType.java +++ b/common-tools/cnuphys/splot/src/main/java/cnuphys/splot/fit/FitType.java @@ -81,7 +81,7 @@ public static FitType getValue(String name) { /** * Get an html string the describes the fit * - * @param object the fit object that will have to be cast appropriately + * @param curveFit the fit object that will have to be cast appropriately * @return an html string the describes the fit */ public static String getFitString(Fit curveFit) { diff --git a/common-tools/cnuphys/splot/src/main/java/cnuphys/splot/fit/FitUtilities.java b/common-tools/cnuphys/splot/src/main/java/cnuphys/splot/fit/FitUtilities.java index 94a69277e7..a6e97f50c2 100644 --- a/common-tools/cnuphys/splot/src/main/java/cnuphys/splot/fit/FitUtilities.java +++ b/common-tools/cnuphys/splot/src/main/java/cnuphys/splot/fit/FitUtilities.java @@ -8,10 +8,7 @@ public class FitUtilities { /** * A Straight line fit with errors in y * - * @param _x the x data - * @param _y the y data - * @param sigma the errors on the y data - * @return the fit a + bx + * @param fit */ public static void fitStraightLine(Fit fit) { fixNullSig(fit); @@ -329,9 +326,7 @@ else if (n == 1) { * repleaces all zero values with the mean value. At that point the fit should * be considered suspect. * - * @param sig the sigma array, which might be null - * @param n the length of the array, if it has to be created - * @return a hopefully safe sigma array + * @param fit */ protected static void fixNullSig(Fit fit) { diff --git a/common-tools/cnuphys/splot/src/main/java/cnuphys/splot/fit/GaussianFit.java b/common-tools/cnuphys/splot/src/main/java/cnuphys/splot/fit/GaussianFit.java index 3d678c64a1..e88470967d 100644 --- a/common-tools/cnuphys/splot/src/main/java/cnuphys/splot/fit/GaussianFit.java +++ b/common-tools/cnuphys/splot/src/main/java/cnuphys/splot/fit/GaussianFit.java @@ -23,7 +23,6 @@ public class GaussianFit extends Fitmrq implements IValueGetter { * Create a Gaussian Fit * * @param fit the fit data - * @param tolerance the tolerance */ public GaussianFit(Fit fit) throws IllegalArgumentException { super(fit.getX(), fit.getY(), fit.getSigmaY(), initialGuess(fit), _funcs, fit.getTolerance()); @@ -45,9 +44,7 @@ private static boolean tinyDiff(double x1, double x2) { /** * A method to generate an initial guess * - * @param xx the x data - * @param yy the y data - * @param numGauss the number of gaussians + * @param fit * @return */ public static double[] initialGuess(Fit fit) { @@ -140,9 +137,7 @@ public static double[] initialGuess(Fit fit) { /** * A method to generate an initial guess * - * @param xx the x data - * @param yy the y data - * @param numGauss the number of gaussians + * @param fit * @return */ public static double[] secondaryInitialGuess(Fit fit) { diff --git a/common-tools/cnuphys/splot/src/main/java/cnuphys/splot/fit/PolyAndGaussianFit.java b/common-tools/cnuphys/splot/src/main/java/cnuphys/splot/fit/PolyAndGaussianFit.java index 497243ef39..52aec78840 100644 --- a/common-tools/cnuphys/splot/src/main/java/cnuphys/splot/fit/PolyAndGaussianFit.java +++ b/common-tools/cnuphys/splot/src/main/java/cnuphys/splot/fit/PolyAndGaussianFit.java @@ -13,7 +13,6 @@ public class PolyAndGaussianFit extends Fitmrq implements IValueGetter { /** * * @param fit the fit data - * @param tolerance */ public PolyAndGaussianFit(Fit fit) { super(fit.getX(), fit.getY(), fit.getSigmaY(), initialGuess(fit), diff --git a/common-tools/cnuphys/splot/src/main/java/cnuphys/splot/pdata/DataSet.java b/common-tools/cnuphys/splot/src/main/java/cnuphys/splot/pdata/DataSet.java index 42306fd169..6fd00ba54a 100644 --- a/common-tools/cnuphys/splot/src/main/java/cnuphys/splot/pdata/DataSet.java +++ b/common-tools/cnuphys/splot/src/main/java/cnuphys/splot/pdata/DataSet.java @@ -512,7 +512,7 @@ public int getCurveCount() { /** * Has any data been added * - * @return true<.code> if any data has been added. + * @return {@code true} if any data has been added. */ public boolean dataAdded() { for (DataColumn col : _columns) { diff --git a/common-tools/cnuphys/splot/src/main/java/cnuphys/splot/pdata/Histo2DData.java b/common-tools/cnuphys/splot/src/main/java/cnuphys/splot/pdata/Histo2DData.java index d6eb9abcef..b4d634ad28 100644 --- a/common-tools/cnuphys/splot/src/main/java/cnuphys/splot/pdata/Histo2DData.java +++ b/common-tools/cnuphys/splot/src/main/java/cnuphys/splot/pdata/Histo2DData.java @@ -44,9 +44,12 @@ public class Histo2DData { * @param name the name * @param xname the x variable name * @param yname the y variable name - * @param valMin the data min - * @param valMax the data max - * @param numBins the number of bins + * @param valMinX + * @param valMaxX + * @param numBinsX + * @param valMinY + * @param valMaxY + * @param numBinsY */ public Histo2DData(String name, String xname, String yname, double valMinX, double valMaxX, int numBinsX, double valMinY, double valMaxY, int numBinsY) { @@ -61,7 +64,9 @@ public Histo2DData(String name, String xname, String yname, double valMinX, doub * @param name the curve name of the histogram * @param xname the x variable name * @param yname the y variable name - * @param grid the binning grid. It must be in ascending order but is otherwise + * @param gridX the binning grid. It must be in ascending order but is otherwise + * arbitrary. + * @param gridY the binning grid. It must be in ascending order but is otherwise * arbitrary. */ public Histo2DData(String name, String xname, String yname, double[] gridX, double[] gridY) { @@ -235,7 +240,8 @@ public long getMaxCount() { /** * Add a value to the histogram * - * @param value the value to ad + * @param valueX the value to add + * @param valueY the value to add */ public void add(double valueX, double valueY) { diff --git a/common-tools/cnuphys/splot/src/main/java/cnuphys/splot/pdata/HistoData.java b/common-tools/cnuphys/splot/src/main/java/cnuphys/splot/pdata/HistoData.java index 2639c41c18..14b9271614 100644 --- a/common-tools/cnuphys/splot/src/main/java/cnuphys/splot/pdata/HistoData.java +++ b/common-tools/cnuphys/splot/src/main/java/cnuphys/splot/pdata/HistoData.java @@ -193,7 +193,6 @@ public double[] getBasicStatistics() { /** * A string displaying some statistics * - * @param useRms if true use rms, else use sigma * @return a string with statistics info */ public String statStr() { diff --git a/common-tools/cnuphys/splot/src/main/java/cnuphys/splot/plot/CurveDrawer.java b/common-tools/cnuphys/splot/src/main/java/cnuphys/splot/plot/CurveDrawer.java index 99a8a09e5f..adf9cca9ba 100644 --- a/common-tools/cnuphys/splot/src/main/java/cnuphys/splot/plot/CurveDrawer.java +++ b/common-tools/cnuphys/splot/src/main/java/cnuphys/splot/plot/CurveDrawer.java @@ -73,7 +73,7 @@ public static void drawHisto2D(Graphics g, PlotCanvas canvas, DataColumn histoCo * Draw a 1D histogram * * @param g the graphics context - * @param plotCanvas the plot canvas + * @param canvas the plot canvas * @param histoColumn the column (should contain a HistData object) */ public static void drawHisto1D(Graphics g, PlotCanvas canvas, DataColumn histoColumn) { diff --git a/common-tools/cnuphys/splot/src/main/java/cnuphys/splot/plot/DoubleFormat.java b/common-tools/cnuphys/splot/src/main/java/cnuphys/splot/plot/DoubleFormat.java index 761751382e..c2ce875d9c 100644 --- a/common-tools/cnuphys/splot/src/main/java/cnuphys/splot/plot/DoubleFormat.java +++ b/common-tools/cnuphys/splot/src/main/java/cnuphys/splot/plot/DoubleFormat.java @@ -82,7 +82,7 @@ public static String doubleFormat(double value, int numdec, boolean scinot) { * * @param value the value to format. * @param numdec the number of digits right of the decimal. If the - * exponenent is >= n or <= -n it will use sci notation. + * exponenent is {@code >= n} or {@code <= -n} it will use sci notation. * @param minExponent the minimum (absolute value) index for scientific * notation. */ @@ -122,4 +122,4 @@ public static void main(String[] args) { } } -} \ No newline at end of file +} diff --git a/common-tools/cnuphys/splot/src/main/java/cnuphys/splot/plot/GraphicsUtilities.java b/common-tools/cnuphys/splot/src/main/java/cnuphys/splot/plot/GraphicsUtilities.java index 5214c245de..92cbd83503 100644 --- a/common-tools/cnuphys/splot/src/main/java/cnuphys/splot/plot/GraphicsUtilities.java +++ b/common-tools/cnuphys/splot/src/main/java/cnuphys/splot/plot/GraphicsUtilities.java @@ -1282,7 +1282,9 @@ public static void drawArrow(Graphics g1, int x, int y, int xx, int yy, boolean * Draw a styled line * * @param g the graphics context - * @param style the style + * @param lineColor + * @param lineWidth + * @param lineStyle * @param x1 starting x * @param y1 starting y * @param x2 ending x @@ -1384,10 +1386,7 @@ public static Container getParentContainer(Component c) { /** * Initialize the look and feel. - * - * @param desiredLnf the desired look and feel. */ - public static void initializeLookAndFeel() { LookAndFeelInfo[] lnfinfo = UIManager.getInstalledLookAndFeels(); @@ -1435,4 +1434,4 @@ public static void main(String arg[]) { } } -} \ No newline at end of file +} diff --git a/common-tools/cnuphys/splot/src/main/java/cnuphys/splot/plot/PlotPanel.java b/common-tools/cnuphys/splot/src/main/java/cnuphys/splot/plot/PlotPanel.java index ae04a11c29..85d3f44641 100644 --- a/common-tools/cnuphys/splot/src/main/java/cnuphys/splot/plot/PlotPanel.java +++ b/common-tools/cnuphys/splot/src/main/java/cnuphys/splot/plot/PlotPanel.java @@ -49,8 +49,7 @@ public class PlotPanel extends JPanel implements PropertyChangeListener { /** * Create a plot panel for a single xy dataset and a toolbar * - * @param dataSet the data set - * @param plotTitle the title of the plot + * @param canvas */ public PlotPanel(PlotCanvas canvas) { this(canvas, STANDARD); @@ -59,8 +58,7 @@ public PlotPanel(PlotCanvas canvas) { /** * Create a plot panel for a single xy dataset * - * @param dataSet the data set - * @param plotTitle the title of the plot + * @param canvas * @param decorations (stripped down panel?) */ public PlotPanel(PlotCanvas canvas, int decorations) { diff --git a/common-tools/cnuphys/splot/src/main/java/cnuphys/splot/plot/PlotParameters.java b/common-tools/cnuphys/splot/src/main/java/cnuphys/splot/plot/PlotParameters.java index 0489369a93..acc0f250f7 100644 --- a/common-tools/cnuphys/splot/src/main/java/cnuphys/splot/plot/PlotParameters.java +++ b/common-tools/cnuphys/splot/src/main/java/cnuphys/splot/plot/PlotParameters.java @@ -608,8 +608,8 @@ public void setXRange(double xmin, double xmax) { /** * Manually set the y range * - * @param xmin the minimum y - * @param xmax the maximum y + * @param ymin the minimum y + * @param ymax the maximum y */ public void setYRange(double ymin, double ymax) { setYLimitsMethod(LimitsMethod.MANUALLIMITS); diff --git a/common-tools/cnuphys/splot/src/main/java/cnuphys/splot/plot/StripChartPanel.java b/common-tools/cnuphys/splot/src/main/java/cnuphys/splot/plot/StripChartPanel.java index 3550c8325f..3c682758fa 100644 --- a/common-tools/cnuphys/splot/src/main/java/cnuphys/splot/plot/StripChartPanel.java +++ b/common-tools/cnuphys/splot/src/main/java/cnuphys/splot/plot/StripChartPanel.java @@ -36,8 +36,12 @@ public class StripChartPanel extends JPanel { /** * Create a plot panel for a single xy dataset and a toolbar * - * @param dataSet the data set - * @param plotTitle the title of the plot + * @param title + * @param xLabel + * @param yLabel + * @param getter + * @param capacity + * @param interval */ public StripChartPanel(String title, String xLabel, String yLabel, IValueGetter getter, int capacity, long interval) { diff --git a/common-tools/cnuphys/splot/src/main/java/cnuphys/splot/plot/VerticalLabelUI.java b/common-tools/cnuphys/splot/src/main/java/cnuphys/splot/plot/VerticalLabelUI.java index 3ce24e6de0..15ed56ebe7 100644 --- a/common-tools/cnuphys/splot/src/main/java/cnuphys/splot/plot/VerticalLabelUI.java +++ b/common-tools/cnuphys/splot/src/main/java/cnuphys/splot/plot/VerticalLabelUI.java @@ -19,9 +19,9 @@ * Extends {@link BasicLabelUI}. *

* The only difference between the appearance of labels in the Basic and Metal - * L&Fs is the manner in which diabled text is painted. As VerticalLabelUI does + * {@code L&Fs} is the manner in which diabled text is painted. As VerticalLabelUI does * not override the method paintDisabledText, this class can be adapted for - * Metal L&F by extending MetalLabelUI instead of BasicLabelUI. + * Metal {@code L&F} by extending MetalLabelUI instead of BasicLabelUI. *

* No other changes are required. * @@ -93,7 +93,7 @@ public Component.BaselineResizeBehavior getBaselineResizeBehavior(JComponent c) /** * Transposes the view rectangles as appropriate for a vertical view before * invoking the super method and copies them after they have been altered by - * {@link SwingUtilities#layoutCompoundLabel(FontMetrics, String, Icon, int, int, int, int, Rectangle, Rectangle, Rectangle, int)} + * {@code SwingUtilities#layoutCompoundLabel(FontMetrics, String, Icon, int, int, int, int, Rectangle, Rectangle, Rectangle, int)} */ @Override protected String layoutCL(JLabel label, FontMetrics fontMetrics, String text, Icon icon, Rectangle viewR, @@ -181,4 +181,4 @@ private Rectangle copyRectangle(Rectangle from, Rectangle to) { to.height = from.height; return to; } -} \ No newline at end of file +} diff --git a/common-tools/cnuphys/splot/src/main/java/cnuphys/splot/rubberband/Rubberband.java b/common-tools/cnuphys/splot/src/main/java/cnuphys/splot/rubberband/Rubberband.java index 8538ffcc7d..18de8f6b21 100644 --- a/common-tools/cnuphys/splot/src/main/java/cnuphys/splot/rubberband/Rubberband.java +++ b/common-tools/cnuphys/splot/src/main/java/cnuphys/splot/rubberband/Rubberband.java @@ -79,7 +79,7 @@ public static enum Policy { /** * Create a Rubberband * - * @param container the parent component being rubberbanded + * @param canvas * @param rubberbanded who gets notified when we are done. * @param policy the stretching shape policy. */ @@ -632,4 +632,4 @@ public Point getStartPt() { public Point getCurrentPt() { return _currentPt; } -} \ No newline at end of file +} diff --git a/common-tools/cnuphys/splot/src/main/java/cnuphys/splot/style/EnumComboBox.java b/common-tools/cnuphys/splot/src/main/java/cnuphys/splot/style/EnumComboBox.java index 2d10a881a0..fa7f331e40 100644 --- a/common-tools/cnuphys/splot/src/main/java/cnuphys/splot/style/EnumComboBox.java +++ b/common-tools/cnuphys/splot/src/main/java/cnuphys/splot/style/EnumComboBox.java @@ -24,7 +24,7 @@ public class EnumComboBox extends JComboBox { /** * Create a combobox from an enum map. * - * @param enumMap an EnumMap. The enum is the key, and the + * @param enumMap an {@code EnumMap}. The enum is the key, and the * string, which will become the label, is the value. * @param defaultKey the enum that should default to "on". */ @@ -35,7 +35,7 @@ public EnumComboBox(EnumMap enumMap, Enum defaultKey) { /** * Create a combobox from an enum map. * - * @param enumMap an EnumMap. The enum is the key, and the + * @param enumMap an {@code EnumMap}. The enum is the key, and the * string, which will become the label, is the value. * @param defaultKey the enum that should default to "on". * @param extraChoice an optional extra choice, like "None" or "Any" @@ -106,4 +106,4 @@ protected void sizeComboBox() { setMaximumSize(d); } -} \ No newline at end of file +} diff --git a/common-tools/cnuphys/splot/src/main/java/cnuphys/splot/style/Styled.java b/common-tools/cnuphys/splot/src/main/java/cnuphys/splot/style/Styled.java index d2923ad64a..e5f4302587 100644 --- a/common-tools/cnuphys/splot/src/main/java/cnuphys/splot/style/Styled.java +++ b/common-tools/cnuphys/splot/src/main/java/cnuphys/splot/style/Styled.java @@ -71,7 +71,7 @@ public Styled(int index) { * @param fitLineStyle the fit line style * @param auxLineStyle the auxiliary line style * @param fitLineWidth the line width for fits - * @param fitLineWidth the line width for auxiliary lines + * @param auxLineWidth the line width for auxiliary lines * @param symbolType the symbol type * @param symbolSize the symbol size */ @@ -190,7 +190,7 @@ public void setFitLineWidth(float lineWidth) { /** * Set the symbol type * - * @param lineWidth the new symbol type + * @param symbolType the new symbol type */ @Override public void setSymbolType(SymbolType symbolType) { @@ -247,4 +247,4 @@ public void setAuxLineWidth(float lineWidth) { _auxLineWidth = lineWidth; } -} \ No newline at end of file +} diff --git a/common-tools/cnuphys/splot/src/main/java/cnuphys/splot/toolbar/CommonToolBar.java b/common-tools/cnuphys/splot/src/main/java/cnuphys/splot/toolbar/CommonToolBar.java index 9d65f77ce1..106ef4c16a 100644 --- a/common-tools/cnuphys/splot/src/main/java/cnuphys/splot/toolbar/CommonToolBar.java +++ b/common-tools/cnuphys/splot/src/main/java/cnuphys/splot/toolbar/CommonToolBar.java @@ -282,7 +282,7 @@ private void notifyListeners(AbstractButton button) { /** * Add a toolBar listener * - * @param ToolBarListener the listener to add + * @param listener the listener to add */ public void addToolBarListener(IToolBarListener listener) { @@ -298,7 +298,7 @@ public void addToolBarListener(IToolBarListener listener) { /** * Remove a ToolBarListener. * - * @param ToolBarListener the ToolBarListener to remove. + * @param listener the ToolBarListener to remove. */ public void removeToolBarListener(IToolBarListener listener) { diff --git a/common-tools/cnuphys/splot/src/main/java/cnuphys/splot/toolbar/ToolBarButton.java b/common-tools/cnuphys/splot/src/main/java/cnuphys/splot/toolbar/ToolBarButton.java index baf55dc163..aafc51050b 100644 --- a/common-tools/cnuphys/splot/src/main/java/cnuphys/splot/toolbar/ToolBarButton.java +++ b/common-tools/cnuphys/splot/src/main/java/cnuphys/splot/toolbar/ToolBarButton.java @@ -18,9 +18,9 @@ public class ToolBarButton extends JButton { /** * Constructor * - * @param container the owner container. * @param imageFileName the name if the file holding the icon * @param toolTip a string for a tool tip + * @param actionCommand */ public ToolBarButton(String imageFileName, String toolTip, String actionCommand) { super(); diff --git a/common-tools/cnuphys/splot/src/main/java/cnuphys/splot/toolbar/ToolBarToggleButton.java b/common-tools/cnuphys/splot/src/main/java/cnuphys/splot/toolbar/ToolBarToggleButton.java index 0dfb147c88..22d234e921 100644 --- a/common-tools/cnuphys/splot/src/main/java/cnuphys/splot/toolbar/ToolBarToggleButton.java +++ b/common-tools/cnuphys/splot/src/main/java/cnuphys/splot/toolbar/ToolBarToggleButton.java @@ -50,7 +50,6 @@ public class ToolBarToggleButton extends JToggleButton { /** * Create a toolbar toggle button * - * @param container the owner container. * @param imageFileName the name if the file holding the icon * @param toolTip a string for a tool tip * @param actionCommand theaction command. @@ -62,10 +61,12 @@ public ToolBarToggleButton(String imageFileName, String toolTip, String actionCo /** * Create a toolbar toggle button * - * @param container the owner container. * @param imageFileName the name if the file holding the icon * @param toolTip a string for a tool tip * @param actionCommand theaction command. + * @param xh + * @param yh + * @param cursorImageFile */ public ToolBarToggleButton(String imageFileName, String toolTip, String actionCommand, int xh, int yh, String cursorImageFile) { @@ -75,10 +76,14 @@ public ToolBarToggleButton(String imageFileName, String toolTip, String actionCo /** * Create a toolbar toggle button * - * @param container the owner container. * @param imageFileName the name if the file holding the icon * @param toolTip a string for a tool tip * @param actionCommand theaction command. + * @param xh + * @param yh + * @param cursorImageFile + * @param iw + * @param ih */ public ToolBarToggleButton(String imageFileName, String toolTip, String actionCommand, int xh, int yh, String cursorImageFile, int iw, int ih) { diff --git a/common-tools/cnuphys/swimmer/src/main/java/cnuphys/adaptiveSwim/IAdaptiveStopper.java b/common-tools/cnuphys/swimmer/src/main/java/cnuphys/adaptiveSwim/IAdaptiveStopper.java index 4d1a7d2e44..5df2f64b1d 100644 --- a/common-tools/cnuphys/swimmer/src/main/java/cnuphys/adaptiveSwim/IAdaptiveStopper.java +++ b/common-tools/cnuphys/swimmer/src/main/java/cnuphys/adaptiveSwim/IAdaptiveStopper.java @@ -9,9 +9,9 @@ public interface IAdaptiveStopper { * precise, because the check may not happen on every step, but it should be * close. * - * @param sNew the new value of the independent variable (typically pathlength) - * @param uNew the new state vector (typically [x, y, z, vx, vy, vz]) - * @return true if we should stop now. + * @param snew the new value of the independent variable (typically pathlength) + * @param unew the new state vector (typically [x, y, z, vx, vy, vz]) + * @return {@code true} if we should stop now. */ public boolean stopIntegration(double snew, double unew[]); diff --git a/common-tools/cnuphys/swimmer/src/main/java/cnuphys/adaptiveSwim/geometry/Plane.java b/common-tools/cnuphys/swimmer/src/main/java/cnuphys/adaptiveSwim/geometry/Plane.java index 516aa93a6c..e7bee79c97 100644 --- a/common-tools/cnuphys/swimmer/src/main/java/cnuphys/adaptiveSwim/geometry/Plane.java +++ b/common-tools/cnuphys/swimmer/src/main/java/cnuphys/adaptiveSwim/geometry/Plane.java @@ -27,9 +27,8 @@ public class Plane { /** * Create a plane from a normal vector and a point on the plane * - * @param norm the normal vector + * @param anorm the normal vector * @param p a point in the plane - * @return the plane that contains p and its normal is norm */ public Plane(Vector anorm, Point p) { // lets make it a unit vector @@ -441,4 +440,4 @@ public static void main(String arg[]) { System.out.println("Intersection of two phi planes: " + pp1.planeIntersection(pp2)); } -} \ No newline at end of file +} diff --git a/common-tools/cnuphys/swimmer/src/main/java/cnuphys/adaptiveSwim/test/InitialValues.java b/common-tools/cnuphys/swimmer/src/main/java/cnuphys/adaptiveSwim/test/InitialValues.java index 2e5884c842..02e524dcce 100644 --- a/common-tools/cnuphys/swimmer/src/main/java/cnuphys/adaptiveSwim/test/InitialValues.java +++ b/common-tools/cnuphys/swimmer/src/main/java/cnuphys/adaptiveSwim/test/InitialValues.java @@ -86,7 +86,7 @@ public String toString() { /** * For setting up an array of initial values for testing. In cases where the difference between - * a min val and a max val is < SMALL, the min val is used and the variable is no + * a min val and a max val is {@code < SMALL}, the min val is used and the variable is no * randomized. * @param rand and random number generator * @param num the number to create @@ -123,7 +123,7 @@ public static InitialValues[] getInitialValues(Random rand, int num, int charge, /** * For setting up an array of initial values for testing. In cases where the difference between - * a min val and a max val is < SMALL, the min val is used and the variable is no + * a min val and a max val is {@code < SMALL}, the min val is used and the variable is no * randomized. * @param rand and random number generator * @param initVal the object to fill with random values diff --git a/common-tools/cnuphys/swimmer/src/main/java/cnuphys/lund/DoubleFormat.java b/common-tools/cnuphys/swimmer/src/main/java/cnuphys/lund/DoubleFormat.java index c0d67ffa17..30a5b56a52 100644 --- a/common-tools/cnuphys/swimmer/src/main/java/cnuphys/lund/DoubleFormat.java +++ b/common-tools/cnuphys/swimmer/src/main/java/cnuphys/lund/DoubleFormat.java @@ -85,7 +85,7 @@ public static String doubleFormat(double value, int numdec, boolean scinot) { * the value to format. * @param numdec * the number of digits right of the decimal. If the exponenent - * is >= n or <= -n it will use sci notation. + * is {@code >= n} or {@code <= -n} it will use sci notation. * @param minExponent * the minimum (absolute value) index for scientific notation. */ diff --git a/common-tools/cnuphys/swimmer/src/main/java/cnuphys/lund/GeneratedParticleRecord.java b/common-tools/cnuphys/swimmer/src/main/java/cnuphys/lund/GeneratedParticleRecord.java index a4427f3aa0..ef61a9f6e9 100644 --- a/common-tools/cnuphys/swimmer/src/main/java/cnuphys/lund/GeneratedParticleRecord.java +++ b/common-tools/cnuphys/swimmer/src/main/java/cnuphys/lund/GeneratedParticleRecord.java @@ -130,7 +130,7 @@ public double getPhi() { * The total energy in GeV. This requires that we specify what particle this * is. * - * @param lundid + * @param lundId * the lundid of the particle * @return the total energy in GeV */ @@ -143,7 +143,7 @@ public double getTotalEnergy(LundId lundId) { * Get the kinetic energy in GeV. This requires that we specify what * particle this is. * - * @param lundid + * @param lundId * the lundid of the particle * * @return the kinetic energy in GeV @@ -161,7 +161,6 @@ public String toString() { /** * Records a reduced precision String version as a hash key - * @param rpr the GeneratedParticleRecord * @return a reduced precision String version */ public String hashKey() { @@ -232,4 +231,4 @@ public static void main(String[] arg) { System.err.println("done"); } -} \ No newline at end of file +} diff --git a/common-tools/cnuphys/swimmer/src/main/java/cnuphys/lund/LundComboBox.java b/common-tools/cnuphys/swimmer/src/main/java/cnuphys/lund/LundComboBox.java index fc60869354..8324729edf 100644 --- a/common-tools/cnuphys/swimmer/src/main/java/cnuphys/lund/LundComboBox.java +++ b/common-tools/cnuphys/swimmer/src/main/java/cnuphys/lund/LundComboBox.java @@ -30,7 +30,7 @@ public String toString() { * Constructor for a particle combobox * * @param chargedOnly - * if <> only add charged particles + * if {@code <>} only add charged particles * @param maxMass * the max mass added to the combobox, in MeV * @param defaultId diff --git a/common-tools/cnuphys/swimmer/src/main/java/cnuphys/lund/LundSupport.java b/common-tools/cnuphys/swimmer/src/main/java/cnuphys/lund/LundSupport.java index 091d3499a9..1391da917d 100644 --- a/common-tools/cnuphys/swimmer/src/main/java/cnuphys/lund/LundSupport.java +++ b/common-tools/cnuphys/swimmer/src/main/java/cnuphys/lund/LundSupport.java @@ -1011,8 +1011,6 @@ private void initStyles() { * * @param lundId the id to set the style for. * @param lineColor the lineColor to use. - * @param darker if true make line color datker, else make it - * lighter. */ public static void setStyle(int lundId, Color lineColor) { LundSupport ls = LundSupport.getInstance(); diff --git a/common-tools/cnuphys/swimmer/src/main/java/cnuphys/lund/LundTrackDialog.java b/common-tools/cnuphys/swimmer/src/main/java/cnuphys/lund/LundTrackDialog.java index 10d277f545..0fff8ee3ef 100644 --- a/common-tools/cnuphys/swimmer/src/main/java/cnuphys/lund/LundTrackDialog.java +++ b/common-tools/cnuphys/swimmer/src/main/java/cnuphys/lund/LundTrackDialog.java @@ -636,8 +636,6 @@ public static JPanel paddedPanel(int hpad, int vpad, Component component) { * Center a component. * * @param component The Component to center. - * @param dh offset from horizontal center. - * @param dv offset from vertical center. */ public static void centerComponent(Component component) { @@ -683,4 +681,4 @@ public CommonBorder(String title) { } } -} \ No newline at end of file +} diff --git a/common-tools/cnuphys/swimmer/src/main/java/cnuphys/rk4/RungeKutta.java b/common-tools/cnuphys/swimmer/src/main/java/cnuphys/rk4/RungeKutta.java index d1fb8ca365..667a48473f 100644 --- a/common-tools/cnuphys/swimmer/src/main/java/cnuphys/rk4/RungeKutta.java +++ b/common-tools/cnuphys/swimmer/src/main/java/cnuphys/rk4/RungeKutta.java @@ -1279,7 +1279,7 @@ public void setMaxStepSize(double maxSS) { /** * Set the minimum step size * - * @param maxSS + * @param minSS * the minimum stepsize is whatever units you are using */ public void setMinStepSize(double minSS) { diff --git a/common-tools/cnuphys/swimmer/src/main/java/cnuphys/rk4/RungeKuttaZ.java b/common-tools/cnuphys/swimmer/src/main/java/cnuphys/rk4/RungeKuttaZ.java index b49f8c6417..66903d38d9 100644 --- a/common-tools/cnuphys/swimmer/src/main/java/cnuphys/rk4/RungeKuttaZ.java +++ b/common-tools/cnuphys/swimmer/src/main/java/cnuphys/rk4/RungeKuttaZ.java @@ -601,7 +601,7 @@ public void setMaxStepSize(double maxSS) { /** * Set the minimum step size * - * @param maxSS + * @param minSS * the minimum stepsize is whatever units you are using */ public void setMinStepSize(double minSS) { diff --git a/common-tools/cnuphys/swimmer/src/main/java/cnuphys/swim/BeamLineStopper.java b/common-tools/cnuphys/swimmer/src/main/java/cnuphys/swim/BeamLineStopper.java index 22bc18daf2..370f34d6ab 100644 --- a/common-tools/cnuphys/swimmer/src/main/java/cnuphys/swim/BeamLineStopper.java +++ b/common-tools/cnuphys/swimmer/src/main/java/cnuphys/swim/BeamLineStopper.java @@ -55,7 +55,6 @@ public void setFinalT(double finalPathLength) { /** * - * @param charge * @param charge the charge: -1 for electron, 1 for proton, etc * @param xo the x vertex position in meters * @param yo the y vertex position in meters diff --git a/common-tools/cnuphys/swimmer/src/main/java/cnuphys/swim/DefaultCylinderStopper.java b/common-tools/cnuphys/swimmer/src/main/java/cnuphys/swim/DefaultCylinderStopper.java index 131316b68a..822188271e 100644 --- a/common-tools/cnuphys/swimmer/src/main/java/cnuphys/swim/DefaultCylinderStopper.java +++ b/common-tools/cnuphys/swimmer/src/main/java/cnuphys/swim/DefaultCylinderStopper.java @@ -43,7 +43,6 @@ public class DefaultCylinderStopper implements IStopper { * @param sMax maximal path length in meters * @param targetCylinder target Cylinder * @param accuracy the accuracy in meters - * @param normalDirection if going smaller to larger rho */ public DefaultCylinderStopper(double[] u0, double s0, double sMax, Cylinder targetCylinder, double accuracy) { diff --git a/common-tools/cnuphys/swimmer/src/main/java/cnuphys/swim/DefaultRhoStopper.java b/common-tools/cnuphys/swimmer/src/main/java/cnuphys/swim/DefaultRhoStopper.java index 87a73d3ab8..fdf2399cd1 100644 --- a/common-tools/cnuphys/swimmer/src/main/java/cnuphys/swim/DefaultRhoStopper.java +++ b/common-tools/cnuphys/swimmer/src/main/java/cnuphys/swim/DefaultRhoStopper.java @@ -38,9 +38,9 @@ public class DefaultRhoStopper implements IStopper { * @param uo starting state vector * @param s0 starting path length in meters * @param sMax maximal path length in meters + * @param rho0 * @param targetRho stopping rho in meters * @param accuracy the accuracy in meters - * @param normalDirection if going smaller to larger rho */ public DefaultRhoStopper(double[] uo, double s0, double sMax, double rho0, double targetRho, double accuracy) { @@ -178,4 +178,4 @@ public boolean terminateIntegration(double t, double y[]) { return false; } -} \ No newline at end of file +} diff --git a/common-tools/cnuphys/swimmer/src/main/java/cnuphys/swim/NewPlaneStopper.java b/common-tools/cnuphys/swimmer/src/main/java/cnuphys/swim/NewPlaneStopper.java index ea0d04e27b..0c5feed54d 100644 --- a/common-tools/cnuphys/swimmer/src/main/java/cnuphys/swim/NewPlaneStopper.java +++ b/common-tools/cnuphys/swimmer/src/main/java/cnuphys/swim/NewPlaneStopper.java @@ -43,7 +43,6 @@ public class NewPlaneStopper implements IStopper { * @param sMax maximal path length in meters * @param targetPlane target Plane * @param accuracy the accuracy in meters - * @param normalDirection if going smaller to larger rho */ public NewPlaneStopper(double[] u0, double s0, double sMax, Plane targetPlane, double accuracy) { diff --git a/common-tools/cnuphys/swimmer/src/main/java/cnuphys/swim/SectorDerivative.java b/common-tools/cnuphys/swimmer/src/main/java/cnuphys/swim/SectorDerivative.java index 01d9986cb7..2b86806662 100644 --- a/common-tools/cnuphys/swimmer/src/main/java/cnuphys/swim/SectorDerivative.java +++ b/common-tools/cnuphys/swimmer/src/main/java/cnuphys/swim/SectorDerivative.java @@ -35,8 +35,7 @@ public class SectorDerivative implements IDerivative { * -1 for electron, +1 for proton, etc. * @param momentum * the magnitude of the momentum. - * @param field - * the magnetic field + * @param rcProbe */ public SectorDerivative(int sector, int charge, double momentum, RotatedCompositeProbe rcProbe) { _sector = sector; @@ -63,9 +62,7 @@ public void set(int sector, int charge, double momentum, RotatedCompositeProbe r * @param Q * the values of the state vector ([x,y,z, px/p, py/p, pz/p]) at * s (input). - * @param dydt - * will be filled with the values of the derivatives at t - * (output). + * @param dQds (output). */ @Override public void derivative(double s, double[] Q, double[] dQds) { diff --git a/common-tools/cnuphys/swimmer/src/main/java/cnuphys/swim/SwimTrajectory2D.java b/common-tools/cnuphys/swimmer/src/main/java/cnuphys/swim/SwimTrajectory2D.java index 8cbbe5bf76..bd1735f180 100644 --- a/common-tools/cnuphys/swimmer/src/main/java/cnuphys/swim/SwimTrajectory2D.java +++ b/common-tools/cnuphys/swimmer/src/main/java/cnuphys/swim/SwimTrajectory2D.java @@ -317,9 +317,9 @@ public SwimTrajectory getTrajectory3D() { * containing p0-p1. It may or may not actually be between p0 * and p1, as specified by the value of t. * @return the perpendicular distance to the line. If t is between 0 and 1 the - * intersection is on the line. If t < 0 the intersection is on the - * "infinite line" but not on p0->p1, it is on the p0 side; this returns - * the distance to p0. If t > 1 the intersection is on the p1 side; this + * intersection is on the line. If {@code t < 0} the intersection is on the + * "infinite line" but not on {@code p0->p1}, it is on the p0 side; this returns + * the distance to p0. If {@code t > 1} the intersection is on the p1 side; this * returns the distance to p1. */ public static double perpendicularDistance(Point.Double p0, Point.Double p1, Point.Double wp, @@ -351,4 +351,4 @@ public String getSource() { return ((_trajectory3D == null) ? "???" : _trajectory3D.getSource()); } -} \ No newline at end of file +} diff --git a/common-tools/cnuphys/swimmer/src/main/java/cnuphys/swim/Swimmer.java b/common-tools/cnuphys/swimmer/src/main/java/cnuphys/swim/Swimmer.java index c170bebcf8..74b632f120 100644 --- a/common-tools/cnuphys/swimmer/src/main/java/cnuphys/swim/Swimmer.java +++ b/common-tools/cnuphys/swimmer/src/main/java/cnuphys/swim/Swimmer.java @@ -290,8 +290,6 @@ public void swimCylinder(int charge, double xo, double yo, double zo, double mom * maxPathLength if reached first) * @param accuracy the accuracy of the fixed rho termination, in * meters - * @param stopper an optional object that can terminate the - * swimming based on some condition * @param sMax in meters. This determines the max number of * steps based on the step size. If a stopper is * used, the integration might terminate before all @@ -524,8 +522,6 @@ public void swimRho(int charge, double xo, double yo, double zo, double momentum * maxPathLength if reached first) * @param accuracy the accuracy of the fixed rho termination, in * meters - * @param stopper an optional object that can terminate the - * swimming based on some condition * @param sMax in meters. This determines the max number of * steps based on the step size. If a stopper is * used, the integration might terminate before all @@ -971,9 +967,6 @@ public int swim(int charge, double xo, double yo, double zo, double momentum, do * if reached first) * @param accuracy * the accuracy of the fixed z termination, in meters - * @param stopper - * an optional object that can terminate the swimming based on - * some condition * @param maxPathLength * in meters. This determines the max number of steps based on * the step size. If a stopper is used, the integration might diff --git a/common-tools/cnuphys/swimmer/src/main/java/cnuphys/swim/util/VectorSupport.java b/common-tools/cnuphys/swimmer/src/main/java/cnuphys/swim/util/VectorSupport.java index 73d6723cc3..270251e27c 100644 --- a/common-tools/cnuphys/swimmer/src/main/java/cnuphys/swim/util/VectorSupport.java +++ b/common-tools/cnuphys/swimmer/src/main/java/cnuphys/swim/util/VectorSupport.java @@ -182,8 +182,6 @@ public static String toString(double v[], int numDec) { * * @param v * the vector (of any length) - * @param numDec - * the number of decimal places for each coordinate. * @return a String representation of the vector */ public static String toString(double v[]) { @@ -417,4 +415,4 @@ public static double[] diff(double a[], double b[]) { return c; } -} \ No newline at end of file +} diff --git a/common-tools/cnuphys/swimmer/src/main/java/cnuphys/swimZ/SectorSwimZDerivative.java b/common-tools/cnuphys/swimmer/src/main/java/cnuphys/swimZ/SectorSwimZDerivative.java index a171107241..a07d1bb1b3 100644 --- a/common-tools/cnuphys/swimmer/src/main/java/cnuphys/swimZ/SectorSwimZDerivative.java +++ b/common-tools/cnuphys/swimmer/src/main/java/cnuphys/swimZ/SectorSwimZDerivative.java @@ -19,7 +19,7 @@ public void setSector(int sector) { /** * Set the parameters - * @param sect the sector [1..6] + * @param sector the sector [1..6] * @param Q * -1 for electron, +1 for proton, etc. * @param p diff --git a/common-tools/cnuphys/swimmer/src/main/java/cnuphys/swimZ/SwimZ.java b/common-tools/cnuphys/swimmer/src/main/java/cnuphys/swimZ/SwimZ.java index 98bcb1d1f7..46efe0ac8b 100644 --- a/common-tools/cnuphys/swimmer/src/main/java/cnuphys/swimZ/SwimZ.java +++ b/common-tools/cnuphys/swimmer/src/main/java/cnuphys/swimZ/SwimZ.java @@ -76,9 +76,6 @@ public class SwimZ { /** * SwimZ constructor. Here we create a Swimmer that will use the given * magnetic field. - * - * @param field - * interface into a magnetic field */ public SwimZ() { _probe = FieldProbe.factory(); @@ -165,10 +162,6 @@ public double getEps() { * the final z value (cm) * @param stepSize * the initial step size - * @param relTolerance - * the absolute tolerances on each state variable [x, y, tx, ty] - * (q = const). So it is an array with four entries, like [1.0e-4 - * cm, 1.0e-4 cm, 1.0e-5, 1.0e05] * @param hdata * An array with three elements. Upon return it will have the * min, average, and max step size (in that order). @@ -243,10 +236,6 @@ public SwimZResult adaptiveRK(int Q, * the final z value (cm) * @param stepSize * the initial step size - * @param relTolerance - * the absolute tolerances on each state variable [x, y, tx, ty] - * (q = const). So it is an array with four entries, like [1.0e-4 - * cm, 1.0e-4 cm, 1.0e-5, 1.0e05] * @param hdata * An array with three elements. Upon return it will have the * min, average, and max step size (in that order). @@ -402,7 +391,6 @@ public void nextStep(double newZ, double[] newStateVec, double h) { * @param stop at end, holds final state vector * @param zf * the final z value (cm) - * @return the swim result * @throws SwimZException */ diff --git a/common-tools/cnuphys/swimmer/src/main/java/cnuphys/swimZ/SwimZStateVector.java b/common-tools/cnuphys/swimmer/src/main/java/cnuphys/swimZ/SwimZStateVector.java index 35cdf985cd..69b98118e4 100644 --- a/common-tools/cnuphys/swimmer/src/main/java/cnuphys/swimZ/SwimZStateVector.java +++ b/common-tools/cnuphys/swimmer/src/main/java/cnuphys/swimZ/SwimZStateVector.java @@ -80,8 +80,6 @@ public SwimZStateVector(double z, double v[]) { * * @param sv * the state vector to copy - * @param v - * the array with, in order, x,y,tx,ty,q */ public SwimZStateVector(SwimZStateVector sv) { this(sv.x, sv.y, sv.z, sv.tx, sv.ty); diff --git a/common-tools/swim-tools/src/main/java/org/jlab/clas/swimtools/Swim.java b/common-tools/swim-tools/src/main/java/org/jlab/clas/swimtools/Swim.java index e83c49fd66..74b6b47719 100644 --- a/common-tools/swim-tools/src/main/java/org/jlab/clas/swimtools/Swim.java +++ b/common-tools/swim-tools/src/main/java/org/jlab/clas/swimtools/Swim.java @@ -66,7 +66,7 @@ public Swim() { /** * Set max swimming path length * - * @param maxPathLength + * @param _maxPathLength */ public void setMaxPathLength(double _maxPathLength) { this._maxPathLength = _maxPathLength; @@ -1427,4 +1427,4 @@ public double[] SwimToDCA(SwimTrajectory trk2) { //use for both traj to get doca } -} \ No newline at end of file +} diff --git a/reconstruction/alert/src/main/java/org/jlab/rec/ahdc/Hit/Hit.java b/reconstruction/alert/src/main/java/org/jlab/rec/ahdc/Hit/Hit.java index f1a6e7a9f7..f9cf18757d 100644 --- a/reconstruction/alert/src/main/java/org/jlab/rec/ahdc/Hit/Hit.java +++ b/reconstruction/alert/src/main/java/org/jlab/rec/ahdc/Hit/Hit.java @@ -42,7 +42,7 @@ public class Hit implements Comparable, KFHit { * @param _Super_layer super layer id * @param _Layer layer id * @param _Wire wire id - * @param _Doca distance from the timing information using the time2distance, matches {@link Hit.#time} + * @param _Doca distance from the timing information using the time2distance, matches {@link Hit#time} * @param _ADC raw ADC * @param _Time calibrated time */ diff --git a/reconstruction/alert/src/main/java/org/jlab/rec/alert/projections/TrackProjector.java b/reconstruction/alert/src/main/java/org/jlab/rec/alert/projections/TrackProjector.java index ca4a487a91..3573a7dfa0 100644 --- a/reconstruction/alert/src/main/java/org/jlab/rec/alert/projections/TrackProjector.java +++ b/reconstruction/alert/src/main/java/org/jlab/rec/alert/projections/TrackProjector.java @@ -47,7 +47,7 @@ public TrackProjector() { /** * Gets the list of track projections. * - * @return a {@link List} of {@link TrackProjection} objects representing + * @return a {@code List} of {@link TrackProjection} objects representing * the projections. */ public ArrayList getProjections() { @@ -66,7 +66,7 @@ public Double getB() { /** * Sets the list of track projections. * - * @param Projections a {@link List} of {@link TrackProjection}. + * @param Projections a {@code List} of {@link TrackProjection}. */ public void setProjections(ArrayList Projections) { this.projections = Projections; diff --git a/reconstruction/alert/src/main/java/org/jlab/rec/atof/cluster/ClusterFinder.java b/reconstruction/alert/src/main/java/org/jlab/rec/atof/cluster/ClusterFinder.java index e5deeb71db..a52845ce88 100644 --- a/reconstruction/alert/src/main/java/org/jlab/rec/atof/cluster/ClusterFinder.java +++ b/reconstruction/alert/src/main/java/org/jlab/rec/atof/cluster/ClusterFinder.java @@ -125,7 +125,7 @@ public void clusterHits(int i, ArrayList hits, ATOFHit th } /** - * Builds clusters in the {@link DateEvent} using hits found and stored in a + * Builds clusters in the {@link DataEvent} using hits found and stored in a * {@link HitFinder}. * * @param hitfinder the {@link HitFinder} containing the hits that were @@ -206,7 +206,7 @@ public void makeClusters(HitFinder hitfinder, double sigma_module, double sigma_ } /** - * Builds clusters in the {@link DateEvent} using hits found and stored in a + * Builds clusters in the {@link DataEvent} using hits found and stored in a * {@link HitFinder}. * * @param event the {@link DataEvent} containing the clusters to be built diff --git a/reconstruction/dc/src/main/java/org/jlab/rec/dc/hit/FittedHit.java b/reconstruction/dc/src/main/java/org/jlab/rec/dc/hit/FittedHit.java index fb2ccb1460..08c35c3422 100644 --- a/reconstruction/dc/src/main/java/org/jlab/rec/dc/hit/FittedHit.java +++ b/reconstruction/dc/src/main/java/org/jlab/rec/dc/hit/FittedHit.java @@ -1031,7 +1031,7 @@ public void setAlpha(double _alpha) { /** * - * @return a value <=1 resetting beta to 1 for overflows + * @return a value {@code <=1} resetting beta to 1 for overflows */ public double get_Beta0to1() { double beta = this.get_Beta(); diff --git a/reconstruction/dc/src/main/java/org/jlab/rec/dc/trajectory/TrackVec.java b/reconstruction/dc/src/main/java/org/jlab/rec/dc/trajectory/TrackVec.java index ac991d1401..656562eafa 100644 --- a/reconstruction/dc/src/main/java/org/jlab/rec/dc/trajectory/TrackVec.java +++ b/reconstruction/dc/src/main/java/org/jlab/rec/dc/trajectory/TrackVec.java @@ -225,7 +225,7 @@ public void TransformToTiltSectorFrame() { * * @param X * @param Z - * @param t <0 going to lab, >0 going to tilted system + * @param t {@code <0} going to lab, {@code >0} going to tilted system * @return */ public double[] tilt(double X, double Z, int t) { diff --git a/reconstruction/dc/src/main/java/org/jlab/service/dc/DCHBEngine.java b/reconstruction/dc/src/main/java/org/jlab/service/dc/DCHBEngine.java index da825d48ae..bc98d1472a 100644 --- a/reconstruction/dc/src/main/java/org/jlab/service/dc/DCHBEngine.java +++ b/reconstruction/dc/src/main/java/org/jlab/service/dc/DCHBEngine.java @@ -31,6 +31,7 @@ * @since 08.09.2018 updated by gurjyan @deprecated */ +@Deprecated public class DCHBEngine extends DCEngine { diff --git a/reconstruction/eb/src/main/java/org/jlab/rec/eb/EBScalers.java b/reconstruction/eb/src/main/java/org/jlab/rec/eb/EBScalers.java index 55baa33a72..995ad42bb3 100644 --- a/reconstruction/eb/src/main/java/org/jlab/rec/eb/EBScalers.java +++ b/reconstruction/eb/src/main/java/org/jlab/rec/eb/EBScalers.java @@ -23,6 +23,7 @@ * * @author baltzell */ +@Deprecated public class EBScalers { private RawReading firstRawReading=null; diff --git a/reconstruction/ft/src/main/java/org/jlab/rec/ft/trk/FTTRKCluster.java b/reconstruction/ft/src/main/java/org/jlab/rec/ft/trk/FTTRKCluster.java index 7574f21272..139ca6fac1 100644 --- a/reconstruction/ft/src/main/java/org/jlab/rec/ft/trk/FTTRKCluster.java +++ b/reconstruction/ft/src/main/java/org/jlab/rec/ft/trk/FTTRKCluster.java @@ -73,7 +73,7 @@ public int get_Layer() { /** * - * @param set the layer of the cluster (1...4) + * @param _Layer the layer of the cluster (1...4) */ public void set_Layer(int _Layer) { this._Layer = _Layer; @@ -303,16 +303,6 @@ public void set_StripSegment(Line3D _StripSegment) { this._StripSegment = _StripSegment; } - - - /** - * - * @param Z z-coordinate of a point in the local coordinate system of a module - * @return the average resolution for a group of strips in a cluster - * - */ - - private int _AssociatedCrossID; private int _AssociatedTrackID; diff --git a/reconstruction/ft/src/main/java/org/jlab/rec/ft/trk/FTTRKCross.java b/reconstruction/ft/src/main/java/org/jlab/rec/ft/trk/FTTRKCross.java index 55810c121a..4387e87cdb 100644 --- a/reconstruction/ft/src/main/java/org/jlab/rec/ft/trk/FTTRKCross.java +++ b/reconstruction/ft/src/main/java/org/jlab/rec/ft/trk/FTTRKCross.java @@ -67,7 +67,7 @@ public int get_Sector() { /** * Sets the sector - * @param _Sector the sector of the cross + * @param sector the sector of the cross */ public void set_Sector(int sector) { this._Sector = sector; @@ -84,7 +84,7 @@ public int get_Region() { /** * Sets the region - * @param _Region the region of the cross + * @param region the region of the cross */ public void set_Region(int region) { this._Region = region; @@ -100,7 +100,7 @@ public int get_Id() { /** * Sets the cross ID - * @param _Id the id of the cross + * @param id the id of the cross */ public void set_Id(int id) { this._Id = id; @@ -126,7 +126,7 @@ public Point3D get_Point() { /** * Sets the cross 3-D point - * @param _Point a 3-D point characterizing the position of the cross in the tilted coordinate system. + * @param point a 3-D point characterizing the position of the cross in the tilted coordinate system. */ public void set_Point(Point3D point) { this._Point = point; @@ -142,7 +142,7 @@ public Point3D get_PointErr() { /** * Sets a 3-dimensional error on the 3-D point - * @param _PointErr a 3-dimensional error on the 3-D point characterizing the position of the cross in the tilted coordinate system. + * @param pointErr a 3-dimensional error on the 3-D point characterizing the position of the cross in the tilted coordinate system. */ public void set_PointErr(Point3D pointErr) { this._PointErr = pointErr; @@ -158,7 +158,7 @@ public Vector3D get_Dir() { /** * Sets the cross unit direction vector - * @param _Dir the cross unit direction vector + * @param dir the cross unit direction vector */ public void set_Dir(Vector3D dir) { this._Dir = dir; @@ -174,7 +174,7 @@ public Vector3D get_DirErr() { /** * Sets the cross unit direction vector - * @param _DirErr the cross unit direction vector + * @param dirErr the cross unit direction vector */ public void set_DirErr(Vector3D dirErr) { this._DirErr = dirErr; diff --git a/reconstruction/ft/src/main/java/org/jlab/rec/ft/trk/FTTRKHit.java b/reconstruction/ft/src/main/java/org/jlab/rec/ft/trk/FTTRKHit.java index fe90044bb7..103664854b 100644 --- a/reconstruction/ft/src/main/java/org/jlab/rec/ft/trk/FTTRKHit.java +++ b/reconstruction/ft/src/main/java/org/jlab/rec/ft/trk/FTTRKHit.java @@ -121,8 +121,8 @@ public int get_Strip() { } /** - * Sets the wire number - * @param _Wire + * Sets the strip number + * @param _Strip */ public void set_Strip(int _Strip) { this._Strip = _Strip; diff --git a/reconstruction/recoil/src/main/java/org/jlab/service/recoil/tof/ClusterFinder.java b/reconstruction/recoil/src/main/java/org/jlab/service/recoil/tof/ClusterFinder.java index a6cdb32ee0..2d78b993f2 100644 --- a/reconstruction/recoil/src/main/java/org/jlab/service/recoil/tof/ClusterFinder.java +++ b/reconstruction/recoil/src/main/java/org/jlab/service/recoil/tof/ClusterFinder.java @@ -96,7 +96,7 @@ public void clusterHits(int i, ArrayList hits, RTOFRaw /** - * Builds clusters in the {@link DateEvent} using hits found and stored in a + * Builds clusters in the {@link DataEvent} using hits found and stored in a * {@link HitFinder}. * * @param hitfinder the {@link HitFinder} containing the hits that were diff --git a/reconstruction/rich/src/main/java/org/jlab/rec/rich/Quaternion.java b/reconstruction/rich/src/main/java/org/jlab/rec/rich/Quaternion.java index 2b26290ded..69b49fe48d 100644 --- a/reconstruction/rich/src/main/java/org/jlab/rec/rich/Quaternion.java +++ b/reconstruction/rich/src/main/java/org/jlab/rec/rich/Quaternion.java @@ -76,7 +76,7 @@ public void normalize() { /** * Multiplication between two Quaternions * @param qb the one that multiply - * @param result of the multiplication + * @return result of the multiplication */ public Quaternion multiply(Quaternion qb) { Quaternion qa = this; diff --git a/reconstruction/rtpc/src/main/java/org/jlab/rec/rtpc/banks/RecoBankWriter.java b/reconstruction/rtpc/src/main/java/org/jlab/rec/rtpc/banks/RecoBankWriter.java index f9758ca491..eadb87911d 100644 --- a/reconstruction/rtpc/src/main/java/org/jlab/rec/rtpc/banks/RecoBankWriter.java +++ b/reconstruction/rtpc/src/main/java/org/jlab/rec/rtpc/banks/RecoBankWriter.java @@ -14,7 +14,8 @@ public class RecoBankWriter { /** * - * @param hitlist the list of hits that are of the type Hit. + * @param event + * @param params * @return hits bank * */ diff --git a/reconstruction/tof/src/main/java/org/jlab/rec/tof/hit/AHit.java b/reconstruction/tof/src/main/java/org/jlab/rec/tof/hit/AHit.java index ed4d89b7a9..c389387e90 100644 --- a/reconstruction/tof/src/main/java/org/jlab/rec/tof/hit/AHit.java +++ b/reconstruction/tof/src/main/java/org/jlab/rec/tof/hit/AHit.java @@ -462,7 +462,6 @@ public void set_TDCbankHitIdx2(int _TDCbankHitIdx2) { * 1=L, 2=R; for CTOF 1=U, 2=D ) * * @param superlayer - * @param TrkPosInf * @param TW01 * @param TW02 * @param TW11