svn commit: r1891511 - /pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/PageLayout.java

[ti...@apache.org]

Author: tilman
Date: Tue Jul 13 17:45:24 2021
New Revision: 1891511

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

Modified:
    pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/PageLayout.java

Modified: pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/PageLayout.java
URL: http://svn.apache.org/viewvc/pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/PageLayout.java?rev=1891511&r1=1891510&r2=1891511&view=diff
==============================================================================
--- pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/PageLayout.java (original)
+++ pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/PageLayout.java Tue Jul 13 17:45:24 2021
@@ -17,6 +17,8 @@
 
 package org.apache.pdfbox.pdmodel;
 
+import org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences;
+
 /**
  * A name object specifying the page layout shall be used when the document is opened.
  *
@@ -33,13 +35,20 @@ public enum PageLayout
     /** Display the pages in two columns), with odd numbered pages on the left. */
     TWO_COLUMN_LEFT("TwoColumnLeft"),
 
-    /** Display the pages in two columns), with odd numbered pages on the right.  */
+    /**
+     * Display the pages in two columns), with odd numbered pages on the right. See also
+     * {@link PDViewerPreferences#setReadingDirection(org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences.READING_DIRECTION) PDViewerPreferences.setReadingDirection()}
+     * if dealing with RTL language.
+     */
     TWO_COLUMN_RIGHT("TwoColumnRight"),
 
     /** Display the pages two at a time), with odd-numbered pages on the left. */
     TWO_PAGE_LEFT("TwoPageLeft"),
 
-    /** Display the pages two at a time), with odd-numbered pages on the right. */
+    /** Display the pages two at a time), with odd-numbered pages on the right. See also
+     * {@link PDViewerPreferences#setReadingDirection(org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences.READING_DIRECTION) PDViewerPreferences.setReadingDirection()}
+     * if dealing with RTL language.
+     */
     TWO_PAGE_RIGHT("TwoPageRight");
 
     public static PageLayout fromString(String value)