add docs

bioimage-io · Oct 18, 2024 · 45ccf89 · 45ccf89
1 parent ff20e58
commit 45ccf89
Showing 1 changed file with 4 additions and 3 deletions.
diff --git a/src/main/java/io/bioimage/modelrunner/numpy/DecodeNumpy.java b/src/main/java/io/bioimage/modelrunner/numpy/DecodeNumpy.java
@@ -565,7 +565,7 @@ private static Img<ByteType> buildBoolean(ByteBuffer buf, ByteOrder byteOrder, l
      * 	possible ImgLib2 datatypes of the {@link RandomAccessibleInterval}
      * @param rai
      * 	the n-dimensional array of interest
-     * @param
+     * @param fortranOrder
      * 	whether the array is in fortran order or not
      * @return a long value specifying the number of bytes it would take to store the nd-array in Numpy format
      */
@@ -660,7 +660,7 @@ long calculateNpyStyleByteArrayLength(long[] shape, T datatype, boolean fortranO
 
     /**
      * Method to convert a {@link RandomAccessibleInterval} into the byte array that is used by Numpy
-     * to create .npy files.
+     * to create .npy files. The array craeted is always c order, not fortran order.
      * The byte array created contains the flattened data of the {@link RandomAccessibleInterval} plus
      * information of the shape, data type, fortran order and byte order
      * @param <T>
@@ -757,7 +757,8 @@ long calculateNpyStyleByteArrayLength(long[] shape, T datatype, boolean fortranO
     }
 
     /**
-     * Method that saves a {@link RandomAccessibleInterval} nd array to a .npy Numpy radable file
+     * Method that saves a {@link RandomAccessibleInterval} nd array to a .npy Numpy readable file.
+     * The array is always saved as 'c' order.
      * @param <T>
      * 	possible ImgLib2 data types of the provided {@link RandomAccessibleInterval}
      * @param filePath