svn commit: r1839392 - /pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/xobject/PDJpeg.java

[ti...@apache.org]

Author: tilman
Date: Tue Aug 28 03:39:41 2018
New Revision: 1839392

URL: http://svn.apache.org/viewvc?rev=1839392&view=rev
Log:
PDFBOX-4071: improve javadoc

Modified:
    pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/xobject/PDJpeg.java

Modified: pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/xobject/PDJpeg.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/xobject/PDJpeg.java?rev=1839392&r1=1839391&r2=1839392&view=diff
==============================================================================
--- pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/xobject/PDJpeg.java (original)
+++ pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/xobject/PDJpeg.java Tue Aug 28 03:39:41 2018
@@ -39,6 +39,7 @@ import java.util.List;
 import javax.imageio.ImageIO;
 import javax.imageio.IIOException;
 import javax.imageio.ImageReader;
+import javax.imageio.ImageWriteParam;
 import javax.imageio.metadata.IIOMetadata;
 import javax.imageio.stream.ImageInputStream;
 
@@ -155,7 +156,9 @@ public class PDJpeg extends PDXObjectIma
      *
      * @param doc The document to create the image as part of.
      * @param bi The image to convert to a jpeg
-     * @param compressionQuality The quality level which is used to compress the image
+     * @param compressionQuality The desired JPEG compression quality; between 0
+     * (best compression) and 1 (best image quality). See
+     * {@link ImageWriteParam#setCompressionQuality(float)} for more details.
      * @throws IOException If there is an error processing the jpeg data.
      */
     public PDJpeg( PDDocument doc, BufferedImage bi, float compressionQuality ) throws IOException