svn commit: r1751143 - /pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/text/TextPosition.java

[ti...@apache.org]

Author: tilman
Date: Sun Jul  3 10:01:52 2016
New Revision: 1751143

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

Modified:
    pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/text/TextPosition.java

Modified: pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/text/TextPosition.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/text/TextPosition.java?rev=1751143&r1=1751142&r2=1751143&view=diff
==============================================================================
--- pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/text/TextPosition.java (original)
+++ pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/text/TextPosition.java Sun Jul  3 10:01:52 2016
@@ -120,7 +120,7 @@ public final class TextPosition
      * @param charCodes An array of the internal PDF character codes for the glyphs in this text.
      * @param font The current font for this text position.
      * @param fontSize The new font size.
-     * @param fontSizeInPt The font size in pt units.
+     * @param fontSizeInPt The font size in pt units (see {@link #getFontSizeInPt()} for details).
      */
     public TextPosition(int pageRotation, float pageWidth, float pageHeight, Matrix textMatrix,
                         float endX, float endY, float maxHeight, float individualWidth,
@@ -181,8 +181,8 @@ public final class TextPosition
     /**
      * The matrix containing the starting text position and scaling. Despite the name, it is not the
      * text matrix set by the "Tm" operator, it is really the effective text rendering matrix (which
-     * is dependent on the current transformation matrix, the text matrix, the font size and the
-     * page cropbox).
+     * is dependent on the current transformation matrix (set by the "cm" operator), the text matrix
+     * (set by the "Tm" operator), the font size (set by the "Tf" operator) and the page cropbox).
      *
      * @return The Matrix containing the starting text position
      */
@@ -408,7 +408,8 @@ public final class TextPosition
     /**
      * This will get the font size that has been set with the "Tf" operator (Set text font and
      * size). When the text is rendered, it may appear bigger or smaller depending on the current
-     * transformation matrix and the text matrix.
+     * transformation matrix (set by the "cm" operator) and the text matrix (set by the "Tm"
+     * operator).
      *
      * @return The font size.
      */
@@ -453,7 +454,11 @@ public final class TextPosition
     }
 
     /**
-     * @return Returns the xScale.
+     * This will get the X scaling factor. This is dependent on the current transformation matrix
+     * (set by the "cm" operator), the text matrix (set by the "Tm" operator) and the font size (set
+     * by the "Tf" operator).
+     *
+     * @return The X scaling factor.
      */
     public float getXScale()
     {
@@ -461,7 +466,11 @@ public final class TextPosition
     }
 
     /**
-     * @return Returns the yScale.
+     * This will get the Y scaling factor. This is dependent on the current transformation matrix
+     * (set by the "cm" operator), the text matrix (set by the "Tm" operator) and the font size (set
+     * by the "Tf" operator).
+     *
+     * @return The Y scaling factor.
      */
     public float getYScale()
     {