style/javadoc changes only

git-svn-id: https://svn.apache.org/repos/asf/xmlgraphics/fop/trunk@196816 13f79535-47bb-0310-9956-ffa450edef68

diff --git a/src/java/org/apache/fop/apps/Driver.java b/src/java/org/apache/fop/apps/Driver.java
index c93da0a3924240ba64039cb3587a80c48581ff03..b91a275ecb637bddb2d21e83686c3ba16717e110 100644 (file)
--- a/src/java/org/apache/fop/apps/Driver.java
+++ b/src/java/org/apache/fop/apps/Driver.java
@@ -52,22 +52,18 @@ package org.apache.fop.apps;
 
 // FOP
 import org.apache.fop.area.AreaTree;
-import org.apache.fop.area.AreaTreeModel;
 import org.apache.fop.control.Document;
 import org.apache.fop.fo.ElementMapping;
 import org.apache.fop.fo.FOTreeBuilder;
 import org.apache.fop.fo.FOUserAgent;
 import org.apache.fop.fo.FOInputHandler;
 import org.apache.fop.fo.FOTreeHandler;
-import org.apache.fop.area.Title;
-import org.apache.fop.fo.pagination.PageSequence;
 import org.apache.fop.mif.MIFHandler;
 import org.apache.fop.render.Renderer;
 import org.apache.fop.render.awt.AWTRenderer;
 import org.apache.fop.rtf.renderer.RTFHandler;
 import org.apache.fop.tools.DocumentInputSource;
 import org.apache.fop.tools.DocumentReader;
-import org.apache.fop.layout.LayoutStrategy;
 import org.apache.fop.layoutmgr.LayoutManagerLS;
 
 // Avalon

diff --git a/src/java/org/apache/fop/control/Document.java b/src/java/org/apache/fop/control/Document.java
index f30bde00d490e7fceec2ff42f513af6e10ede461..48c0c88deb898d0d94623176f7eb3d875c92e364 100644 (file)
--- a/src/java/org/apache/fop/control/Document.java
+++ b/src/java/org/apache/fop/control/Document.java
@@ -103,6 +103,7 @@ public class Document implements FOTreeControl, FOTreeListener {
 
     /**
      * Main constructor
+     * @param driver the Driver object that is the "parent" of this Document
      */
     public Document(Driver driver) {
         this.driver = driver;
@@ -303,6 +304,10 @@ public class Document implements FOTreeControl, FOTreeListener {
         return layoutStrategy;
     }
 
+    /**
+     * Public accessor for the parent Driver of this Document
+     * @return the parent Driver for this Document
+     */
     public Driver getDriver() {
         return driver;
     }

diff --git a/src/java/org/apache/fop/fo/pagination/PageSequence.java b/src/java/org/apache/fop/fo/pagination/PageSequence.java
index 6de86c7688cdc32644f2ab98d24efa789adb7408..240b02100cf7c95c246b78246fa111617c21e638 100644 (file)
--- a/src/java/org/apache/fop/fo/pagination/PageSequence.java
+++ b/src/java/org/apache/fop/fo/pagination/PageSequence.java
@@ -55,12 +55,9 @@ import org.apache.fop.fo.FONode;
 import org.apache.fop.fo.FObj;
 import org.apache.fop.fo.FOTreeVisitor;
 import org.apache.fop.layout.PageMaster;
-import org.apache.fop.area.AreaTree;
 import org.apache.fop.area.PageViewport;
 import org.apache.fop.apps.FOPException;
 
-import org.apache.fop.layoutmgr.PageLayoutManager;
-
 // Java
 import java.util.HashMap;
 
@@ -772,26 +769,53 @@ public class PageSequence extends FObj {
         return titleFO;
     }
 
+    /**
+     * Hook for Visitor objects accessing the FO Tree.
+     * @param fotv the FOTreeVisitor object accessing this node of the FO Tree
+     */
     public void acceptVisitor(FOTreeVisitor fotv) {
         fotv.serveVisitor(this);
     }
 
+    /**
+     * Public accessor for getting the MainFlow to which this PageSequence is
+     * attached.
+     * @return the MainFlow object to which this PageSequence is attached.
+     */
     public Flow getMainFlow() {
         return mainFlow;
     }
 
+    /**
+     * Public accessor for getting the PageSequenceMaster to which this
+     * PageSequence is attached.
+     * @return the PageSequenceMaster to which this PageSequence is attached.
+     */
     public PageSequenceMaster getPageSequenceMaster() {
         return pageSequenceMaster;
     }
 
+    /**
+     * Public accessor for getting the PageNumberGenerator.
+     * @return the PageNumberGenerator
+     */
     public PageNumberGenerator getPageNumberGenerator() {
         return pageNumberGenerator;
     }
 
+    /**
+     * Public accessor for setting the currentPageNumber.
+     * @param currentPageNumber the value to which currentPageNumber should be
+     * set.
+     */
     public void setCurrentPageNumber(int currentPageNumber) {
         this.currentPageNumber = currentPageNumber;
     }
 
+    /**
+     * Public accessor for the ancestor Root.
+     * @return the ancestor Root
+     */
     public Root getRoot() {
         return root;
     }

diff --git a/src/java/org/apache/fop/fo/pagination/Root.java b/src/java/org/apache/fop/fo/pagination/Root.java
index 415c3de4e80ee7ce58261e138a05be1348944c9e..fa3491ac44b14d21ebc1400067c4cf091b2d2793 100644 (file)
--- a/src/java/org/apache/fop/fo/pagination/Root.java
+++ b/src/java/org/apache/fop/fo/pagination/Root.java
@@ -163,6 +163,10 @@ public class Root extends FObj {
         return foTreeControl;
     }
 
+    /**
+     * Hook for Visitor objects accessing the FO Tree.
+     * @param fotv the FOTreeVisitor object accessing this node of the FO Tree
+     */
     public void acceptVisitor(FOTreeVisitor fotv) {
         fotv.serveVisitor(this);
     }

diff --git a/src/java/org/apache/fop/layout/LayoutStrategy.java b/src/java/org/apache/fop/layout/LayoutStrategy.java
index aa522a3a8fdf490593bdcb99a20f292bc7d4b5ff..39060917497c72d6d9bd7bbc84107c196fec4728 100644 (file)
--- a/src/java/org/apache/fop/layout/LayoutStrategy.java
+++ b/src/java/org/apache/fop/layout/LayoutStrategy.java
@@ -72,6 +72,12 @@ public abstract class LayoutStrategy {
         return name;
     }
 
+    /**
+     * Format a PageSequence into an AreaTree
+     * @param pageSeq the PageSequence to be formatted
+     * @param areaTree the AreaTree in which to place the formatted PageSequence
+     * @throws FOPException for errors during layout
+     */
     public abstract void format (PageSequence pageSeq, AreaTree areaTree)
             throws FOPException;
 }

diff --git a/src/java/org/apache/fop/layoutmgr/LayoutManagerLS.java b/src/java/org/apache/fop/layoutmgr/LayoutManagerLS.java
index 9b59bab88fbe829e6890d36f29446f2095e09b96..2ec3f8985051609d2c8d27b7413fbb6982b8d789 100644 (file)
--- a/src/java/org/apache/fop/layoutmgr/LayoutManagerLS.java
+++ b/src/java/org/apache/fop/layoutmgr/LayoutManagerLS.java
@@ -67,6 +67,7 @@ public class LayoutManagerLS extends LayoutStrategy {
     /**
      * Runs the formatting of this page sequence into the given area tree
      *
+     * @param pageSeq the PageSequence to be formatted
      * @param areaTree the area tree to format this page sequence into
      * @throws FOPException if there is an error formatting the contents
      */