* fixed api documentaion

* fixed a wrong method name

Author: Evgeniy Sidenko

src/main/java/openize/heic/decoder/HeicHeader.java

@@ -29,6 +29,7 @@ public class HeicHeader
      * <p>
      * Meta data IsoBmff box.
      * </p>
+     * @return The meta data IsoBmff box.
      */
     public final MetaBox getMeta(){ return meta; }
     /**
@@ -42,6 +43,7 @@ public class HeicHeader
      * <p>
      * The identifier of the default frame.
      * </p>
+     * @return The identifier of the default frame.
      */
     public final /*UInt32*/long getDefaultFrameId() {
         return (meta.getpitm() != null ? meta.getpitm().item_ID : 0);

src/main/java/openize/heic/decoder/HeicImage.java

@@ -53,13 +53,15 @@ private HeicImage(HeicHeader header, BitStreamWithNalSupport stream)
 
     /**
      * <p>
-     * Reads the file meta data and creates a class object for further decoding of the file contents.
-     * <p>This operation does not decode pixels.
-     * Use the default frame methods GetByteArray or GetInt32Array afterwards in order to decode pixels.</p>
+     * Reads the file metadata and creates a class object for further decoding of the file contents.
+     * </p>
+     * <p>
+     * This operation does not decode pixels.
+     * Use the default frame methods GetByteArray or GetInt32Array afterwards in order to decode pixels.
      * </p>
      *
      * @param stream File stream.
-     * @return Returns a heic image object with metadata read.
+     * @return Returns a HEIC image object with metadata read.
      */
     public static HeicImage load(IOStream stream)
     {
@@ -78,7 +80,7 @@ public static HeicImage load(IOStream stream)
 
         while (bitstream.moreData())
         {
-            Box box = Box.parceBox(bitstream);
+            Box box = Box.parseBox(bitstream);
 
             if (box.type == BoxType.meta)
             {
@@ -101,7 +103,7 @@ public static boolean canLoad(IOStream stream)
     {
         BitStreamWithNalSupport bitstream = new BitStreamWithNalSupport(stream);
 
-        Box box = Box.parceBox(bitstream);
+        Box box = Box.parseBox(bitstream);
 
         if (!(box instanceof FileTypeBox))
         {
@@ -122,8 +124,8 @@ public static boolean canLoad(IOStream stream)
     /**
      * <p>
      * Get pixel data of the default image frame in the format of byte array.
-     * <p>Each three or four bytes (the count depends on the pixel format) refer to one pixel left to right top to bottom line by line.</p>
      * </p>
+     * <p>Each three or four bytes (the count depends on the pixel format) refer to one pixel left to right top to bottom line by line.</p>
      *
      * @param pixelFormat     Pixel format that defines the order of colors and the presence of alpha byte.
      * @return Byte array, null if frame does not contain image data.
@@ -136,8 +138,8 @@ public static boolean canLoad(IOStream stream)
     /**
      * <p>
      * Get pixel data of the default image frame in the format of byte array.
-     * <p>Each three or four bytes (the count depends on the pixel format) refer to one pixel left to right top to bottom line by line.</p>
      * </p>
+     * <p>Each three or four bytes (the count depends on the pixel format) refer to one pixel left to right top to bottom line by line.</p>
      *
      * @param pixelFormat     Pixel format that defines the order of colors and the presence of alpha byte.
      * @param boundsRectangle Bounds of the requested area.
@@ -151,8 +153,8 @@ public static boolean canLoad(IOStream stream)
     /**
      * <p>
      * Get pixel data of the default image frame in the format of integer array.
-     * <p>Each int value refers to one pixel left to right top to bottom line by line.</p>
      * </p>
+     * <p>Each int value refers to one pixel left to right top to bottom line by line.</p>
      *
      * @param pixelFormat     Pixel format that defines the order of colors.
      * @return Integer array, null if frame does not contain image data.
@@ -165,8 +167,8 @@ public final int[] getInt32Array(PixelFormat pixelFormat)
     /**
      * <p>
      * Get pixel data of the default image frame in the format of integer array.
-     * <p>Each int value refers to one pixel left to right top to bottom line by line.</p>
      * </p>
+     * <p>Each int value refers to one pixel left to right top to bottom line by line.</p>
      *
      * @param pixelFormat     Pixel format that defines the order of colors.
      * @param boundsRectangle Bounds of the requested area.
@@ -181,6 +183,7 @@ public final int[] getInt32Array(PixelFormat pixelFormat, Rectangle boundsRectan
      * <p>
      * Heic image header. Grants convenient access to IsoBmff container meta data.
      * </p>
+     * @return The Heic image header.
      */
     public final HeicHeader getHeader()
     {
@@ -191,6 +194,7 @@ public final HeicHeader getHeader()
      * <p>
      * Dictionary of public Heic image frames with access by identifier.
      * </p>
+     * @return The dictionary of public Heic image frames with access by identifier.
      */
     public final Map<Long, HeicImageFrame> getFrames()
     {
@@ -202,6 +206,7 @@ public final Map<Long, HeicImageFrame> getFrames()
      * <p>
      * Dictionary of all Heic image frames with access by identifier.
      * </p>
+     * @return The dictionary of all Heic image frames with access by identifier.
      */
     public final Map<Long, HeicImageFrame> getAllFrames()
     {
@@ -210,8 +215,9 @@ public final Map<Long, HeicImageFrame> getAllFrames()
 
     /**
      * <p>
-     * Returns the default image frame, which is specified in meta data.
+     * Returns the default image frame, which is specified in metadata.
      * </p>
+     * @return the default image frame, which is specified in metadata.
      */
     public final HeicImageFrame getDefaultFrame()
     {
@@ -222,6 +228,7 @@ public final HeicImageFrame getDefaultFrame()
      * <p>
      * Width of the default image frame in pixels.
      * </p>
+     * @return The width of the default image frame in pixels.
      */
     public final /*UInt32*/long getWidth()
     {
@@ -232,6 +239,7 @@ public final HeicImageFrame getDefaultFrame()
      * <p>
      * Height of the default image frame in pixels.
      * </p>
+     * @return The height of the default image frame in pixels.
      */
     public final /*UInt32*/long getHeight()
     {
@@ -240,7 +248,7 @@ public final HeicImageFrame getDefaultFrame()
 
     /**
      * <p>
-     * Fill frames dictionary with read meta data.
+     * Fill frames dictionary with read metadata.
      * </p>
      *
      * @param stream File stream.

src/main/java/openize/heic/decoder/HeicImageFrame.java

@@ -96,8 +96,9 @@ public class HeicImageFrame
 
     /**
      * <p>
-     * Type of an image frame content.
+     * Type of image frame content.
      * </p>
+     * @return The type of image frame content.
      */
     public final ImageFrameType getImageType()
     {
@@ -108,6 +109,7 @@ public final ImageFrameType getImageType()
      * <p>
      * Width of the image frame in pixels.
      * </p>
+     * @return The width of the image frame in pixels.
      */
     public final /*UInt32*/long getWidth()
     {
@@ -118,6 +120,7 @@ public final ImageFrameType getImageType()
      * <p>
      * Height of the image frame in pixels.
      * </p>
+     * @return The height of the image frame in pixels.
      */
     public final /*UInt32*/long getHeight()
     {
@@ -126,7 +129,7 @@ public final ImageFrameType getImageType()
 
     /**
      * <p>
-     * Indicates the presence of transparency of transparency layer.
+     * Indicates the presence of transparency of layer.
      * </p>
      *
      * @return True if frame is linked with alpha data frame, false otherwise.
@@ -174,8 +177,9 @@ public final boolean isDerived()
 
     /**
      * <p>
-     * Indicates the type of derivative content if the frame is derived.
+     * Returns the type of derivative content if the frame is derived.
      * </p>
+     * @return The type of derivative content if the frame is derived.
      */
     public final BoxType getDerivativeType()
     {
@@ -184,8 +188,9 @@ public final BoxType getDerivativeType()
 
     /**
      * <p>
-     * Indicates the type of auxiliary reference layer if the frame type is auxiliary.
+     * Returns the type of auxiliary reference layer if the frame type is auxiliary.
      * </p>
+     * @return The type of auxiliary reference layer if the frame type is auxiliary.
      */
     public final AuxiliaryReferenceType getAuxiliaryReferenceType()
     {
@@ -196,6 +201,7 @@ public final AuxiliaryReferenceType getAuxiliaryReferenceType()
      * <p>
      * Indicates the type of auxiliary reference layer if the frame type is auxiliary.
      * </p>
+     * @param value the type of auxiliary reference layer if the frame type is auxiliary.
      */
     private void setAuxiliaryReferenceType(AuxiliaryReferenceType value)
     {
@@ -206,26 +212,18 @@ private void setAuxiliaryReferenceType(AuxiliaryReferenceType value)
      * <p>
      * Number of channels with color data.
      * </p>
+     * @return The number of channels with color data.
      */
     public final byte getNumberOfChannels()
     {
         return numberOfChannels;
     }
 
-    /**
-     * <p>
-     * Number of channels with color data.
-     * </p>
-     */
-    private void setNumberOfChannels(byte value)
-    {
-        numberOfChannels = value;
-    }
-
     /**
      * <p>
      * Bits per channel with color data.
      * </p>
+     * @return The bits per channel with color data.
      */
     public final byte[] getBitsPerChannel()
     {
@@ -234,14 +232,13 @@ public final byte[] getBitsPerChannel()
 
     /**
      * <p>
-     * Bits per channel with color data.
+     * Get pixel data in the format of byte array.
      * </p>
+     * <p>Each three or four bytes (the count depends on the pixel format) refer to one pixel left to right top to bottom line by line.</p>
+     *
+     * @param pixelFormat     Pixel format that defines the order of colors and the presence of alpha byte.
+     * @return Byte array, null if frame does not contain image data.
      */
-    private void setBitsPerChannel(byte[] value)
-    {
-        bitsPerChannel = value;
-    }
-
     public final byte[] getByteArray(PixelFormat pixelFormat)
     {
         return getByteArray(pixelFormat, new Rectangle());
@@ -250,8 +247,8 @@ public final byte[] getByteArray(PixelFormat pixelFormat)
     /**
      * <p>
      * Get pixel data in the format of byte array.
-     * <p>Each three or four bytes (the count depends on the pixel format) refer to one pixel left to right top to bottom line by line.</p>
      * </p>
+     * <p>Each three or four bytes (the count depends on the pixel format) refer to one pixel left to right top to bottom line by line.</p>
      *
      * @param pixelFormat     Pixel format that defines the order of colors and the presence of alpha byte.
      * @param boundsRectangle Bounds of the requested area.
@@ -292,6 +289,15 @@ public final byte[] getByteArray(PixelFormat pixelFormat, Rectangle boundsRectan
         return output;
     }
 
+    /**
+     * <p>
+     * Get pixel data in the format of integer array.
+     * </p>
+     * <p>Each int value refers to one pixel left to right top to bottom line by line.</p>
+     *
+     * @param pixelFormat     Pixel format that defines the order of colors.
+     * @return Integer array, null if frame does not contain image data.
+     */
     public final int[] getInt32Array(PixelFormat pixelFormat)
     {
         return getInt32Array(pixelFormat, new Rectangle());
@@ -300,8 +306,8 @@ public final int[] getInt32Array(PixelFormat pixelFormat)
     /**
      * <p>
      * Get pixel data in the format of integer array.
-     * <p>Each int value refers to one pixel left to right top to bottom line by line.</p>
      * </p>
+     * <p>Each int value refers to one pixel left to right top to bottom line by line.</p>
      *
      * @param pixelFormat     Pixel format that defines the order of colors.
      * @param boundsRectangle Bounds of the requested area.
@@ -341,10 +347,10 @@ public final int[] getInt32Array(PixelFormat pixelFormat, Rectangle boundsRectan
     /**
      * <p>
      * Get frame text data.
-     * <p>Exists only for mime frame types.</p>
      * </p>
+     * <p>Exists only for mime frame types.</p>
      *
-     * @return String
+     * @return The frame text data.
      */
     public final String getTextData()
     {
@@ -375,11 +381,11 @@ public final String getTextData()
     /**
      * <p>
      * Add layer reference to the frame.
-     * Used to link reference layers that are reverce-linked (alpha layer, depth map, hdr).
+     * Used to link reference layers that are reverse-linked (alpha layer, depth map, hdr).
      * </p>
      *
-     * @param id   Layer identificator.
-     * @param type Layer type.
+     * @param id   A layer identifier.
+     * @param type A layer type.
      */
     final void addLayerReference(/*UInt32*/long id, AuxiliaryReferenceType type)
     {
@@ -759,8 +765,8 @@ private void loadProperties(BitStreamWithNalSupport stream, List<Box> properties
                     break;
                 case pixi:
                     PixelInformationProperty pixi = (PixelInformationProperty) item;
-                    setNumberOfChannels(pixi.num_channels);
-                    setBitsPerChannel(pixi.bits_per_channel);
+                    this.numberOfChannels = pixi.num_channels;
+                    this.bitsPerChannel = pixi.bits_per_channel;
                     break;
                 case rloc:
                     //RelativeLocationProperty rloc = (RelativeLocationProperty) item;

src/main/java/openize/isobmff/ItemPropertyContainerBox.java

@@ -46,7 +46,7 @@ public ItemPropertyContainerBox(BitStreamReader stream, /*UInt64*/long startPos)
         int i = 1;
         while (stream.getBitPosition() < startPos + size * 8)
         {
-            items.put(i, Box.parceBox(stream));
+            items.put(i, Box.parseBox(stream));
             i++;
         }
 

src/main/java/openize/isobmff/MetaBox.java

@@ -49,7 +49,7 @@ public MetaBox(BitStreamReader stream, /*UInt64*/long size, /*UInt64*/long start
 
         while (stream.getBitPosition() < startPos + size * 8)
         {
-            Box box = Box.parceBox(stream);
+            Box box = Box.parseBox(stream);
             boxes.put(box.type, box);
         }
 

src/main/java/openize/isobmff/MovieBox.java

@@ -48,7 +48,7 @@ public MovieBox(BitStreamReader stream, /*UInt64*/long size, /*UInt64*/long star
 
         while (stream.getBitPosition() < startPos + size * 8)
         {
-            Box box = Box.parceBox(stream);
+            Box box = Box.parseBox(stream);
             boxes.add(box);
         }