doc: add parameters descriptions

saalfeldlab · Jul 10, 2023 · e633b52 · e633b52
1 parent 6841133
commit e633b52
Show file tree

Hide file tree

Showing 5 changed files with 12 additions and 7 deletions.
diff --git a/src/main/java/org/janelia/saalfeldlab/control/VPotControl.java b/src/main/java/org/janelia/saalfeldlab/control/VPotControl.java
@@ -63,7 +63,7 @@ public interface VPotControl extends AdjustableClippingIntControl {
 	 *   this into an enum or if we will have to permit other display modes
 	 *   (for which keeping this na integer sounds fair).
 	 *
-	 * @param display
+	 * @param display the display type
 	 */
 	public void setDisplayType(final int display);
 }
diff --git a/src/main/java/org/janelia/saalfeldlab/control/mcu/XTouchMiniMCUControlPanel.java b/src/main/java/org/janelia/saalfeldlab/control/mcu/XTouchMiniMCUControlPanel.java
@@ -128,8 +128,8 @@ public int getNumFaderControls() {
 	/**
 	 * Reset all controls.
 	 *
-	 * @throws InterruptedException
-	 * @throws InvalidMidiDataException
+	 * @throws InterruptedException if interrupted
+	 * @throws InvalidMidiDataException if midi data are invalid
 	 */
 	public void reset() throws InterruptedException, InvalidMidiDataException {
 

diff --git a/src/main/java/org/janelia/saalfeldlab/n5/bdv/N5Viewer.java b/src/main/java/org/janelia/saalfeldlab/n5/bdv/N5Viewer.java
@@ -133,10 +133,14 @@ public N5Viewer(final Frame parent, final DataSelection selection) throws IOExce
 
 	/**
 	 * Creates a new N5Viewer with the given data sets.
+	 * 
+	 * @param <T> the image data type
+	 * @param <V> the image volatile data type
+	 * @param <R> the n5 reader type
 	 * @param parentFrame parent frame, can be null
 	 * @param dataSelection data sets to display
 	 * @param wantFrame if true, use BdvHandleFrame and display a window. If false, use a BdvHandlePanel and do not display anything.
-	 * @throws IOException
+	 * @throws IOException if data could not be read
 	 */
 	public < T extends NumericType< T > & NativeType< T >,
 					V extends Volatile< T > & NumericType< V >,

diff --git a/src/main/java/org/janelia/saalfeldlab/n5/bdv/tools/boundingbox/BoxCrop.java b/src/main/java/org/janelia/saalfeldlab/n5/bdv/tools/boundingbox/BoxCrop.java
@@ -465,9 +465,10 @@ protected boolean canStackVisibleSources( boolean showMessage )
 	 *
 	 * @param srcList the source list
 	 * @param affine the affine
+	 * @param tolerance the tolerance within which affines may differ to be "equal"
 	 * @return true if all sources have a matching scale level
 	 */
-	protected boolean findMatchingScaleLevels( List<SourceAndConverter<?>> srcList, AffineTransform3D affine, double threshold )
+	protected boolean findMatchingScaleLevels( List<SourceAndConverter<?>> srcList, AffineTransform3D affine, double tolerance )
 	{
 		scales = new int[ srcList.size() ];
 		Arrays.fill( scales, -1 );
@@ -480,7 +481,7 @@ protected boolean findMatchingScaleLevels( List<SourceAndConverter<?>> srcList,
 			for( int j = 0; j < N; j++ )
 			{
 				sac.getSpimSource().getSourceTransform( 0, j, testTransform );
-				if( affineAlmostEqual( testTransform, affine, threshold ))
+				if( affineAlmostEqual( testTransform, affine, tolerance ))
 				{
 					scales[i] = j;
 					continue;

diff --git a/src/main/java/org/janelia/saalfeldlab/n5/metadata/MetadataSource.java b/src/main/java/org/janelia/saalfeldlab/n5/metadata/MetadataSource.java
@@ -195,7 +195,7 @@ public static DefaultAxisMetadata defaultAxes( N5DatasetMetadata meta ) {
 	 * The default axes for dialects that store only spatial data (n5viewer and cosem).
 	 *
 	 * @param meta the metadata
-	 * @return axes
+	 * @return axes default axis metadata
 	 */
 	public static DefaultAxisMetadata defaultAxesSpatial( N5DatasetMetadata meta ) {