svn commit: r1813552 - /pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/image/JPEGFactory.java

[ti...@apache.org]

Author: tilman
Date: Fri Oct 27 17:29:58 2017
New Revision: 1813552

URL: http://svn.apache.org/viewvc?rev=1813552&view=rev
Log:
PDFBOX-2852: clarify javadoc

Modified:
    pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/image/JPEGFactory.java

Modified: pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/image/JPEGFactory.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/image/JPEGFactory.java?rev=1813552&r1=1813551&r2=1813552&view=diff
==============================================================================
--- pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/image/JPEGFactory.java (original)
+++ pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/image/JPEGFactory.java Fri Oct 27 17:29:58 2017
@@ -197,7 +197,7 @@ public final class JPEGFactory
      * quality by calling {@link #createFromStream(org.apache.pdfbox.pdmodel.PDDocument,
      * java.io.InputStream) createFromStream()} instead.
      * 
-     * The image will be created at 72 DPI.
+     * The image will be created with a dpi value of 72 to be stored in metadata.
      * @param document the document where the image will be created
      * @param image the BufferedImage to embed
      * @param quality the desired JPEG compression quality
@@ -211,7 +211,7 @@ public final class JPEGFactory
     }
 
     /**
-     * Creates a new JPEG Image XObject from a BufferedImage, a given quality and DPI.
+     * Creates a new JPEG Image XObject from a BufferedImage, a given quality and dpi metadata.
      * <p>
      * Do not read a JPEG image from a stream/file and call this method; you'll get more speed and
      * quality by calling {@link #createFromStream(org.apache.pdfbox.pdmodel.PDDocument,
@@ -220,7 +220,8 @@ public final class JPEGFactory
      * @param document the document where the image will be created
      * @param image the BufferedImage to embed
      * @param quality the desired JPEG compression quality
-     * @param dpi the desired DPI (resolution) of the JPEG
+     * @param dpi the desired dpi (resolution) value of the JPEG to be stored in metadata. This
+     * value has no influence on image content or size.
      * @return a new Image XObject
      * @throws IOException if the JPEG data cannot be written
      */