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/08/30 17:50:55 UTC

svn commit: r1866160 - /pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/text/PDFTextStripperByArea.java

Author: tilman
Date: Fri Aug 30 17:50:55 2019
New Revision: 1866160

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

Modified:
    pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/text/PDFTextStripperByArea.java

Modified: pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/text/PDFTextStripperByArea.java
URL: http://svn.apache.org/viewvc/pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/text/PDFTextStripperByArea.java?rev=1866160&r1=1866159&r2=1866160&view=diff
==============================================================================
--- pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/text/PDFTextStripperByArea.java (original)
+++ pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/text/PDFTextStripperByArea.java Fri Aug 30 17:50:55 2019
@@ -62,7 +62,8 @@ public class PDFTextStripperByArea exten
      * Add a new region to group text by.
      *
      * @param regionName The name of the region.
-     * @param rect The rectangle area to retrieve the text from.
+     * @param rect The rectangle area to retrieve the text from. The y-coordinates are java
+     * coordinates (y == 0 is top), not PDF coordinates (y == 0 is bottom).
      */
     public void addRegion( String regionName, Rectangle2D rect )
     {