From 444d5d38ea5914629b9c7d3f27ff39c1f1db9b7f Mon Sep 17 00:00:00 2001
From: Chris Bowditch <cbowditch@apache.org>
Date: Tue, 22 Aug 2006 15:49:26 +0000
Subject: [PATCH] corrected a couple of javadoc warnings issued by checkstyle

git-svn-id: https://svn.apache.org/repos/asf/xmlgraphics/fop/trunk@433679 13f79535-47bb-0310-9956-ffa450edef68
---
 src/java/org/apache/fop/apps/FOUserAgent.java     | 3 ++-
 src/java/org/apache/fop/area/Area.java            | 5 ++++-
 src/java/org/apache/fop/area/AreaTreeHandler.java | 5 ++++-
 src/java/org/apache/fop/area/AreaTreeModel.java   | 2 +-
 4 files changed, 11 insertions(+), 4 deletions(-)

diff --git a/src/java/org/apache/fop/apps/FOUserAgent.java b/src/java/org/apache/fop/apps/FOUserAgent.java
index 2f4b730b7..63a3859ac 100644
--- a/src/java/org/apache/fop/apps/FOUserAgent.java
+++ b/src/java/org/apache/fop/apps/FOUserAgent.java
@@ -280,7 +280,8 @@ public class FOUserAgent {
     }
 
     /**
-     * Configures the FOUserAgent through the factory's configuration. 
+     * Configures the FOUserAgent through the factory's configuration.
+     * @param cfg Avalon Configuration Object
      * @see org.apache.avalon.framework.configuration.Configurable
      */
     protected void configure(Configuration cfg) {
diff --git a/src/java/org/apache/fop/area/Area.java b/src/java/org/apache/fop/area/Area.java
index 0fc11960e..d9257e2cd 100644
--- a/src/java/org/apache/fop/area/Area.java
+++ b/src/java/org/apache/fop/area/Area.java
@@ -456,7 +456,10 @@ public class Area extends AreaTreeObject implements Serializable {
         }
     }
     
-    /** @see java.lang.Object#toString() */
+    /**
+     * @see java.lang.Object#toString()
+     * @return ipd and bpd of area 
+     * */
     public String toString() {
         StringBuffer sb = new StringBuffer(super.toString());
         sb.append(" {ipd=").append(Integer.toString(getIPD()));
diff --git a/src/java/org/apache/fop/area/AreaTreeHandler.java b/src/java/org/apache/fop/area/AreaTreeHandler.java
index 2215fc05e..91a5d603d 100644
--- a/src/java/org/apache/fop/area/AreaTreeHandler.java
+++ b/src/java/org/apache/fop/area/AreaTreeHandler.java
@@ -339,7 +339,10 @@ public class AreaTreeHandler extends FOEventHandler {
         }
     }
 
-    /** @see org.apache.fop.fo.FOEventHandler */
+    /**
+     * @see org.apache.fop.fo.FOEventHandler
+     * @param pageSequence is the pageSequence being started 
+     * */
     public void startPageSequence(PageSequence pageSequence) {
         rootFObj = pageSequence.getRoot();
         finishPrevPageSequence(pageSequence.getInitialPageNumber());
diff --git a/src/java/org/apache/fop/area/AreaTreeModel.java b/src/java/org/apache/fop/area/AreaTreeModel.java
index c91364cbb..bdbb88f2a 100644
--- a/src/java/org/apache/fop/area/AreaTreeModel.java
+++ b/src/java/org/apache/fop/area/AreaTreeModel.java
@@ -43,7 +43,7 @@ public class AreaTreeModel {
     /** the current page sequence */
     protected PageSequence currentPageSequence;
     private List offDocumentItems = new java.util.ArrayList();
-
+    /** logger instance */
     protected static Log log = LogFactory.getLog(AreaTreeModel.class);
 
     /**
-- 
2.39.5