* Javadoc update: use {@inheritDoc} instead of @see where applicable, removal of some @author tags

* Additional code cleanup: removal of unused imports (mainly in the fo.flow package)



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

18 files changed, 31 insertions, 31 deletions

diff --git a/src/java/org/apache/fop/area/Area.java b/src/java/org/apache/fop/area/Area.java
index d9257e2cd..73b167b99 100644
--- a/src/java/org/apache/fop/area/Area.java
+++ b/src/java/org/apache/fop/area/Area.java
@@ -457,7 +457,7 @@ public class Area extends AreaTreeObject implements Serializable {
     }
     
     /**
-     * @see java.lang.Object#toString()
+     * {@inheritDoc}
      * @return ipd and bpd of area 
      * */
     public String toString() {
diff --git a/src/java/org/apache/fop/area/AreaTreeHandler.java b/src/java/org/apache/fop/area/AreaTreeHandler.java
index 6903510d0..be06aabfc 100644
--- a/src/java/org/apache/fop/area/AreaTreeHandler.java
+++ b/src/java/org/apache/fop/area/AreaTreeHandler.java
@@ -189,7 +189,7 @@ public class AreaTreeHandler extends FOEventHandler {
     }
 
     /**
-     * @see org.apache.fop.fo.FOEventHandler
+     * {@inheritDoc}
      * @param pageSequence
      *            is the pageSequence being started
      */
diff --git a/src/java/org/apache/fop/area/AreaTreeParser.java b/src/java/org/apache/fop/area/AreaTreeParser.java
index ba819621e..aa499338b 100644
--- a/src/java/org/apache/fop/area/AreaTreeParser.java
+++ b/src/java/org/apache/fop/area/AreaTreeParser.java
@@ -224,7 +224,7 @@ public class AreaTreeParser {
             return (Viewport)findAreaType(Viewport.class);
         }
 
-        /** @see org.xml.sax.helpers.DefaultHandler */
+        /** {@inheritDoc} */
         public void startElement(String uri, String localName, String qName, Attributes attributes)
                     throws SAXException {
             if (delegate != null) {
@@ -288,7 +288,7 @@ public class AreaTreeParser {
             }
         }
 
-        /** @see org.xml.sax.helpers.DefaultHandler */
+        /** {@inheritDoc} */
         public void endElement(String uri, String localName, String qName) throws SAXException {
             if (delegate != null) {
                 delegate.endElement(uri, localName, qName);
@@ -1131,7 +1131,7 @@ public class AreaTreeParser {
             }
         }
         
-        /** @see org.xml.sax.ContentHandler#characters(char[], int, int) */
+        /** {@inheritDoc} */
         public void characters(char[] ch, int start, int length) throws SAXException {
             if (delegate != null) {
                 delegate.characters(ch, start, length);
diff --git a/src/java/org/apache/fop/area/BeforeFloat.java b/src/java/org/apache/fop/area/BeforeFloat.java
index 23883f133..9fc048af1 100644
--- a/src/java/org/apache/fop/area/BeforeFloat.java
+++ b/src/java/org/apache/fop/area/BeforeFloat.java
@@ -62,7 +62,7 @@ public class BeforeFloat extends BlockParent {
         return h;
     }
 
-    /** @see org.apache.fop.area.BlockParent#isEmpty() */
+    /** {@inheritDoc} */
     public boolean isEmpty() {
         return true; // before floats are not yet implemented
     }
diff --git a/src/java/org/apache/fop/area/BlockParent.java b/src/java/org/apache/fop/area/BlockParent.java
index 626b18ae5..caca5befc 100644
--- a/src/java/org/apache/fop/area/BlockParent.java
+++ b/src/java/org/apache/fop/area/BlockParent.java
@@ -53,7 +53,7 @@ public class BlockParent extends Area {
     // orientation if reference area
     private int orientation = ORIENT_0;
 
-    /** @see org.apache.fop.area.Area#addChildArea(org.apache.fop.area.Area) */
+    /** {@inheritDoc} */
     public void addChildArea(Area childArea) {
         if (children == null) {
             children = new ArrayList();
diff --git a/src/java/org/apache/fop/area/BookmarkData.java b/src/java/org/apache/fop/area/BookmarkData.java
index 2ad8273a9..30bd704b1 100644
--- a/src/java/org/apache/fop/area/BookmarkData.java
+++ b/src/java/org/apache/fop/area/BookmarkData.java
@@ -194,7 +194,7 @@ public class BookmarkData extends AbstractOffDocumentItem implements Resolvable
     }
 
     /**
-     * @see org.apache.fop.area.Resolvable#getIDRefs()
+     * {@inheritDoc}
      */
     public String[] getIDRefs() {
         return (String[])unresolvedIDRefs.keySet().toArray(new String[] {});
@@ -206,7 +206,7 @@ public class BookmarkData extends AbstractOffDocumentItem implements Resolvable
      * resolves id references of child elements that have the same
      * id reference.
      *
-     * @see org.apache.fop.area.Resolvable#resolveIDRef(String, List)
+     * {@inheritDoc} List)
      * @todo check to make sure it works if multiple bookmark-items
      * have the same idref
      */
@@ -225,7 +225,7 @@ public class BookmarkData extends AbstractOffDocumentItem implements Resolvable
     }
 
     /**
-     * @see org.apache.fop.area.OffDocumentItem#getName()
+     * {@inheritDoc}
      */
     public String getName() {
         return "Bookmarks";
diff --git a/src/java/org/apache/fop/area/CachedRenderPagesModel.java b/src/java/org/apache/fop/area/CachedRenderPagesModel.java
index 4d4237078..363fa02d1 100644
--- a/src/java/org/apache/fop/area/CachedRenderPagesModel.java
+++ b/src/java/org/apache/fop/area/CachedRenderPagesModel.java
@@ -65,7 +65,7 @@ public class CachedRenderPagesModel extends RenderPagesModel {
     }
 
     /**
-     * @see org.apache.fop.area.RenderPagesModel#checkPreparedPages(PageViewport, boolean)
+     * {@inheritDoc} 
      */
     protected boolean checkPreparedPages(PageViewport newpage, boolean renderUnresolved) {
         for (Iterator iter = prepared.iterator(); iter.hasNext();) {
@@ -152,7 +152,7 @@ public class CachedRenderPagesModel extends RenderPagesModel {
         }
     }
 
-    /** @see org.apache.fop.area.RenderPagesModel#endDocument() */
+    /** {@inheritDoc} */
     public void endDocument() throws SAXException {
         super.endDocument();
     }
diff --git a/src/java/org/apache/fop/area/DestinationData.java b/src/java/org/apache/fop/area/DestinationData.java
index 6b873ef84..b23605972 100644
--- a/src/java/org/apache/fop/area/DestinationData.java
+++ b/src/java/org/apache/fop/area/DestinationData.java
@@ -60,7 +60,7 @@ public class DestinationData extends AbstractOffDocumentItem implements Resolvab
     }
 
     /**
-     * @see org.apache.fop.area.Resolvable#getIDRefs()
+     * {@inheritDoc}
      */
     public String[] getIDRefs() {
         return idRefs;
@@ -90,7 +90,7 @@ public class DestinationData extends AbstractOffDocumentItem implements Resolvab
      * Resolves the idref of this object by getting the PageViewport
      * object that corresponds to the IDRef
      *
-     * @see org.apache.fop.area.Resolvable#resolveIDRef(String, List)
+     * {@inheritDoc} List)
      * @todo check to make sure it works if multiple bookmark-items
      * have the same idref
      */
@@ -100,7 +100,7 @@ public class DestinationData extends AbstractOffDocumentItem implements Resolvab
     }
 
     /**
-     * @see org.apache.fop.area.OffDocumentItem#getName()
+     * {@inheritDoc}
      */
     public String getName() {
         return "Destination";
diff --git a/src/java/org/apache/fop/area/LinkResolver.java b/src/java/org/apache/fop/area/LinkResolver.java
index 0b0441bd2..0fdd4ba4c 100644
--- a/src/java/org/apache/fop/area/LinkResolver.java
+++ b/src/java/org/apache/fop/area/LinkResolver.java
@@ -67,7 +67,7 @@ public class LinkResolver implements Resolvable, Serializable {
     /**
      * Resolve by adding an internal link to the first PageViewport in the list.
      *
-     * @see org.apache.fop.area.Resolvable#resolveIDRef(String, List)
+     * {@inheritDoc} 
      */
     public void resolveIDRef(String id, List pages) {
         resolveIDRef(id, (PageViewport)pages.get(0));
diff --git a/src/java/org/apache/fop/area/NormalFlow.java b/src/java/org/apache/fop/area/NormalFlow.java
index e927122c9..715a61cb0 100644
--- a/src/java/org/apache/fop/area/NormalFlow.java
+++ b/src/java/org/apache/fop/area/NormalFlow.java
@@ -34,7 +34,7 @@ public class NormalFlow extends BlockParent {
         setIPD(ipd);
     }
     
-    /** @see org.apache.fop.area.BlockParent#addBlock(org.apache.fop.area.Block) */
+    /** {@inheritDoc} */
     public void addBlock(Block block) {
         super.addBlock(block);
         bpd += block.getAllocBPD();
diff --git a/src/java/org/apache/fop/area/OffDocumentExtensionAttachment.java b/src/java/org/apache/fop/area/OffDocumentExtensionAttachment.java
index cd75e203b..7fd811d45 100644
--- a/src/java/org/apache/fop/area/OffDocumentExtensionAttachment.java
+++ b/src/java/org/apache/fop/area/OffDocumentExtensionAttachment.java
@@ -43,12 +43,12 @@ public class OffDocumentExtensionAttachment implements OffDocumentItem {
         return this.attachment;
     }
 
-    /** @see org.apache.fop.area.OffDocumentItem#getWhenToProcess() */
+    /** {@inheritDoc} */
     public int getWhenToProcess() {
         return OffDocumentItem.IMMEDIATELY;
     }
 
-    /** @see org.apache.fop.area.OffDocumentItem#getName() */
+    /** {@inheritDoc} */
     public String getName() {
         return attachment.getCategory();
     }
diff --git a/src/java/org/apache/fop/area/PageViewport.java b/src/java/org/apache/fop/area/PageViewport.java
index 953cb3840..184eb9d32 100644
--- a/src/java/org/apache/fop/area/PageViewport.java
+++ b/src/java/org/apache/fop/area/PageViewport.java
@@ -304,7 +304,7 @@ public class PageViewport extends AreaTreeObject implements Resolvable, Cloneabl
     }
 
     /**
-     * @see org.apache.fop.area.Resolvable#resolveIDRef(String, List)
+     * {@inheritDoc} 
      */
     public void resolveIDRef(String id, List pages) {
         if (page == null) {
@@ -565,7 +565,7 @@ public class PageViewport extends AreaTreeObject implements Resolvable, Cloneabl
     }
 
     /**
-     * @see java.lang.Object#toString()
+     * {@inheritDoc}
      */
     public String toString() {
         StringBuffer sb = new StringBuffer(64);
diff --git a/src/java/org/apache/fop/area/RegionReference.java b/src/java/org/apache/fop/area/RegionReference.java
index 00b51263d..c41de7c7a 100644
--- a/src/java/org/apache/fop/area/RegionReference.java
+++ b/src/java/org/apache/fop/area/RegionReference.java
@@ -68,7 +68,7 @@ public class RegionReference extends Area implements Cloneable {
         regionViewport = parent;
     }
 
-    /** @see org.apache.fop.area.Area#addChildArea(org.apache.fop.area.Area) */
+    /** {@inheritDoc} */
     public void addChildArea(Area child) {
         blocks.add(child);
     }
diff --git a/src/java/org/apache/fop/area/RenderPagesModel.java b/src/java/org/apache/fop/area/RenderPagesModel.java
index b8dc28a6f..81ffac746 100644
--- a/src/java/org/apache/fop/area/RenderPagesModel.java
+++ b/src/java/org/apache/fop/area/RenderPagesModel.java
@@ -204,7 +204,7 @@ public class RenderPagesModel extends AreaTreeModel {
     }
 
     /**
-     * @see org.apache.fop.area.AreaTreeModel#handleOffDocumentItem(OffDocumentItem)
+     * {@inheritDoc}
      */
     public void handleOffDocumentItem(OffDocumentItem oDI) {
         switch(oDI.getWhenToProcess()) {
@@ -231,7 +231,7 @@ public class RenderPagesModel extends AreaTreeModel {
 
     /**
      * End the document. Render any end document OffDocumentItems
-     * @see org.apache.fop.area.AreaTreeModel#endDocument()
+     * {@inheritDoc}
      */
     public void endDocument() throws SAXException {
         // render any pages that had unresolved ids
diff --git a/src/java/org/apache/fop/area/Span.java b/src/java/org/apache/fop/area/Span.java
index 401adda64..cf9dd3c42 100644
--- a/src/java/org/apache/fop/area/Span.java
+++ b/src/java/org/apache/fop/area/Span.java
@@ -180,7 +180,7 @@ public class Span extends Area {
         return (areaCount == 0);
     }
     
-    /** @see java.lang.Object#toString() */
+    /** {@inheritDoc} */
     public String toString() {
         StringBuffer sb = new StringBuffer(super.toString());
         if (colCount > 1) {
diff --git a/src/java/org/apache/fop/area/Trait.java b/src/java/org/apache/fop/area/Trait.java
index fb7065e77..b3c3d3947 100644
--- a/src/java/org/apache/fop/area/Trait.java
+++ b/src/java/org/apache/fop/area/Trait.java
@@ -365,7 +365,7 @@ public class Trait implements Serializable {
 
     /**
      * Return the string for debugging.
-     * @see java.lang.Object#toString()
+     * {@inheritDoc}
      */
     public String toString() {
         return data.toString();
@@ -536,7 +536,7 @@ public class Trait implements Serializable {
 
         /**
          * Return the human-friendly string for debugging.
-         * @see java.lang.Object#toString()
+         * {@inheritDoc}
          */
         public String toString() {
             StringBuffer sb = new StringBuffer();
@@ -700,7 +700,7 @@ public class Trait implements Serializable {
         
         /**
          * Return the string for debugging.
-         * @see java.lang.Object#toString()
+         * {@inheritDoc}
          */
         public String toString() {
             StringBuffer sb = new StringBuffer();
diff --git a/src/java/org/apache/fop/area/inline/FilledArea.java b/src/java/org/apache/fop/area/inline/FilledArea.java
index a111e7f89..02d9b4820 100644
--- a/src/java/org/apache/fop/area/inline/FilledArea.java
+++ b/src/java/org/apache/fop/area/inline/FilledArea.java
@@ -86,7 +86,7 @@ public class FilledArea extends InlineParent {
     }
 
     /**
-     * @see org.apache.fop.area.Area#getBPD
+     * {@inheritDoc}
      */
     public int getBPD() {
         int bpd = 0;
diff --git a/src/java/org/apache/fop/area/inline/InlineArea.java b/src/java/org/apache/fop/area/inline/InlineArea.java
index d4f834441..0655cabe4 100644
--- a/src/java/org/apache/fop/area/inline/InlineArea.java
+++ b/src/java/org/apache/fop/area/inline/InlineArea.java
@@ -104,7 +104,7 @@ public class InlineArea extends Area {
      * Create a new adjustment information object
      * @param stretch the available space for stretching
      * @param shrink the available space for shrinking
-     * @param adj space adjustment type
+     * @param adjustment space adjustment type
      */
     public void setAdjustingInfo(int stretch, int shrink, int adjustment) {
         adjustingInfo = new InlineAdjustingInfo(stretch, shrink, adjustment);
@@ -169,7 +169,7 @@ public class InlineArea extends Area {
     /**
      * Set the parent for the child area.
      *
-     * @see org.apache.fop.area.Area#addChildArea(Area)
+     * {@inheritDoc}
      */
     public void addChildArea(Area childArea) {
         super.addChildArea(childArea);