From 6d4dd88c53c97d637f6bb3f338c53c5af5481d27 Mon Sep 17 00:00:00 2001
From: Joerg Pietschmann <pietsch@apache.org>
Date: Wed, 7 Sep 2005 22:20:36 +0000
Subject: Squashed CheckStyle warnings, mostly JavaDoc.

git-svn-id: https://svn.apache.org/repos/asf/xmlgraphics/fop/trunk@279439 13f79535-47bb-0310-9956-ffa450edef68
---
 src/java/org/apache/fop/area/Footnote.java | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)

(limited to 'src/java/org/apache/fop/area/Footnote.java')

diff --git a/src/java/org/apache/fop/area/Footnote.java b/src/java/org/apache/fop/area/Footnote.java
index 928b39cf5..735dfaf25 100644
--- a/src/java/org/apache/fop/area/Footnote.java
+++ b/src/java/org/apache/fop/area/Footnote.java
@@ -56,14 +56,29 @@ public class Footnote extends BlockParent {
         return separator;
     }
 
+    /**
+     * Set the relative position of the footnote inside the body region.
+     *
+     * @param top the relative position.
+     */
     public void setTop(int top) {
         this.top = top;
     }
 
+    /**
+     * Get the relative position of the footnote inside the body region.
+     *
+     * @return the relative position.
+     */
     public int getTop() {
         return top;
     }
 
+    /**
+     * Add a block area as child to the footnote area
+     *
+     * @param child the block area.
+     */
     public void addBlock(Block child) {
         if (children == null) {
             children = new ArrayList();
@@ -72,10 +87,20 @@ public class Footnote extends BlockParent {
         children.add(child);
     }
 
+    /**
+     * Get all child areas.
+     *
+     * @return the list of child areas. Maybe null.
+     */
     public List getChildAreas() {
         return children;
     }
 
+    /**
+     * Check whether there are child areas.
+     *
+     * @return the result.
+     */
     public boolean isEmpty() {
         return children == null || children.size() == 0;
     }
-- 
cgit v1.2.3