correct small details on the javadoc

bioimage-io · Dec 12, 2023 · 0d62b24 · 0d62b24
1 parent 19a69a4
commit 0d62b24
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 11 deletions.
diff --git a/src/main/java/io/bioimage/modelrunner/tensor/shm/SharedMemoryArray.java b/src/main/java/io/bioimage/modelrunner/tensor/shm/SharedMemoryArray.java
@@ -226,8 +226,6 @@ else if (PlatformDetection.isLinux())
 	 * If the shared memory region follows that convention, only the name of the shared memory region is needed to 
 	 * reconstruct the underlying nd array.
 	 * 
-	 * @param <T>
-     * 	possible ImgLib2 data types of the retrieved {@link RandomAccessibleInterval}
 	 * @param memoryName
 	 * 	name of the region where the shared memory segment is located
 	 * @return the {@link RandomAccessibleInterval} defined exclusively by the shared memory region following the .npy format
@@ -316,9 +314,9 @@ public static <T extends RealType<T> & NativeType<T>> int getArrayByteSize(long[
      * 
 	 * @return the unique name for the shared memory, specified as a string and as 
 	 * 	the Python package multiprocessing.shared_memory returns it. For Unix based systems it removes the 
-	 * 	initial "/", for example: "/shm_block" -> "shm_block".
+	 * 	initial "/", for example: "/shm_block" -&gt; "shm_block".
 	 * 	In Windows shared memory block names start either with "Global\\" or "Local\\", this is also removed when 
-	 * 	providing a shared memory name to Python. Example: "Local\\shm_block" -> "shm_block"
+	 * 	providing a shared memory name to Python. Example: "Local\\shm_block" -&gt; "shm_block"
      */
     public String getNameForPython();
 
@@ -330,7 +328,7 @@ public static <T extends RealType<T> & NativeType<T>> int getArrayByteSize(long[
 
     /**
      * 
-     * @return
+     * @return get number of bytes in the shared memory segment
      */
     public int getSize();
 

diff --git a/src/main/java/io/bioimage/modelrunner/tensor/shm/SharedMemoryArrayLinux.java b/src/main/java/io/bioimage/modelrunner/tensor/shm/SharedMemoryArrayLinux.java
@@ -27,6 +27,7 @@
 
 import io.bioimage.modelrunner.numpy.DecodeNumpy;
 import io.bioimage.modelrunner.tensor.Utils;
+import io.bioimage.modelrunner.tensor.Tensor;
 import io.bioimage.modelrunner.utils.CommonUtils;
 
 import com.sun.jna.Native;
@@ -482,8 +483,6 @@ public void close() {
 	 * If the shared memory region follows that convention, only the name of the shared memory region is needed to 
 	 * reconstruct the underlying nd array.
 	 * 
-	 * @param <T>
-     * 	possible ImgLib2 data types of the retrieved {@link RandomAccessibleInterval}
 	 * @param memoryName
 	 * 	name of the region where the shared memory segment is located
 	 * @return the {@link RandomAccessibleInterval} defined exclusively by the shared memory region following the .npy format

diff --git a/src/main/java/io/bioimage/modelrunner/tensor/shm/SharedMemoryArrayMacOS.java b/src/main/java/io/bioimage/modelrunner/tensor/shm/SharedMemoryArrayMacOS.java
@@ -27,6 +27,7 @@
 
 import io.bioimage.modelrunner.numpy.DecodeNumpy;
 import io.bioimage.modelrunner.tensor.Utils;
+import io.bioimage.modelrunner.tensor.Tensor;
 import io.bioimage.modelrunner.utils.CommonUtils;
 
 import com.sun.jna.Native;
@@ -495,8 +496,6 @@ public void close() {
 	 * If the shared memory region follows that convention, only the name of the shared memory region is needed to 
 	 * reconstruct the underlying nd array.
 	 * 
-	 * @param <T>
-     * 	possible ImgLib2 data types of the retrieved {@link RandomAccessibleInterval}
 	 * @param memoryName
 	 * 	name of the region where the shared memory segment is located
 	 * @return the {@link RandomAccessibleInterval} defined exclusively by the shared memory region following the .npy format

diff --git a/src/main/java/io/bioimage/modelrunner/tensor/shm/SharedMemoryArrayWin.java b/src/main/java/io/bioimage/modelrunner/tensor/shm/SharedMemoryArrayWin.java
@@ -32,6 +32,7 @@
 
 import io.bioimage.modelrunner.numpy.DecodeNumpy;
 import io.bioimage.modelrunner.tensor.Utils;
+import io.bioimage.modelrunner.tensor.Tensor;
 import io.bioimage.modelrunner.utils.CommonUtils;
 import net.imglib2.Cursor;
 import net.imglib2.RandomAccessibleInterval;
@@ -516,8 +517,6 @@ public static void main(String[] args) {
 	 * If the shared memory region follows that convention, only the name of the shared memory region is needed to 
 	 * reconstruct the underlying nd array.
 	 * 
-	 * @param <T>
-     * 	possible ImgLib2 data types of the retrieved {@link RandomAccessibleInterval}
 	 * @param memoryName
 	 * 	name of the region where the shared memory segment is located
 	 * @return the {@link RandomAccessibleInterval} defined exclusively by the shared memory region following the .npy format