svn commit: r655775 - /xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/FOEventHandler.java

[adelmelle]

Author: adelmelle
Date: Tue May 13 01:20:57 2008
New Revision: 655775

URL: http://svn.apache.org/viewvc?rev=655775&view=rev
Log:
Javadoc fixups

Modified:
    xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/FOEventHandler.java

Modified: xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/FOEventHandler.java
URL: 
http://svn.apache.org/viewvc/xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/FOEventHandler.java?rev=655775&r1=655774&r2=655775&view=diff
==============================================================================
--- xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/FOEventHandler.java 
(original)
+++ xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/FOEventHandler.java Tue 
May 13 01:20:57 2008
@@ -79,7 +79,11 @@
      * This is used so we know if the FO tree contains duplicates.
      */
     private Set idReferences = new HashSet();
-
+    /**
+     * Keeps track of the last automatically generated id in the current 
document
+     */
+    private long lastGeneratedId = 1;
+    
     /**
      * The property list maker.
      */
@@ -96,11 +100,6 @@
     private boolean inMarker = false;
     
     /**
-     * Keeps track of automatically generated ids in the current document
-     */
-    private long lastGeneratedId = 1;
-    
-    /**
      * Main constructor
      * @param foUserAgent the apps.FOUserAgent instance for this process
      */
@@ -136,13 +135,17 @@
 
     /**
      * Return the propertyListMaker.
-    */
+     * 
+     * @return the currently active [EMAIL PROTECTED] PropertyListMaker}
+     */
     public PropertyListMaker getPropertyListMaker() {
         return propertyListMaker;
     }
      
     /**
      * Set a new propertyListMaker.
+     * 
+     * @param propertyListMaker the new [EMAIL PROTECTED] PropertyListMaker} 
to use
      */
     public void setPropertyListMaker(PropertyListMaker propertyListMaker) {
         this.propertyListMaker = propertyListMaker;
@@ -160,6 +163,9 @@
      * Switch to or from marker context
      * (used by FOTreeBuilder when processing
      *  a marker)
+     * 
+     * @param inMarker  true if a marker is being processed; 
+     *                  false otherwise
      *
      */
     protected void switchMarkerContext(boolean inMarker) {
@@ -168,6 +174,8 @@
     
     /**
      * Check whether in marker context
+     * 
+     * @return true if a marker is being processed
      */
     protected boolean inMarker() {
         return this.inMarker;
@@ -175,6 +183,8 @@
     
     /**
      * Return the next value for automatically generated ids
+     * 
+     * @return the next value to append to automatically generated ids
      */
     public long getNextId() {
         return this.lastGeneratedId++;



---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]