From bf6e6e7fb5aaac4855058a16ab9b52cf9c6d2771 Mon Sep 17 00:00:00 2001
From: oburri <olivier.burri@gmail.com>
Date: Mon, 25 Nov 2024 11:37:11 +0100
Subject: [PATCH] fixes javadoc

---
 src/main/java/ch/epfl/biop/operetta/OperettaManager.java    | 6 +++++-
 .../biop/operetta/commands/OperettaImporterInteractive.java | 2 ++
 2 files changed, 7 insertions(+), 1 deletion(-)

diff --git a/src/main/java/ch/epfl/biop/operetta/OperettaManager.java b/src/main/java/ch/epfl/biop/operetta/OperettaManager.java
index 9bf8dcc..688a9e6 100644
--- a/src/main/java/ch/epfl/biop/operetta/OperettaManager.java
+++ b/src/main/java/ch/epfl/biop/operetta/OperettaManager.java
@@ -446,6 +446,7 @@ public ImagePlus getWellImage(Well well) {
      * Returns a stitched stack for the given well and associated fields
      *
      * @param well   the well to export
+     * @param fields the fields that we want to use for this well
      * @param bounds a ROI describing the subregion we want to export (pixel coordinates)
      * @return an ImageStack
      */
@@ -794,6 +795,8 @@ private ImageProcessor openTiffFileAsImageProcessor(String id) {
     /**
      * Processes all fields in the selected wells based on the desired builder options.
      * @see OperettaManager.Builder
+     *
+     * @param wells the list of Wells we want to process
      */
     public void process(List<Well> wells) { process( wells, null, null ); }
 
@@ -1294,7 +1297,7 @@ public Builder coordinatesCorrectionFactor(double correction_factor) {
         /**
          * Set the downsampling from the builder
          *
-         * @param downsample a downsample factor > 1 explaining by how much we should reduce the XY image
+         * @param downsample a downsample factor &gt; 1 explaining by how much we should reduce the XY image
          * @return a Builder object, to continue building parameters
          */
         public Builder setDownsample(int downsample) {
@@ -1316,6 +1319,7 @@ public Builder useAveraging( boolean use_averaging) {
          * Optional: adds a way to monitor the progression of a process using scijava TaskService
          *
          * @param taskService a service that monitors the progression of a process
+         * @return this Builder, to continue building options
          */
         public Builder setTaskService(TaskService taskService) {
             this.taskService = taskService;
diff --git a/src/main/java/ch/epfl/biop/operetta/commands/OperettaImporterInteractive.java b/src/main/java/ch/epfl/biop/operetta/commands/OperettaImporterInteractive.java
index 68374e6..676f1ac 100644
--- a/src/main/java/ch/epfl/biop/operetta/commands/OperettaImporterInteractive.java
+++ b/src/main/java/ch/epfl/biop/operetta/commands/OperettaImporterInteractive.java
@@ -432,6 +432,7 @@ public void doProcess() {
     /**
      * Returns the available Fields as a String list with format [Field #, Field #,...]
      *
+     * @param opm the {@link OperettaManager} instance to use
      * @return a list of field ids as Strings
      */
     public List<String> getAvailableFieldsString(OperettaManager opm ) {
@@ -447,6 +448,7 @@ public List<String> getAvailableFieldsString(OperettaManager opm ) {
     /**
      * Returns the available Wells as a String list with format [R#-C#, R#-C#,...]
      *
+     * @param opm the {@link OperettaManager} instance to use
      * @return aa list of Strings with the Well names
      */
     public List<String> getAvailableWellsString(OperettaManager opm ) {