You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pdfbox.apache.org by ti...@apache.org on 2019/09/20 16:45:17 UTC
svn commit: r1867240 -
/pdfbox/branches/issue4569/tools/src/main/java/org/apache/pdfbox/tools/imageio/ImageIOUtil.java
Author: tilman
Date: Fri Sep 20 16:45:17 2019
New Revision: 1867240
URL: http://svn.apache.org/viewvc?rev=1867240&view=rev
Log:
PDFBOX-4071: improve javadoc
Modified:
pdfbox/branches/issue4569/tools/src/main/java/org/apache/pdfbox/tools/imageio/ImageIOUtil.java
Modified: pdfbox/branches/issue4569/tools/src/main/java/org/apache/pdfbox/tools/imageio/ImageIOUtil.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/issue4569/tools/src/main/java/org/apache/pdfbox/tools/imageio/ImageIOUtil.java?rev=1867240&r1=1867239&r2=1867240&view=diff
==============================================================================
--- pdfbox/branches/issue4569/tools/src/main/java/org/apache/pdfbox/tools/imageio/ImageIOUtil.java (original)
+++ pdfbox/branches/issue4569/tools/src/main/java/org/apache/pdfbox/tools/imageio/ImageIOUtil.java Fri Sep 20 16:45:17 2019
@@ -78,7 +78,8 @@ public final class ImageIOUtil
* used as the image format.
* @param dpi the resolution in dpi (dots per inch) to be used in metadata
* @param compressionQuality quality to be used when compressing the image (0 <
- * compressionQuality < 1.0f)
+ * compressionQuality < 1.0f). See {@link ImageWriteParam#setCompressionQuality(float)} for
+ * more details.
* @return true if the image file was produced, false if there was an error.
* @throws IOException if an I/O error occurs
*/
@@ -169,7 +170,8 @@ public final class ImageIOUtil
* @param output the output stream to be used for writing
* @param dpi the resolution in dpi (dots per inch) to be used in metadata
* @param compressionQuality quality to be used when compressing the image (0 <
- * compressionQuality < 1.0f)
+ * compressionQuality < 1.0f). See {@link ImageWriteParam#setCompressionQuality(float)} for
+ * more details.
* @return true if the image file was produced, false if there was an error.
* @throws IOException if an I/O error occurs
*/
@@ -191,8 +193,9 @@ public final class ImageIOUtil
* @param formatName the target format (ex. "png")
* @param output the output stream to be used for writing
* @param dpi the resolution in dpi (dots per inch) to be used in metadata
- * @param compressionQuality quality to be used when compressing the image
- * (0 < compressionQuality < 1.0f)
+ * @param compressionQuality quality to be used when compressing the image * (0 <
+ * compressionQuality < 1.0f). See {@link ImageWriteParam#setCompressionQuality(float)} for
+ * more details.
* @param compressionType Advanced users only, and only relevant for TIFF
* files: If null, save uncompressed; if empty string, use logic explained
* above; other valid values are found in the javadoc of