Fix javadoc for TIFFDirectory and TIFFField

DEVSIX-4193

Autoported commit.
Original commit hash: [d34dbbb01]

Author: BezrukovM

itext/itext.io/itext/io/codec/TIFFDirectory.cs

@@ -684,17 +684,20 @@ public static int GetNumDirectories(RandomAccessFileOrArray stream) {
 
         /// <summary>
         /// Returns a boolean indicating whether the byte order used in the
-        /// the TIFF file is big-endian (i.e. whether the byte order is from
+        /// TIFF file is big-endian (i.e. whether the byte order is from
         /// the most significant to the least significant)
         /// </summary>
+        /// <returns>
+        /// 
+        /// <see langword="true"/>
+        /// if the byte order used in the TIFF file is big-endian
+        /// </returns>
         public virtual bool IsBigEndian() {
             return isBigEndian;
         }
 
-        /// <summary>
-        /// Returns the offset of the IFD corresponding to this
-        /// <c>TIFFDirectory</c>.
-        /// </summary>
+        /// <summary>Returns the offset of the IFD corresponding to this <c>TIFFDirectory</c>.</summary>
+        /// <returns>the offset of the IFD corresponding to this <c>TIFFDirectory</c>.</returns>
         public virtual long GetIFDOffset() {
             return IFDOffset;
         }
@@ -703,6 +706,10 @@ public virtual long GetIFDOffset() {
         /// Returns the offset of the next IFD after the IFD corresponding to this
         /// <c>TIFFDirectory</c>.
         /// </summary>
+        /// <returns>
+        /// the offset of the next IFD after the IFD corresponding to this
+        /// <c>TIFFDirectory</c>.
+        /// </returns>
         public virtual long GetNextIFDOffset() {
             return nextIFDOffset;
         }

itext/itext.io/itext/io/codec/TIFFField.cs

@@ -161,10 +161,10 @@ internal TIFFField() {
         /// </tr>
         /// </table>
         /// </remarks>
-        /// <param name="tag">The tag</param>
-        /// <param name="type"/>
-        /// <param name="count"/>
-        /// <param name="data"/>
+        /// <param name="tag">the tag number</param>
+        /// <param name="type">the tag type</param>
+        /// <param name="count">the number of data items present in the field</param>
+        /// <param name="data">the field data</param>
         public TIFFField(int tag, int type, int count, Object data) {
             this.tag = tag;
             this.type = type;
@@ -237,6 +237,7 @@ public virtual char[] GetAsChars() {
         /// <para /> A ClassCastException will be thrown if the field is not
         /// of type TIFF_SSHORT.
         /// </remarks>
+        /// <returns>TIFF_SSHORT data as an array of shorts (signed 16-bit integers).</returns>
         public virtual short[] GetAsShorts() {
             return (short[])data;
         }
@@ -251,6 +252,7 @@ public virtual short[] GetAsShorts() {
         /// <para /> A ClassCastException will be thrown if the field is not
         /// of type TIFF_SLONG.
         /// </remarks>
+        /// <returns>TIFF_SLONG data as an array of ints (signed 32-bit integers).</returns>
         public virtual int[] GetAsInts() {
             return (int[])data;
         }
@@ -265,6 +267,7 @@ public virtual int[] GetAsInts() {
         /// <para /> A ClassCastException will be thrown if the field is not
         /// of type TIFF_LONG.
         /// </remarks>
+        /// <returns>TIFF_LONG data as an array of longs (signed 64-bit integers).</returns>
         public virtual long[] GetAsLongs() {
             return (long[])data;
         }
@@ -275,6 +278,7 @@ public virtual long[] GetAsLongs() {
         /// <para /> A ClassCastException will be thrown if the field is not
         /// of type TIFF_FLOAT.
         /// </remarks>
+        /// <returns>TIFF_FLOAT data as an array of floats.</returns>
         public virtual float[] GetAsFloats() {
             return (float[])data;
         }
@@ -285,6 +289,7 @@ public virtual float[] GetAsFloats() {
         /// <para /> A ClassCastException will be thrown if the field is not
         /// of type TIFF_DOUBLE.
         /// </remarks>
+        /// <returns>TIFF_DOUBLE data as an array of doubles.</returns>
         public virtual double[] GetAsDoubles() {
             return (double[])data;
         }
@@ -295,6 +300,7 @@ public virtual double[] GetAsDoubles() {
         /// <para /> A ClassCastException will be thrown if the field is not
         /// of type TIFF_ASCII.
         /// </remarks>
+        /// <returns>TIFF_ASCII data as an array of strings.</returns>
         public virtual String[] GetAsStrings() {
             return (String[])data;
         }
@@ -305,6 +311,7 @@ public virtual String[] GetAsStrings() {
         /// <para /> A ClassCastException will be thrown if the field is not
         /// of type TIFF_SRATIONAL.
         /// </remarks>
+        /// <returns>TIFF_SRATIONAL data as an array of 2-element arrays of ints.</returns>
         public virtual int[][] GetAsSRationals() {
             return (int[][])data;
         }
@@ -315,6 +322,7 @@ public virtual int[][] GetAsSRationals() {
         /// <para /> A ClassCastException will be thrown if the field is not
         /// of type TIFF_RATTIONAL.
         /// </remarks>
+        /// <returns>TIFF_RATIONAL data as an array of 2-element arrays of longs.</returns>
         public virtual long[][] GetAsRationals() {
             return (long[][])data;
         }
@@ -335,6 +343,10 @@ public virtual long[][] GetAsRationals() {
         /// TIFF_SSHORT, or TIFF_SLONG.
         /// </remarks>
         /// <param name="index">The index</param>
+        /// <returns>
+        /// data in TIFF_BYTE, TIFF_SBYTE, TIFF_UNDEFINED, TIFF_SHORT, TIFF_SSHORT,
+        /// or TIFF_SLONG format as an int.
+        /// </returns>
         public virtual int GetAsInt(int index) {
             switch (type) {
                 case TIFF_BYTE:
@@ -380,6 +392,10 @@ public virtual int GetAsInt(int index) {
         /// TIFF_SSHORT, TIFF_SLONG, or TIFF_LONG.
         /// </remarks>
         /// <param name="index">The index</param>
+        /// <returns>
+        /// data in TIFF_BYTE, TIFF_SBYTE, TIFF_UNDEFINED, TIFF_SHORT, TIFF_SSHORT, TIFF_SLONG,
+        /// or TIFF_LONG format as a long.
+        /// </returns>
         public virtual long GetAsLong(int index) {
             switch (type) {
                 case TIFF_BYTE:
@@ -415,16 +431,17 @@ public virtual long GetAsLong(int index) {
 
         /// <summary>Returns data in any numerical format as a float.</summary>
         /// <remarks>
-        /// Returns data in any numerical format as a float.  Data in
+        /// Returns data in any numerical format as a float. Data in
         /// TIFF_SRATIONAL or TIFF_RATIONAL format are evaluated by
         /// dividing the numerator into the denominator using
         /// double-precision arithmetic and then truncating to single
-        /// precision.  Data in TIFF_SLONG, TIFF_LONG, or TIFF_DOUBLE
+        /// precision. Data in TIFF_SLONG, TIFF_LONG, or TIFF_DOUBLE
         /// format may suffer from truncation.
         /// <para /> A ClassCastException will be thrown if the field is
         /// of type TIFF_UNDEFINED or TIFF_ASCII.
         /// </remarks>
         /// <param name="index">The index</param>
+        /// <returns>data in any numerical format as a float.</returns>
         public virtual float GetAsFloat(int index) {
             switch (type) {
                 case TIFF_BYTE: {
@@ -475,16 +492,17 @@ public virtual float GetAsFloat(int index) {
             }
         }
 
-        /// <summary>Returns data in any numerical format as a float.</summary>
+        /// <summary>Returns data in any numerical format as a double.</summary>
         /// <remarks>
-        /// Returns data in any numerical format as a float.  Data in
+        /// Returns data in any numerical format as a double. Data in
         /// TIFF_SRATIONAL or TIFF_RATIONAL format are evaluated by
         /// dividing the numerator into the denominator using
         /// double-precision arithmetic.
         /// <para /> A ClassCastException will be thrown if the field is of
         /// type TIFF_UNDEFINED or TIFF_ASCII.
         /// </remarks>
         /// <param name="index">The index</param>
+        /// <returns>data in any numerical format as a double.</returns>
         public virtual double GetAsDouble(int index) {
             switch (type) {
                 case TIFF_BYTE: {
@@ -542,6 +560,7 @@ public virtual double GetAsDouble(int index) {
         /// of type TIFF_ASCII.
         /// </remarks>
         /// <param name="index">The index</param>
+        /// <returns>a TIFF_ASCII data item as a String.</returns>
         public virtual String GetAsString(int index) {
             return ((String[])data)[index];
         }
@@ -557,6 +576,7 @@ public virtual String GetAsString(int index) {
         /// of type TIFF_SRATIONAL.
         /// </remarks>
         /// <param name="index">The index</param>
+        /// <returns>a TIFF_SRATIONAL data item as a two-element array of ints.</returns>
         public virtual int[] GetAsSRational(int index) {
             return ((int[][])data)[index];
         }
@@ -572,6 +592,7 @@ public virtual int[] GetAsSRational(int index) {
         /// of type TIFF_RATIONAL.
         /// </remarks>
         /// <param name="index">The index</param>
+        /// <returns>a TIFF_RATIONAL data item as a two-element array of ints</returns>
         public virtual long[] GetAsRational(int index) {
             if (type == TIFF_LONG) {
                 return GetAsLongs();

port-hash

@@ -1 +1 @@
-5122a85b0f187436d65f354d97b1d080e8975e20
+d34dbbb016d778e89e04f0e5e35554b6d193f989