fix: javadoc warnings

since they've started polluting CI run summaries...
c-dilks · Jul 6, 2026 · Jul 2, 2026 · Jul 4, 2026 · Jul 4, 2026 · Jul 6, 2026
commit 5b7c3f7a7f721ff4117b607a8afb1e62e1bc7b25
@@ -145,7 +145,7 @@ 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

@@ -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 
      */

@@ -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) {

@@ -7,13 +7,13 @@
 /**
  * A Forward Micromegas Tracker  (FMT) {@link org.jlab.geom.base.Superlayer Superlayer}.
  * <p>
- * Factory: {@link org.jlab.geom.detector.cnd.FMTFactory FMTFactory}<br> 
+ * Factory: {@link org.jlab.geom.detector.fmt.FMTFactory FMTFactory}<br> 
  * Hierarchy: 
  * <code>
- * {@link org.jlab.geom.detector.cnd.FMTDetector FMTDetector} → 
- * {@link org.jlab.geom.detector.cnd.FMTSector FMTSector} → 
- * <b>{@link org.jlab.geom.detector.cnd.FMTSuperlayer FMTSuperlayer}</b> → 
- * {@link org.jlab.geom.detector.cnd.FMTLayer FMTLayer} → 
+ * {@link org.jlab.geom.detector.fmt.FMTDetector FMTDetector} → 
+ * {@link org.jlab.geom.detector.fmt.FMTSector FMTSector} → 
+ * <b>{@link org.jlab.geom.detector.fmt.FMTSuperlayer FMTSuperlayer}</b> → 
+ * {@link org.jlab.geom.detector.fmt.FMTLayer FMTLayer} → 
  * {@link org.jlab.geom.component.TrackerStrip TrackerStrip}
  * </code>
  * 

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
@@ -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);
                     }
                 }
             }

@@ -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 <tt>true</tt> 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<? extends Float> c) {
@@ -687,7 +685,7 @@ private void readObject(java.io.ObjectInputStream s)
      * </p>
      * <p>The returned list iterator is <a href="#fail-fast"><i>fail-fast</i></a>.
      *
-     * @throws IndexOutOfBoundsException {@inheritDoc}
+     * @throws IndexOutOfBoundsException
      */
     @Override public ListIterator<Float> listIterator(int index) {
         if (index < 0 || index > size)
@@ -840,8 +838,8 @@ private class ListItr extends Itr implements ListIterator<Float> {
      * 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<Float> subList(int fromIndex, int toIndex) {
         subListRangeCheck(fromIndex, toIndex, size);

@@ -98,6 +98,7 @@ public class SVTVolumeFactory
 	 * Default: false
 	 * @deprecated
 	 */
+        @Deprecated
 	public boolean HALFBOXES = false;
 
 

@@ -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<Geant4Basic> 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. 
 	 * 

@@ -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()));
     }

@@ -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);
     }

@@ -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) {

@@ -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) {

@@ -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.

@@ -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) {

@@ -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) {

@@ -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) {

@@ -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 {
 

@@ -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());

@@ -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);
 	}
 
-}
+}
@@ -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) {
 

@@ -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) {

@@ -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) {
-Original file line number
+Diff line change
@@ Expand Up / @@ -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) {
@@ Expand Down @@