Javadocs: Removed all <tt> occurrences with <code> or {@link}.

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

src/java/org/apache/fop/afp/AFPGraphics2D.java

@@ -26,6 +26,7 @@ import java.awt.Dimension;
 import java.awt.Font;
 import java.awt.FontMetrics;
 import java.awt.Graphics;
+import java.awt.Graphics2D;
 import java.awt.GraphicsConfiguration;
 import java.awt.Image;
 import java.awt.Paint;
@@ -67,8 +68,8 @@ import org.apache.fop.fonts.FontInfo;
 import org.apache.fop.svg.NativeImageHandler;
 
 /**
- * This is a concrete implementation of <tt>AbstractGraphics2D</tt> (and
- * therefore of <tt>Graphics2D</tt>) which is able to generate GOCA byte
+ * This is a concrete implementation of {@link AbstractGraphics2D} (and
+ * therefore of {@link Graphics2D}) which is able to generate GOCA byte
  * codes.
  *
  * @see org.apache.xmlgraphics.java2d.AbstractGraphics2D

src/java/org/apache/fop/afp/svg/AFPGraphicsConfiguration.java

@@ -28,6 +28,7 @@ import java.awt.image.ColorModel;
 
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
+
 import org.apache.fop.svg.GraphicsConfiguration;
 
 /**
@@ -95,7 +96,7 @@ public class AFPGraphicsConfiguration extends GraphicsConfiguration {
     }
 
     /**
-     * Return a good color model given <tt>transparency</tt>
+     * Return a good color model given <code>transparency</code>
      *
      * @param transparency the alpha value for the colour model
      * @return the colour model for the configuration

src/java/org/apache/fop/afp/svg/AFPTextPainter.java

@@ -25,9 +25,8 @@ import org.apache.fop.afp.AFPGraphics2D;
 import org.apache.fop.svg.AbstractFOPTextPainter;
 import org.apache.fop.svg.FOPTextHandler;
 
-
 /**
- * Renders the attributed character iterator of a <tt>TextNode</tt>.
+ * Renders the attributed character iterator of a {@link TextNode}.
  * This class draws the text directly into the AFPGraphics2D so that
  * the text is not drawn using shapes.
  * If the text is simple enough to draw then it sets the font and calls

src/java/org/apache/fop/render/intermediate/IFException.java

@@ -35,7 +35,7 @@ public class IFException extends Exception {
      * @param  message the detail message (which is saved for later retrieval
      *         by the {@link #getMessage()} method).
      * @param  cause the cause (which is saved for later retrieval by the
-     *         {@link #getCause()} method).  (A <tt>null</tt> value is
+     *         {@link #getCause()} method).  (A <code>null</code> value is
      *         permitted, and indicates that the cause is nonexistent or
      *         unknown.)
      */

src/java/org/apache/fop/render/java2d/CustomFontMetricsMapper.java

@@ -35,8 +35,8 @@ import org.apache.fop.fonts.Typeface;
 
 /**
  * FontMetricsMapper that delegates most methods to an underlying
- * <tt>FontMetrics</tt> instance. This class was designed to allow
- * the underlying <tt>java.awt.Font</tt> to be loaded from a
+ * {@link FontMetrics} instance. This class was designed to allow
+ * the underlying {@link java.awt.Font} to be loaded from a
  * user-configured file not registered in the current graphics environment.
  */
 public class CustomFontMetricsMapper extends Typeface implements FontMetricsMapper {
@@ -57,11 +57,11 @@ public class CustomFontMetricsMapper extends Typeface implements FontMetricsMapp
     private float size = 1;
 
     /**
-     * Construction of this class results in the immediate construction.
-     * of the underlying <tt>java.awt.Font</tt>
-     * @param fontMetrics
-     * @throws FontFormatException
-     * @throws IOException
+     * Construction of this class results in the immediate construction
+     * of the underlying {@link java.awt.Font}.
+     * @param fontMetrics the metrics of the custom font
+     * @throws FontFormatException if a bad font is loaded
+     * @throws IOException if an I/O error occurs
      */
     public CustomFontMetricsMapper(final CustomFont fontMetrics)
             throws FontFormatException, IOException {
@@ -71,10 +71,11 @@ public class CustomFontMetricsMapper extends Typeface implements FontMetricsMapp
 
     /**
      * Construction of this class results in the immediate construction
-     * of the underlying <tt>java.awt.Font</tt>
-     * @param fontMetrics
-     * @throws FontFormatException
-     * @throws IOException
+     * of the underlying {@link java.awt.Font}.
+     * @param fontMetrics the font
+     * @param fontSource the font source to access the font
+     * @throws FontFormatException if a bad font is loaded
+     * @throws IOException if an I/O error occurs
      */
     public CustomFontMetricsMapper(final LazyFont fontMetrics, final Source fontSource)
             throws FontFormatException, IOException {

src/java/org/apache/fop/render/java2d/FontMetricsMapper.java

@@ -22,14 +22,14 @@ package org.apache.fop.render.java2d;
 import org.apache.fop.fonts.FontMetrics;
 
 /**
- * Adds method to retrieve the actual <tt>java.awt.Font</tt>
- * for use by <tt>Java2DRenderer</tt>s.
+ * Adds method to retrieve the actual {@link java.awt.Font}
+ * for use by {@link Java2DRenderer}s.
  */
 public interface FontMetricsMapper extends FontMetrics {
 
     /**
-     * Gets a Font instance  of the Font that this
-     * FontMetrics describes in the desired size.
+     * Gets a {@link Font} instance of the font that this
+     * {@link FontMetrics} describes in the desired size.
      * @param size font size
      * @return font with the desired characteristics.
      */

src/java/org/apache/fop/render/ps/AbstractPSTranscoder.java

@@ -44,25 +44,25 @@ import org.apache.fop.svg.PDFDocumentGraphics2DConfigurator;
 /**
  * This class enables to transcode an input to a PostScript document.
  *
- * <p>Two transcoding hints (<tt>KEY_WIDTH</tt> and
- * <tt>KEY_HEIGHT</tt>) can be used to respectively specify the image
+ * <p>Two transcoding hints (<code>KEY_WIDTH</code> and
+ * <code>KEY_HEIGHT</code>) can be used to respectively specify the image
  * width and the image height. If only one of these keys is specified,
  * the transcoder preserves the aspect ratio of the original image.
  *
- * <p>The <tt>KEY_BACKGROUND_COLOR</tt> defines the background color
+ * <p>The <code>KEY_BACKGROUND_COLOR</code> defines the background color
  * to use for opaque image formats, or the background color that may
  * be used for image formats that support alpha channel.
  *
- * <p>The <tt>KEY_AOI</tt> represents the area of interest to paint
+ * <p>The <code>KEY_AOI</code> represents the area of interest to paint
  * in device space.
  *
  * <p>Three additional transcoding hints that act on the SVG
  * processor can be specified:
  *
- * <p><tt>KEY_LANGUAGE</tt> to set the default language to use (may be
+ * <p><code>KEY_LANGUAGE</code> to set the default language to use (may be
  * used by a &lt;switch> SVG element for example),
- * <tt>KEY_USER_STYLESHEET_URI</tt> to fix the URI of a user
- * stylesheet, and <tt>KEY_PIXEL_TO_MM</tt> to specify the pixel to
+ * <code>KEY_USER_STYLESHEET_URI</code> to fix the URI of a user
+ * stylesheet, and <code>KEY_PIXEL_TO_MM</code> to specify the pixel to
  * millimeter conversion factor.
  *
  * @author <a href="mailto:keiron@aftexsw.com">Keiron Liddle</a>
@@ -76,7 +76,7 @@ public abstract class AbstractPSTranscoder extends AbstractFOPTranscoder {
     private FontInfo fontInfo;
 
     /**
-     * Constructs a new <tt>AbstractPSTranscoder</tt>.
+     * Constructs a new {@link AbstractPSTranscoder}.
      */
     public AbstractPSTranscoder() {
         super();

src/java/org/apache/fop/render/ps/EPSTranscoder.java

@@ -25,25 +25,25 @@ import org.apache.xmlgraphics.java2d.ps.EPSDocumentGraphics2D;
 /**
  * This class enables to transcode an input to a EPS document.
  *
- * <p>Two transcoding hints (<tt>KEY_WIDTH</tt> and
- * <tt>KEY_HEIGHT</tt>) can be used to respectively specify the image
+ * <p>Two transcoding hints (<code>KEY_WIDTH</code> and
+ * <code>KEY_HEIGHT</code>) can be used to respectively specify the image
  * width and the image height. If only one of these keys is specified,
  * the transcoder preserves the aspect ratio of the original image.
  *
- * <p>The <tt>KEY_BACKGROUND_COLOR</tt> defines the background color
+ * <p>The <code>KEY_BACKGROUND_COLOR</code> defines the background color
  * to use for opaque image formats, or the background color that may
  * be used for image formats that support alpha channel.
  *
- * <p>The <tt>KEY_AOI</tt> represents the area of interest to paint
+ * <p>The <code>KEY_AOI</code> represents the area of interest to paint
  * in device space.
  *
  * <p>Three additional transcoding hints that act on the SVG
  * processor can be specified:
  *
- * <p><tt>KEY_LANGUAGE</tt> to set the default language to use (may be
+ * <p><code>KEY_LANGUAGE</code> to set the default language to use (may be
  * used by a &lt;switch> SVG element for example),
- * <tt>KEY_USER_STYLESHEET_URI</tt> to fix the URI of a user
- * stylesheet, and <tt>KEY_PIXEL_TO_MM</tt> to specify the pixel to
+ * <code>KEY_USER_STYLESHEET_URI</code> to fix the URI of a user
+ * stylesheet, and <code>KEY_PIXEL_TO_MM</code> to specify the pixel to
  * millimeter conversion factor.
  *
  * @author <a href="mailto:keiron@aftexsw.com">Keiron Liddle</a>
@@ -52,7 +52,7 @@ import org.apache.xmlgraphics.java2d.ps.EPSDocumentGraphics2D;
 public class EPSTranscoder extends AbstractPSTranscoder {
 
     /**
-     * Constructs a new <tt>EPSPSTranscoder</tt>.
+     * Constructs a new {@link EPSTranscoder}.
      */
     public EPSTranscoder() {
         super();

src/java/org/apache/fop/render/ps/PSTextPainter.java

@@ -49,7 +49,7 @@ import org.apache.fop.svg.NativeTextPainter;
 import org.apache.fop.util.CharUtilities;
 
 /**
- * Renders the attributed character iterator of a <tt>TextNode</tt>.
+ * Renders the attributed character iterator of a {@link TextNode}.
  * This class draws the text directly using PostScript text operators so
  * the text is not drawn using shapes which makes the PS files larger.
  * <p>

src/java/org/apache/fop/render/ps/PSTranscoder.java

@@ -25,25 +25,25 @@ import org.apache.xmlgraphics.java2d.ps.PSDocumentGraphics2D;
 /**
  * This class enables to transcode an input to a PostScript document.
  *
- * <p>Two transcoding hints (<tt>KEY_WIDTH</tt> and
- * <tt>KEY_HEIGHT</tt>) can be used to respectively specify the image
+ * <p>Two transcoding hints (<code>KEY_WIDTH</code> and
+ * <code>KEY_HEIGHT</code>) can be used to respectively specify the image
  * width and the image height. If only one of these keys is specified,
  * the transcoder preserves the aspect ratio of the original image.
  *
- * <p>The <tt>KEY_BACKGROUND_COLOR</tt> defines the background color
+ * <p>The <code>KEY_BACKGROUND_COLOR</code> defines the background color
  * to use for opaque image formats, or the background color that may
  * be used for image formats that support alpha channel.
  *
- * <p>The <tt>KEY_AOI</tt> represents the area of interest to paint
+ * <p>The <code>KEY_AOI</code> represents the area of interest to paint
  * in device space.
  *
  * <p>Three additional transcoding hints that act on the SVG
  * processor can be specified:
  *
- * <p><tt>KEY_LANGUAGE</tt> to set the default language to use (may be
+ * <p><code>KEY_LANGUAGE</code> to set the default language to use (may be
  * used by a &lt;switch> SVG element for example),
- * <tt>KEY_USER_STYLESHEET_URI</tt> to fix the URI of a user
- * stylesheet, and <tt>KEY_PIXEL_TO_MM</tt> to specify the pixel to
+ * <code>KEY_USER_STYLESHEET_URI</code> to fix the URI of a user
+ * stylesheet, and <code>KEY_PIXEL_TO_MM</code> to specify the pixel to
  * millimeter conversion factor.
  *
  * @author <a href="mailto:keiron@aftexsw.com">Keiron Liddle</a>
@@ -52,7 +52,7 @@ import org.apache.xmlgraphics.java2d.ps.PSDocumentGraphics2D;
 public class PSTranscoder extends AbstractPSTranscoder {
 
     /**
-     * Constructs a new <tt>PSTranscoder</tt>.
+     * Constructs a new {@link PSTranscoder}.
      */
     public PSTranscoder() {
         super();

src/java/org/apache/fop/svg/AbstractFOPTextPainter.java

@@ -49,9 +49,8 @@ import org.apache.fop.fonts.Font;
 import org.apache.fop.fonts.FontInfo;
 import org.apache.fop.fonts.FontTriplet;
 
-
 /**
- * Renders the attributed character iterator of a <tt>TextNode</tt>.
+ * Renders the attributed character iterator of a {@link TextNode}.
  * This class draws the text directly into the Graphics2D so that
  * the text is not drawn using shapes.
  * If the text is simple enough to draw then it sets the font and calls

src/java/org/apache/fop/svg/AbstractFOPTranscoder.java

@@ -180,7 +180,7 @@ public abstract class AbstractFOPTranscoder extends SVGAbstractTranscoder {
     }
 
     /**
-     * Creates a <tt>DocumentFactory</tt> that is used to create an SVG DOM
+     * Creates a {@link DocumentFactory} that is used to create an SVG DOM
      * tree. The specified DOM Implementation is ignored and the Batik
      * SVG DOM Implementation is automatically used.
      *
@@ -326,7 +326,7 @@ public abstract class AbstractFOPTranscoder extends SVGAbstractTranscoder {
     protected class FOPTranscoderUserAgent extends SVGAbstractTranscoderUserAgent {
 
         /**
-         * Displays the specified error message using the <tt>ErrorHandler</tt>.
+         * Displays the specified error message using the {@link ErrorHandler}.
          * @param message the message to display
          */
         public void displayError(String message) {
@@ -338,7 +338,7 @@ public abstract class AbstractFOPTranscoder extends SVGAbstractTranscoder {
         }
 
         /**
-         * Displays the specified error using the <tt>ErrorHandler</tt>.
+         * Displays the specified error using the {@link ErrorHandler}.
          * @param e the exception to display
          */
         public void displayError(Exception e) {
@@ -350,7 +350,7 @@ public abstract class AbstractFOPTranscoder extends SVGAbstractTranscoder {
         }
 
         /**
-         * Displays the specified message using the <tt>ErrorHandler</tt>.
+         * Displays the specified message using the {@link ErrorHandler}.
          * @param message the message to display
          */
         public void displayMessage(String message) {
@@ -359,7 +359,7 @@ public abstract class AbstractFOPTranscoder extends SVGAbstractTranscoder {
 
         /**
          * Returns the pixel to millimeter conversion factor specified in the
-         * <tt>TranscodingHints</tt> or 0.3528 if any.
+         * {@link TranscodingHints} or 0.3528 if any.
          * @return the pixel unit to millimeter factor
          */
         public float getPixelUnitToMillimeter() {

src/java/org/apache/fop/svg/PDFAElementBridge.java

@@ -21,14 +21,14 @@ package org.apache.fop.svg;
 
 import java.awt.geom.AffineTransform;
 
+import org.w3c.dom.Element;
+import org.w3c.dom.svg.SVGAElement;
+
 import org.apache.batik.bridge.AbstractGraphicsNodeBridge;
 import org.apache.batik.bridge.BridgeContext;
-
+import org.apache.batik.gvt.CompositeGraphicsNode;
 import org.apache.batik.gvt.GraphicsNode;
 
-import org.w3c.dom.Element;
-import org.w3c.dom.svg.SVGAElement;
-
 /**
  * Bridge class for the <a> element.
  *
@@ -65,7 +65,7 @@ public class PDFAElementBridge extends AbstractGraphicsNodeBridge {
     }
 
     /**
-     * Creates a <tt>CompositeGraphicsNode</tt>.
+     * Creates a {@link CompositeGraphicsNode}.
      * @return a new PDFANode
      */
     protected GraphicsNode instantiateGraphicsNode() {

src/java/org/apache/fop/svg/PDFANode.java

@@ -19,15 +19,14 @@
 
 package org.apache.fop.svg;
 
-import org.apache.batik.gvt.CompositeGraphicsNode;
-
 import java.awt.Graphics2D;
 import java.awt.Shape;
-import java.awt.geom.Rectangle2D;
 import java.awt.geom.AffineTransform;
-
+import java.awt.geom.Rectangle2D;
 import java.util.StringTokenizer;
 
+import org.apache.batik.gvt.CompositeGraphicsNode;
+
 /**
  * A graphics node that represents an image described as a graphics node.
  *
@@ -38,7 +37,7 @@ public class PDFANode extends CompositeGraphicsNode {
     private AffineTransform transform;
 
     /**
-     * Constructs a new empty <tt>PDFANode</tt>.
+     * Constructs a new empty {@link PDFANode}.
      */
     public PDFANode() {
     }

src/java/org/apache/fop/svg/PDFDocumentGraphics2D.java

@@ -44,9 +44,9 @@ import org.apache.fop.pdf.PDFResources;
 import org.apache.fop.pdf.PDFStream;
 
 /**
- * This class is a wrapper for the <tt>PDFGraphics2D</tt> that
- * is used to create a full document around the pdf rendering from
- * <tt>PDFGraphics2D</tt>.
+ * This class is a wrapper for the {@link PDFGraphics2D} that
+ * is used to create a full document around the PDF rendering from
+ * {@link PDFGraphics2D}.
  *
  * @see org.apache.fop.svg.PDFGraphics2D
  */

src/java/org/apache/fop/svg/PDFGraphicsConfiguration.java

@@ -19,12 +19,12 @@
 
 package org.apache.fop.svg;
 
-import java.awt.Rectangle;
 import java.awt.GraphicsDevice;
+import java.awt.Rectangle;
 import java.awt.Transparency;
-import java.awt.image.ColorModel;
 import java.awt.geom.AffineTransform;
 import java.awt.image.BufferedImage;
+import java.awt.image.ColorModel;
 
 
 /**
@@ -92,7 +92,7 @@ class PDFGraphicsConfiguration extends GraphicsConfiguration {
     }
 
     /**
-     * Return a good color model given <tt>transparency</tt>
+     * Return a good color model given <code>transparency</code>
      *
      * @param transparency the alpha value for the colour model
      * @return the colour model for the configuration

src/java/org/apache/fop/svg/PDFTextPainter.java

@@ -40,7 +40,7 @@ import org.apache.fop.fonts.FontInfo;
 import org.apache.fop.util.CharUtilities;
 
 /**
- * Renders the attributed character iterator of a <tt>TextNode</tt>.
+ * Renders the attributed character iterator of a {@link TextNode}.
  * This class draws the text directly into the PDFGraphics2D so that
  * the text is not drawn using shapes which makes the PDF files larger.
  * If the text is simple enough to draw then it sets the font and calls

src/java/org/apache/fop/svg/PDFTranscoder.java

@@ -43,28 +43,28 @@ import org.apache.fop.fonts.FontInfo;
 /**
  * This class enables to transcode an input to a pdf document.
  *
- * <p>Two transcoding hints (<tt>KEY_WIDTH</tt> and
- * <tt>KEY_HEIGHT</tt>) can be used to respectively specify the image
+ * <p>Two transcoding hints (<code>KEY_WIDTH</code> and
+ * <code>KEY_HEIGHT</code>) can be used to respectively specify the image
  * width and the image height. If only one of these keys is specified,
  * the transcoder preserves the aspect ratio of the original image.
  *
- * <p>The <tt>KEY_BACKGROUND_COLOR</tt> defines the background color
+ * <p>The <code>KEY_BACKGROUND_COLOR</code> defines the background color
  * to use for opaque image formats, or the background color that may
  * be used for image formats that support alpha channel.
  *
- * <p>The <tt>KEY_AOI</tt> represents the area of interest to paint
+ * <p>The <code>KEY_AOI</code> represents the area of interest to paint
  * in device space.
  *
  * <p>Three additional transcoding hints that act on the SVG
  * processor can be specified:
  *
- * <p><tt>KEY_LANGUAGE</tt> to set the default language to use (may be
+ * <p><code>KEY_LANGUAGE</code> to set the default language to use (may be
  * used by a &lt;switch> SVG element for example),
- * <tt>KEY_USER_STYLESHEET_URI</tt> to fix the URI of a user
- * stylesheet, and <tt>KEY_PIXEL_TO_MM</tt> to specify the pixel to
+ * <code>KEY_USER_STYLESHEET_URI</code> to fix the URI of a user
+ * stylesheet, and <code>KEY_PIXEL_TO_MM</code> to specify the pixel to
  * millimeter conversion factor.
  *
- * <p><tt>KEY_AUTO_FONTS</tt> to disable the auto-detection of fonts installed in the system.
+ * <p><code>KEY_AUTO_FONTS</code> to disable the auto-detection of fonts installed in the system.
  * The PDF Transcoder cannot use AWT's font subsystem and that's why the fonts have to be
  * configured differently. By default, font auto-detection is enabled to match the behaviour
  * of the other transcoders, but this may be associated with a price in the form of a small
@@ -80,7 +80,7 @@ public class PDFTranscoder extends AbstractFOPTranscoder
     protected PDFDocumentGraphics2D graphics = null;
 
     /**
-     * Constructs a new <tt>PDFTranscoder</tt>.
+     * Constructs a new {@link PDFTranscoder}.
      */
     public PDFTranscoder() {
         super();