* 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

22 files changed, 49 insertions, 58 deletions

diff --git a/src/java/org/apache/fop/image/AbstractFopImage.java b/src/java/org/apache/fop/image/AbstractFopImage.java
index 97f176712..8d5180149 100644
--- a/src/java/org/apache/fop/image/AbstractFopImage.java
+++ b/src/java/org/apache/fop/image/AbstractFopImage.java
@@ -33,8 +33,7 @@ import org.apache.fop.datatypes.Length;
 
 /**
  * Base class to implement the FopImage interface.
- * @author Eric SCHAEFFER
- * @author Modified by Eric Dalquist - 9/14/2001 - ebdalqui@mtu.edu
+ * 
  * @see FopImage
  */
 public abstract class AbstractFopImage implements FopImage {
@@ -141,7 +140,7 @@ public abstract class AbstractFopImage implements FopImage {
         return imageInfo.mimeType;
     }
 
-    /** @see org.apache.fop.image.FopImage#getOriginalURI() */
+    /** {@inheritDoc} */
     public String getOriginalURI() {
         return this.imageInfo.originalURI;
     }
@@ -249,27 +248,27 @@ public abstract class AbstractFopImage implements FopImage {
         return this.height;
     }
 
-    /** @see org.apache.fop.image.FopImage#getIntrinsicWidth() */
+    /** {@inheritDoc} */
     public int getIntrinsicWidth() {
         return (int)(getWidth() * 72000 / getHorizontalResolution());
     }
 
-    /** @see org.apache.fop.image.FopImage#getIntrinsicHeight() */
+    /** {@inheritDoc} */
     public int getIntrinsicHeight() {
         return (int)(getHeight() * 72000 / getVerticalResolution());
     }
     
-    /** @see org.apache.fop.image.FopImage#getIntrinsicAlignmentAdjust() */
+    /** {@inheritDoc} */
     public Length getIntrinsicAlignmentAdjust() {
         return this.imageInfo.alignmentAdjust;
     }
 
-    /** @see org.apache.fop.image.FopImage#getHorizontalResolution() */
+    /** {@inheritDoc} */
     public double getHorizontalResolution() {
         return this.dpiHorizontal;
     }
     
-    /** @see org.apache.fop.image.FopImage#getVerticalResolution() */
+    /** {@inheritDoc} */
     public double getVerticalResolution() {
         return this.dpiVertical;
     }
diff --git a/src/java/org/apache/fop/image/BmpImage.java b/src/java/org/apache/fop/image/BmpImage.java
index 506137bbb..5ebf522e9 100644
--- a/src/java/org/apache/fop/image/BmpImage.java
+++ b/src/java/org/apache/fop/image/BmpImage.java
@@ -29,7 +29,6 @@ import org.apache.commons.io.IOUtils;
  * Bitmap image.
  * This supports loading a bitmap image into bitmap data.
  *
- * @author Art WELCH
  * @see AbstractFopImage
  * @see FopImage
  */
diff --git a/src/java/org/apache/fop/image/EmfImage.java b/src/java/org/apache/fop/image/EmfImage.java
index 4e19b326d..1221b9b2b 100644
--- a/src/java/org/apache/fop/image/EmfImage.java
+++ b/src/java/org/apache/fop/image/EmfImage.java
@@ -19,13 +19,10 @@
 

 package org.apache.fop.image;

 

-import org.apache.commons.io.IOUtils;

-

 /**

  * Enhanced metafile image.

  * This supports loading a EMF image.

  *

- * @author Peter Herweg

  * @see AbstractFopImage

  * @see FopImage

  */

diff --git a/src/java/org/apache/fop/image/FopImage.java b/src/java/org/apache/fop/image/FopImage.java
index 30f3c8258..0f780ad57 100644
--- a/src/java/org/apache/fop/image/FopImage.java
+++ b/src/java/org/apache/fop/image/FopImage.java
@@ -28,8 +28,6 @@ import org.apache.fop.datatypes.Length;
 
 /**
  * Fop image interface for loading images.
- *
- * @author Eric SCHAEFFER
  */
 public interface FopImage {
     /**
diff --git a/src/java/org/apache/fop/image/FopImageConsumer.java b/src/java/org/apache/fop/image/FopImageConsumer.java
index 37f2a29a2..4e4d7be48 100644
--- a/src/java/org/apache/fop/image/FopImageConsumer.java
+++ b/src/java/org/apache/fop/image/FopImageConsumer.java
@@ -28,7 +28,6 @@ import java.awt.image.PixelGrabber;
 
 /**
  * ImageConsumer implementation for FopImage classes.
- * @author Eric SCHAEFFER
  */
 public class FopImageConsumer implements ImageConsumer {
     
@@ -56,7 +55,7 @@ public class FopImageConsumer implements ImageConsumer {
     }
 
     /**
-     * @see java.awt.image.ImageConsumer#imageComplete(int)
+     * {@inheritDoc}
      */
     public void imageComplete(int status) {
         /*
@@ -91,7 +90,7 @@ public class FopImageConsumer implements ImageConsumer {
     }
 
     /**
-     * @see java.awt.image.ImageConsumer#setColorModel(ColorModel)
+     * {@inheritDoc}
      */
     public void setColorModel(ColorModel model) {
         // log.error("setColorModel: " + model);
@@ -99,7 +98,7 @@ public class FopImageConsumer implements ImageConsumer {
     }
 
     /**
-     * @see java.awt.image.ImageConsumer#setDimensions(int, int)
+     * {@inheritDoc} 
      */
     public void setDimensions(int width, int height) {
         // log.error("setDimension: w=" + width + " h=" + height);
@@ -108,7 +107,7 @@ public class FopImageConsumer implements ImageConsumer {
     }
 
     /**
-     * @see java.awt.image.ImageConsumer#setHints(int)
+     * {@inheritDoc}
      */
     public void setHints(int hintflags) {
         // log.error("setHints: " + hintflags);
@@ -116,7 +115,7 @@ public class FopImageConsumer implements ImageConsumer {
     }
 
     /**
-     * @see java.awt.image.ImageConsumer#setProperties(Hashtable)
+     * {@inheritDoc}
      */
     public void setProperties(Hashtable props) {
         // log.error("setProperties: " + props);
@@ -124,14 +123,14 @@ public class FopImageConsumer implements ImageConsumer {
     }
 
     /**
-     * @see java.awt.image.ImageConsumer#setPixels(int, int, int, int, ColorModel, byte[], int, int)
+     * {@inheritDoc} 
      */
     public void setPixels(int x, int y, int w, int h, ColorModel model,
                           byte[] pixels, int off, int scansize) {
     }
 
     /**
-     * @see java.awt.image.ImageConsumer#setPixels(int, int, int, int, ColorModel, int[], int, int)
+     * {@inheritDoc} 
      */
     public void setPixels(int x, int y, int w, int h, ColorModel model,
                           int[] pixels, int off, int scansize) {
diff --git a/src/java/org/apache/fop/image/GifImage.java b/src/java/org/apache/fop/image/GifImage.java
index 40c5ab330..27e81c4fc 100644
--- a/src/java/org/apache/fop/image/GifImage.java
+++ b/src/java/org/apache/fop/image/GifImage.java
@@ -33,8 +33,7 @@ import org.apache.commons.io.IOUtils;
 
 /**
  * FopImage object for GIF images, using Java native classes.
- * @author Eric SCHAEFFER
- * @author Modified by Eric Dalquist - 9/14/2001 - ebdalqui@mtu.edu
+ * 
  * @see AbstractFopImage
  * @see FopImage
  */
@@ -166,7 +165,7 @@ public class GifImage extends AbstractFopImage {
         return true;
     }
 
-    /** @see org.apache.fop.image.AbstractFopImage#loadOriginalData() */
+    /** {@inheritDoc} */
     protected boolean loadOriginalData() {
         return loadDefaultOriginalData();
     }
@@ -183,28 +182,28 @@ public class GifImage extends AbstractFopImage {
         }
 
         /**
-         * @see java.net.URLConnection#getInputStream()
+         * {@inheritDoc}
          */
         public InputStream getInputStream() throws IOException {
             return inputStream;
         }
 
         /**
-         * @see java.net.URLConnection#connect()
+         * {@inheritDoc}
          */
         public void connect() throws IOException {
             // do nothing
         }
 
         /**
-         * @see java.net.URLConnection#getContentType()
+         * {@inheritDoc}
          */
         public String getContentType() {
             return "image/gif";
         }
 
         /**
-         * @see java.net.URLConnection#getContentLength()
+         * {@inheritDoc}
          */
         public int getContentLength() {
             try {
diff --git a/src/java/org/apache/fop/image/ImageFactory.java b/src/java/org/apache/fop/image/ImageFactory.java
index 7d7a92120..ee5b1ae75 100644
--- a/src/java/org/apache/fop/image/ImageFactory.java
+++ b/src/java/org/apache/fop/image/ImageFactory.java
@@ -339,7 +339,7 @@ class BasicImageCache implements ImageCache {
         // do nothing
     }
 
-    /** @see org.apache.fop.image.ImageCache#clearAll() */
+    /** {@inheritDoc} */
     public void clearAll() {
         invalid.clear();
     }
@@ -549,7 +549,7 @@ class ContextImageCache implements ImageCache {
 
     }
 
-    /** @see org.apache.fop.image.ImageCache#clearAll() */
+    /** {@inheritDoc} */
     public void clearAll() {
         this.refStore.clear();
         this.invalid.clear();
diff --git a/src/java/org/apache/fop/image/JAIImage.java b/src/java/org/apache/fop/image/JAIImage.java
index d63642dbe..8b3074052 100644
--- a/src/java/org/apache/fop/image/JAIImage.java
+++ b/src/java/org/apache/fop/image/JAIImage.java
@@ -35,7 +35,7 @@ import com.sun.media.jai.codec.FileCacheSeekableStream;
 
 /**
  * FopImage object using JAI.
- * @author Eric SCHAEFFER
+ * 
  * @see AbstractFopImage
  * @see FopImage
  */
@@ -51,7 +51,7 @@ public class JAIImage extends AbstractFopImage {
     }
 
     /**
-     * @see org.apache.fop.image.AbstractFopImage#loadDimensions()
+     * {@inheritDoc}
      */
     protected boolean loadDimensions() {
         if (this.bitmaps == null) {
@@ -61,7 +61,7 @@ public class JAIImage extends AbstractFopImage {
     }
     
     /**
-     * @see org.apache.fop.image.AbstractFopImage#loadBitmap()
+     * {@inheritDoc}
      */
     protected boolean loadBitmap() {
         if (this.bitmaps == null) {
@@ -185,7 +185,7 @@ public class JAIImage extends AbstractFopImage {
         }
     }
 
-    /** @see org.apache.fop.image.AbstractFopImage#loadOriginalData() */
+    /** {@inheritDoc} */
     protected boolean loadOriginalData() {
         return loadDefaultOriginalData();
     }
diff --git a/src/java/org/apache/fop/image/JimiImage.java b/src/java/org/apache/fop/image/JimiImage.java
index cef32dce0..49fb0b2e0 100644
--- a/src/java/org/apache/fop/image/JimiImage.java
+++ b/src/java/org/apache/fop/image/JimiImage.java
@@ -34,7 +34,7 @@ import com.sun.jimi.core.Jimi;
 /**
  * FopImage object for several images types, using Jimi.
  * See Jimi documentation for supported image types.
- * @author Eric SCHAEFFER
+ * 
  * @see AbstractFopImage
  * @see FopImage
  */
@@ -50,7 +50,7 @@ public class JimiImage extends AbstractFopImage {
     }
 
     /**
-     * @see org.apache.fop.image.AbstractFopImage#loadDimensions()
+     * {@inheritDoc}
      */
     protected boolean loadDimensions() {
         if (this.bitmaps == null) {
@@ -61,7 +61,7 @@ public class JimiImage extends AbstractFopImage {
     }
 
     /**
-     * @see org.apache.fop.image.AbstractFopImage#loadBitmap()
+     * {@inheritDoc}
      */
     protected boolean loadBitmap() {
         if (this.bitmaps == null) {
@@ -177,7 +177,7 @@ public class JimiImage extends AbstractFopImage {
         }
     }
 
-    /** @see org.apache.fop.image.AbstractFopImage#loadOriginalData() */
+    /** {@inheritDoc} */
     protected boolean loadOriginalData() {
         return loadDefaultOriginalData();
     }
diff --git a/src/java/org/apache/fop/image/JpegImage.java b/src/java/org/apache/fop/image/JpegImage.java
index 3ad745281..658d48286 100644
--- a/src/java/org/apache/fop/image/JpegImage.java
+++ b/src/java/org/apache/fop/image/JpegImage.java
@@ -30,7 +30,7 @@ import org.apache.fop.util.CMYKColorSpace;
 
 /**
  * FopImage object for JPEG images, Using Java native classes.
- * @author Eric Dalquist
+ * 
  * @see AbstractFopImage
  * @see FopImage
  */
diff --git a/src/java/org/apache/fop/image/PNGImage.java b/src/java/org/apache/fop/image/PNGImage.java
index 451cf6abf..c83d491f0 100644
--- a/src/java/org/apache/fop/image/PNGImage.java
+++ b/src/java/org/apache/fop/image/PNGImage.java
@@ -29,7 +29,7 @@ import org.apache.commons.io.IOUtils;
 
 /**
  * FopImage object using PNG
- * @author Eric SCHAEFFER
+ * 
  * @see AbstractFopImage
  * @see FopImage
  */
@@ -45,8 +45,7 @@ public class PNGImage extends XmlGraphicsCommonsImage {
     }
 
     /**
-     * @see org.apache.fop.image.XmlGraphicsCommonsImage#decodeImage(
-     *          org.apache.xmlgraphics.image.codec.util.SeekableStream)
+     * {@inheritDoc}
      */
     protected CachableRed decodeImage(SeekableStream stream) throws IOException {
         PNGDecodeParam param = new PNGDecodeParam();
diff --git a/src/java/org/apache/fop/image/TIFFImage.java b/src/java/org/apache/fop/image/TIFFImage.java
index 841bd2304..d9a9fc022 100644
--- a/src/java/org/apache/fop/image/TIFFImage.java
+++ b/src/java/org/apache/fop/image/TIFFImage.java
@@ -65,7 +65,7 @@ public class TIFFImage extends XmlGraphicsCommonsImage {
     }
 
     /**
-     * @see org.apache.fop.image.XmlGraphicsCommonsImage#decodeImage(
+     * {@inheritDoc}
      *          org.apache.xmlgraphics.image.codec.util.SeekableStream)
      */
     protected CachableRed decodeImage(SeekableStream stream) throws IOException {
@@ -128,7 +128,7 @@ public class TIFFImage extends XmlGraphicsCommonsImage {
      * This loads only strip 1 of the original TIFF data.
      *
      * @return true if loaded false for any error
-     * @see org.apache.fop.image.AbstractFopImage#loadOriginalData()
+     * {@inheritDoc}
      */
     protected boolean loadOriginalData() {
         if (loadDimensions()) {
diff --git a/src/java/org/apache/fop/image/XmlGraphicsCommonsImage.java b/src/java/org/apache/fop/image/XmlGraphicsCommonsImage.java
index 7bcd2a997..662673726 100644
--- a/src/java/org/apache/fop/image/XmlGraphicsCommonsImage.java
+++ b/src/java/org/apache/fop/image/XmlGraphicsCommonsImage.java
@@ -38,6 +38,7 @@ import org.apache.commons.io.IOUtils;
 
 /**
  * Abstract FopImage implementation which uses the internal codecs from XML Graphics Commons.
+ * 
  * @see AbstractFopImage
  * @see FopImage
  */
@@ -64,7 +65,7 @@ public abstract class XmlGraphicsCommonsImage extends AbstractFopImage {
     }
 
     /**
-     * @see org.apache.fop.image.AbstractFopImage#loadDimensions()
+     * {@inheritDoc}
      */
     protected boolean loadDimensions() {
         if (seekableInput == null && inputStream != null) {
@@ -128,7 +129,7 @@ public abstract class XmlGraphicsCommonsImage extends AbstractFopImage {
     }
 
     /**
-     * @see org.apache.fop.image.AbstractFopImage#loadBitmap()
+     * {@inheritDoc}
      */
     protected boolean loadBitmap() {
         if (this.bitmaps == null) {
@@ -139,7 +140,7 @@ public abstract class XmlGraphicsCommonsImage extends AbstractFopImage {
     }
 
     /**
-     * @see org.apache.fop.image.FopImage#hasSoftMask()
+     * {@inheritDoc}
      */
     public boolean hasSoftMask() {
         if (this.bitmaps == null && this.raw == null) {
@@ -150,7 +151,7 @@ public abstract class XmlGraphicsCommonsImage extends AbstractFopImage {
     }
 
     /**
-     * @see org.apache.fop.image.FopImage#getSoftMask()
+     * {@inheritDoc}
      */
     public byte[] getSoftMask() {
         if (this.bitmaps == null) {
diff --git a/src/java/org/apache/fop/image/analyser/BMPReader.java b/src/java/org/apache/fop/image/analyser/BMPReader.java
index a4f401462..caca6f3dd 100644
--- a/src/java/org/apache/fop/image/analyser/BMPReader.java
+++ b/src/java/org/apache/fop/image/analyser/BMPReader.java
@@ -47,7 +47,7 @@ public class BMPReader implements ImageReader {
     /** offset to vertical res */
     private static final int VRES_OFFSET = 42;
 
-    /** @see org.apache.fop.image.analyser.ImageReader */
+    /** {@inheritDoc} */
     public FopImage.ImageInfo verifySignature(String uri, InputStream bis,
                 FOUserAgent ua) throws IOException {
         byte[] header = getDefaultHeader(bis);
diff --git a/src/java/org/apache/fop/image/analyser/EMFReader.java b/src/java/org/apache/fop/image/analyser/EMFReader.java
index b61cff441..bdc4e97ff 100644
--- a/src/java/org/apache/fop/image/analyser/EMFReader.java
+++ b/src/java/org/apache/fop/image/analyser/EMFReader.java
@@ -52,7 +52,7 @@ public class EMFReader implements ImageReader {
     /** offset to vertical resolution in mm */

     private static final int VRES_MM_OFFSET = 84;

 

-    /** @see org.apache.fop.image.analyser.ImageReader */

+    /** {@inheritDoc} */

     public FopImage.ImageInfo verifySignature(String uri, InputStream bis,

                 FOUserAgent ua) throws IOException {

         byte[] header = getDefaultHeader(bis);

diff --git a/src/java/org/apache/fop/image/analyser/EPSReader.java b/src/java/org/apache/fop/image/analyser/EPSReader.java
index eba620fee..92260d1ab 100644
--- a/src/java/org/apache/fop/image/analyser/EPSReader.java
+++ b/src/java/org/apache/fop/image/analyser/EPSReader.java
@@ -42,7 +42,7 @@ public class EPSReader implements ImageReader {
     //private static final byte[] HIRESBOUNDINGBOX = "%%HiResBoundingBox: ".getBytes();
     //TODO Implement HiResBoundingBox, ImageInfo probably needs some changes for that
 
-    /** @see org.apache.fop.image.analyser.ImageReader */
+    /** {@inheritDoc} */
     public FopImage.ImageInfo verifySignature(String uri, InputStream bis,
                 FOUserAgent ua) throws IOException {
 
diff --git a/src/java/org/apache/fop/image/analyser/GIFReader.java b/src/java/org/apache/fop/image/analyser/GIFReader.java
index 206947f88..d8da89607 100644
--- a/src/java/org/apache/fop/image/analyser/GIFReader.java
+++ b/src/java/org/apache/fop/image/analyser/GIFReader.java
@@ -37,7 +37,7 @@ public class GIFReader implements ImageReader {
 
     private static final int GIF_SIG_LENGTH = 10;
 
-    /** @see org.apache.fop.image.analyser.ImageReader */
+    /** {@inheritDoc} */
     public FopImage.ImageInfo verifySignature(String uri, InputStream bis,
                 FOUserAgent ua) throws IOException {
         byte[] header = getDefaultHeader(bis);
diff --git a/src/java/org/apache/fop/image/analyser/JPEGReader.java b/src/java/org/apache/fop/image/analyser/JPEGReader.java
index bfa7d78d8..c90f6b000 100644
--- a/src/java/org/apache/fop/image/analyser/JPEGReader.java
+++ b/src/java/org/apache/fop/image/analyser/JPEGReader.java
@@ -54,7 +54,7 @@ public class JPEGReader implements ImageReader {
     private static final int SOI = 0xd8; // start of Image
     private static final int JPG_SIG_LENGTH = 2;
 
-    /** @see org.apache.fop.image.analyser.ImageReader */
+    /** {@inheritDoc} */
     public FopImage.ImageInfo verifySignature(String uri, InputStream fis,
                                    FOUserAgent ua) throws IOException {
         byte[] header = getDefaultHeader(fis);
diff --git a/src/java/org/apache/fop/image/analyser/PNGReader.java b/src/java/org/apache/fop/image/analyser/PNGReader.java
index 1c46f8d6e..ab6c64775 100644
--- a/src/java/org/apache/fop/image/analyser/PNGReader.java
+++ b/src/java/org/apache/fop/image/analyser/PNGReader.java
@@ -37,7 +37,7 @@ public class PNGReader implements ImageReader {
 
     private static final int PNG_SIG_LENGTH = 24;
 
-    /** @see org.apache.fop.image.analyser.ImageReader */
+    /** {@inheritDoc} */
     public FopImage.ImageInfo verifySignature(String uri, InputStream bis,
                 FOUserAgent ua) throws IOException {
         byte[] header = getDefaultHeader(bis);
diff --git a/src/java/org/apache/fop/image/analyser/SVGReader.java b/src/java/org/apache/fop/image/analyser/SVGReader.java
index da702d0c1..cffaa365c 100644
--- a/src/java/org/apache/fop/image/analyser/SVGReader.java
+++ b/src/java/org/apache/fop/image/analyser/SVGReader.java
@@ -58,7 +58,7 @@ public class SVGReader implements ImageReader {
 
     private boolean batik = true;
 
-    /** @see org.apache.fop.image.analyser.ImageReader */
+    /** {@inheritDoc} */
     public FopImage.ImageInfo verifySignature(String uri, InputStream fis,
             FOUserAgent ua) throws IOException {
         FopImage.ImageInfo info = loadImage(uri, fis, ua);
diff --git a/src/java/org/apache/fop/image/analyser/TIFFReader.java b/src/java/org/apache/fop/image/analyser/TIFFReader.java
index a70a105d7..08d702780 100644
--- a/src/java/org/apache/fop/image/analyser/TIFFReader.java
+++ b/src/java/org/apache/fop/image/analyser/TIFFReader.java
@@ -37,7 +37,7 @@ public class TIFFReader implements ImageReader {
 
     private static final int TIFF_SIG_LENGTH = 8;
 
-    /** @see org.apache.fop.image.analyser.ImageReader */
+    /** {@inheritDoc} */
     public FopImage.ImageInfo verifySignature(String uri, InputStream bis,
                 FOUserAgent ua) throws IOException {
         byte[] header = getDefaultHeader(bis);
diff --git a/src/java/org/apache/fop/image/analyser/XMLReader.java b/src/java/org/apache/fop/image/analyser/XMLReader.java
index aa558c1e7..4d0145eed 100644
--- a/src/java/org/apache/fop/image/analyser/XMLReader.java
+++ b/src/java/org/apache/fop/image/analyser/XMLReader.java
@@ -59,7 +59,7 @@ public class XMLReader implements ImageReader {
         converters.put(ns, conv);
     }
 
-    /** @see org.apache.fop.image.analyser.ImageReader */
+    /** {@inheritDoc} */
     public FopImage.ImageInfo verifySignature(String uri, InputStream fis,
             FOUserAgent ua)
         throws IOException {