]> source.dussan.org Git - xmlgraphics-fop.git/commitdiff
Some javadoc fixes: @code -> @link
authorJeremias Maerki <jeremias@apache.org>
Thu, 1 Oct 2009 14:48:27 +0000 (14:48 +0000)
committerJeremias Maerki <jeremias@apache.org>
Thu, 1 Oct 2009 14:48:27 +0000 (14:48 +0000)
git-svn-id: https://svn.apache.org/repos/asf/xmlgraphics/fop/trunk@820672 13f79535-47bb-0310-9956-ffa450edef68

45 files changed:
src/java/org/apache/fop/fo/FONode.java
src/java/org/apache/fop/fonts/FontManager.java
src/java/org/apache/fop/layoutmgr/BlockStackingLayoutManager.java
src/java/org/apache/fop/layoutmgr/KnuthPenalty.java
src/java/org/apache/fop/render/ImageHandler.java
src/java/org/apache/fop/render/ImageHandlerRegistry.java
src/java/org/apache/fop/render/PrintRendererConfigurator.java
src/java/org/apache/fop/render/RendererFactory.java
src/java/org/apache/fop/render/afp/AFPDocumentHandler.java
src/java/org/apache/fop/render/bitmap/AbstractBitmapDocumentHandler.java
src/java/org/apache/fop/render/bitmap/PNGDocumentHandler.java
src/java/org/apache/fop/render/bitmap/TIFFDocumentHandler.java
src/java/org/apache/fop/render/intermediate/AbstractBinaryWritingIFDocumentHandler.java
src/java/org/apache/fop/render/intermediate/AbstractIFDocumentHandler.java
src/java/org/apache/fop/render/intermediate/AbstractIFDocumentHandlerMaker.java
src/java/org/apache/fop/render/intermediate/AbstractXMLWritingIFDocumentHandler.java
src/java/org/apache/fop/render/intermediate/AffineTransformArrayParser.java
src/java/org/apache/fop/render/intermediate/DelegatingFragmentContentHandler.java
src/java/org/apache/fop/render/intermediate/IFDocumentHandler.java
src/java/org/apache/fop/render/intermediate/IFDocumentHandlerConfigurator.java
src/java/org/apache/fop/render/intermediate/IFPainter.java
src/java/org/apache/fop/render/intermediate/IFParser.java
src/java/org/apache/fop/render/intermediate/IFRenderer.java
src/java/org/apache/fop/render/intermediate/IFUtil.java
src/java/org/apache/fop/render/java2d/Java2DBorderPainter.java
src/java/org/apache/fop/render/java2d/Java2DImageHandlerGraphics2D.java
src/java/org/apache/fop/render/java2d/Java2DImageHandlerRenderedImage.java
src/java/org/apache/fop/render/java2d/Java2DPainter.java
src/java/org/apache/fop/render/java2d/Java2DUtil.java
src/java/org/apache/fop/render/pcl/PCLDocumentHandler.java
src/java/org/apache/fop/render/pcl/PCLImageHandlerRenderedImage.java
src/java/org/apache/fop/render/pcl/PCLPainter.java
src/java/org/apache/fop/render/pcl/PCLRenderingContext.java
src/java/org/apache/fop/render/pcl/PCLRenderingUtil.java
src/java/org/apache/fop/render/pdf/PDFBorderPainter.java
src/java/org/apache/fop/render/pdf/PDFContentGenerator.java
src/java/org/apache/fop/render/pdf/PDFDocumentHandler.java
src/java/org/apache/fop/render/ps/PSBorderPainter.java
src/java/org/apache/fop/render/ps/PSDocumentHandler.java
src/java/org/apache/fop/render/ps/PSRenderingUtil.java
src/java/org/apache/fop/traits/TraitEnum.java
src/java/org/apache/fop/util/DecimalFormatCache.java
src/java/org/apache/fop/util/XMLUtil.java
src/sandbox/org/apache/fop/render/svg/SVGDocumentHandler.java
src/sandbox/org/apache/fop/render/svg/SVGPrintDocumentHandler.java

index debb6a4b1c38941cfd98246579b4008316267100..9f18ee6eea11b221523e6b6ad74baccfb4dc496b 100644 (file)
@@ -23,12 +23,13 @@ package org.apache.fop.fo;
 import java.util.ListIterator;
 import java.util.Map;
 
-import org.apache.commons.logging.Log;
-import org.apache.commons.logging.LogFactory;
 import org.xml.sax.Attributes;
 import org.xml.sax.Locator;
 import org.xml.sax.helpers.LocatorImpl;
 
+import org.apache.commons.logging.Log;
+import org.apache.commons.logging.LogFactory;
+
 import org.apache.xmlgraphics.util.QName;
 
 import org.apache.fop.apps.FOPException;
@@ -273,7 +274,7 @@ public abstract class FONode implements Cloneable {
      * @param pList currently applicable PropertyList
      * @param locator location in the XSL-FO source file.
      * @throws FOPException if there's a problem during processing
-     * @deprecated Please override {@code #characters(char[], int, int, PropertyList, Locator)}
+     * @deprecated Please override {@link #characters(char[], int, int, PropertyList, Locator)}
      *          instead!
      */
     protected void addCharacters(char[] data, int start, int end,
index daf0a0cdbc279a80723ba13c44d39c3b119799e1..41df6bedd10686e0e68d19b9f0bde01cee52f29d 100644 (file)
@@ -145,7 +145,7 @@ public class FontManager {
 
     /**
      * Sets up the fonts on a given FontInfo object. The fonts to setup are defined by an
-     * array of {@code FontCollection} objects.
+     * array of {@link FontCollection} objects.
      * @param fontInfo the FontInfo object to set up
      * @param fontCollections the array of font collections/sources
      */
index 53c529eaa48e1a0434550273f188b3e5416939c4..9a0dbe220a1872733312b638e0c1409dde74d0ac 100644 (file)
@@ -1021,7 +1021,7 @@ public abstract class BlockStackingLayoutManager extends AbstractLayoutManager
 
     /**
      * {@inheritDoc}
-     * Default implementation throws {@code IllegalStateException}
+     * Default implementation throws a {@link IllegalStateException}.
      * Must be implemented by the subclass, if applicable.
      */
     public KeepProperty getKeepTogetherProperty() {
@@ -1030,7 +1030,7 @@ public abstract class BlockStackingLayoutManager extends AbstractLayoutManager
 
     /**
      * {@inheritDoc}
-     * Default implementation throws {@code IllegalStateException}
+     * Default implementation throws a {@link IllegalStateException}.
      * Must be implemented by the subclass, if applicable.
      */
     public KeepProperty getKeepWithPreviousProperty() {
@@ -1039,7 +1039,7 @@ public abstract class BlockStackingLayoutManager extends AbstractLayoutManager
 
     /**
      * {@inheritDoc}
-     * Default implementation throws {@code IllegalStateException}
+     * Default implementation throws a {@link IllegalStateException}.
      * Must be implemented by the subclass, if applicable.
      */
     public KeepProperty getKeepWithNextProperty() {
index 5e44127df0138b4adf20d24417a577ca3df88566..9031b6b64ea4a025189487493eec31f9a378083e 100644 (file)
@@ -86,12 +86,12 @@ public class KnuthPenalty extends KnuthElement {
     }
 
     /**
-     * Get the penalty's value as a {@code java.lang.String}.
-     * (Mainly used in {@code toString()} methods, to improve readability
+     * Get the penalty's value as a {@link java.lang.String}.
+     * (Mainly used in {@link #toString()} methods, to improve readability
      * of the trace logs.)
      *
      * @param penaltyValue  the penalty value
-     * @return  the penalty value as a {@code java.lang.String}
+     * @return  the penalty value as a {@link java.lang.String}
      */
     protected static String valueOf(int penaltyValue) {
         String result = (penaltyValue < 0) ? "-" : "";
index ec5f576aa9df7d3fe78130aaff7396767f771cb0..0078e37bd6d0e3801378139e5207e48b668905c3 100644 (file)
@@ -23,6 +23,7 @@ import java.awt.Rectangle;
 import java.io.IOException;
 
 import org.apache.xmlgraphics.image.loader.Image;
+import org.apache.xmlgraphics.image.loader.impl.ImageXMLDOM;
 
 /**
  * This interface is a service provider interface for image handlers.
@@ -33,7 +34,7 @@ public interface ImageHandler extends ImageHandlerBase {
      * Indicates whether the image handler is compatible with the indicated target represented
      * by the rendering context object and with the image to be processed. The image is also
      * passed as a parameter because a handler might not support every subtype of image that is
-     * presented. For example: in the case of {@code ImageXMLDOM}, the image might carry an SVG
+     * presented. For example: in the case of {@link ImageXMLDOM}, the image might carry an SVG
      * or some other XML format. One handler might only handle SVG but no other XML format.
      * @param targetContext the target rendering context
      * @param image the image to be processed (or null if only to check based on the rendering
index 3a241138addfd9b75bee21ce5b98f0e4a5daebc2..e878e0dfe2828554b29fb33387c5fd0b55f94825 100644 (file)
@@ -50,7 +50,7 @@ public class ImageHandlerRegistry {
         }
     };
 
-    /** Map containing image handlers for various {@code Image} subclasses. */
+    /** Map containing image handlers for various {@link Image} subclasses. */
     private Map handlers = new java.util.HashMap();
     /** List containing the same handlers as above but ordered by priority */
     private List handlerList = new java.util.LinkedList();
@@ -112,7 +112,7 @@ public class ImageHandlerRegistry {
     }
 
     /**
-     * Returns an {@code ImageHandler} which handles an specific image type given the MIME type
+     * Returns an {@link ImageHandler} which handles an specific image type given the MIME type
      * of the image.
      * @param targetContext the target rendering context that is used for identifying compatibility
      * @param image the Image to be handled
index 66618b093c93ecc0d06e67eafffa240229ca924e..dd7a0506727540ed0b808eb1e0f75fefa67884f3 100644 (file)
@@ -29,6 +29,7 @@ import org.apache.fop.apps.FOPException;
 import org.apache.fop.apps.FOUserAgent;
 import org.apache.fop.apps.FopFactory;
 import org.apache.fop.fonts.CustomFontCollection;
+import org.apache.fop.fonts.EmbedFontInfo;
 import org.apache.fop.fonts.FontCollection;
 import org.apache.fop.fonts.FontEventAdapter;
 import org.apache.fop.fonts.FontEventListener;
@@ -84,7 +85,7 @@ public class PrintRendererConfigurator extends AbstractRendererConfigurator
      * @param cfg the configuration object
      * @param fontResolver a font resolver
      * @param listener the font event listener
-     * @return the list of {@code EmbedFontInfo} objects
+     * @return the list of {@link EmbedFontInfo} objects
      * @throws FOPException if an error occurs while processing the configuration
      */
     protected List/*<EmbedFontInfo>*/ buildFontList(Configuration cfg, FontResolver fontResolver,
index 3832a071453d9ca929505d4081dfa83de542fc57..febe5a9ea63e84484bd06c7ea092cbf8bff0329d 100644 (file)
@@ -368,10 +368,10 @@ public class RendererFactory {
     }
 
     /**
-     * Creates a {@code IFDocumentHandler} object based on the desired output format.
+     * Creates a {@link IFDocumentHandler} object based on the desired output format.
      * @param userAgent the user agent for access to configuration
      * @param outputFormat the MIME type of the output format to use (ex. "application/pdf").
-     * @return the new {@code IFDocumentHandler} instance
+     * @return the new {@link IFDocumentHandler} instance
      * @throws FOPException if the document handler cannot be properly constructed
      */
     public IFDocumentHandler createDocumentHandler(FOUserAgent userAgent, String outputFormat)
@@ -464,7 +464,7 @@ public class RendererFactory {
     }
 
     /**
-     * Discovers {@code IFDocumentHandler} implementations through the classpath and dynamically
+     * Discovers {@link IFDocumentHandler} implementations through the classpath and dynamically
      * registers them.
      */
     private void discoverDocumentHandlers() {
index 073d43e201defae6e20694ee71f2edbb8a9fc26d..8ccee5b70f53336a7f518c7a01ebece87eb4aef3 100644 (file)
@@ -48,12 +48,13 @@ import org.apache.fop.render.afp.extensions.AFPIncludeFormMap;
 import org.apache.fop.render.afp.extensions.AFPInvokeMediumMap;
 import org.apache.fop.render.afp.extensions.AFPPageSetup;
 import org.apache.fop.render.intermediate.AbstractBinaryWritingIFDocumentHandler;
+import org.apache.fop.render.intermediate.IFDocumentHandler;
 import org.apache.fop.render.intermediate.IFDocumentHandlerConfigurator;
 import org.apache.fop.render.intermediate.IFException;
 import org.apache.fop.render.intermediate.IFPainter;
 
 /**
- * {@code IFDocumentHandler} implementation that produces AFP (MO:DCA).
+ * {@link IFDocumentHandler} implementation that produces AFP (MO:DCA).
  */
 public class AFPDocumentHandler extends AbstractBinaryWritingIFDocumentHandler
             implements AFPCustomizable {
index 88b054fc5364a3dd4f7f0f57b032dbe8f1362880..3449ffe7eb8695de5626362b16a77d94f662e6ef 100644 (file)
@@ -38,6 +38,7 @@ import org.apache.fop.apps.FopFactoryConfigurator;
 import org.apache.fop.fonts.FontInfo;
 import org.apache.fop.render.intermediate.AbstractBinaryWritingIFDocumentHandler;
 import org.apache.fop.render.intermediate.IFContext;
+import org.apache.fop.render.intermediate.IFDocumentHandler;
 import org.apache.fop.render.intermediate.IFDocumentHandlerConfigurator;
 import org.apache.fop.render.intermediate.IFException;
 import org.apache.fop.render.intermediate.IFPainter;
@@ -45,7 +46,7 @@ import org.apache.fop.render.java2d.Java2DPainter;
 import org.apache.fop.render.java2d.Java2DUtil;
 
 /**
- * Abstract {@code IFDocumentHandler} implementation for producing bitmap images.
+ * Abstract {@link IFDocumentHandler} implementation for producing bitmap images.
  */
 public abstract class AbstractBitmapDocumentHandler extends AbstractBinaryWritingIFDocumentHandler {
 
index 09919f03e322c6f738c007860aae1fc327587d1f..77a024436c8828291e079d94d29d991c3aff8408 100644 (file)
 package org.apache.fop.render.bitmap;
 
 import org.apache.fop.apps.MimeConstants;
+import org.apache.fop.render.intermediate.IFDocumentHandler;
 import org.apache.fop.render.intermediate.IFDocumentHandlerConfigurator;
 
 /**
- * {@code IFDocumentHandler} implementation that produces PNG files.
+ * {@link IFDocumentHandler} implementation that produces PNG files.
  */
 public class PNGDocumentHandler extends AbstractBitmapDocumentHandler {
 
index 46603a3e68f19b868bde4ffb20214a6ee3de0ae4..a212d0e9e6ef7d5fea228339e29ce99287ae0c82 100644 (file)
 package org.apache.fop.render.bitmap;
 
 import org.apache.fop.apps.MimeConstants;
+import org.apache.fop.render.intermediate.IFDocumentHandler;
 import org.apache.fop.render.intermediate.IFDocumentHandlerConfigurator;
 
 /**
- * {@code IFDocumentHandler} implementation that produces TIFF files.
+ * {@link IFDocumentHandler} implementation that produces TIFF files.
  */
 public class TIFFDocumentHandler extends AbstractBitmapDocumentHandler {
 
index a362d0fb581a069b8bf5e0537140dbf00a1888d1..cc5406acf75f65df88e4f3a4d1b4684258d57553 100644 (file)
@@ -37,7 +37,7 @@ import org.apache.fop.fonts.FontManager;
 import org.apache.fop.fonts.base14.Base14FontCollection;
 
 /**
- * Abstract base class for binary-writing {@code IFDocumentHandler} implementations.
+ * Abstract base class for binary-writing {@link IFDocumentHandler} implementations.
  */
 public abstract class AbstractBinaryWritingIFDocumentHandler extends AbstractIFDocumentHandler {
 
index deefe0b94121a26b0fb9e2b142dae6fc02041d99..cd15a9d726629e175a92b43ee61977b0581ebe8e 100644 (file)
@@ -25,7 +25,7 @@ import org.apache.commons.logging.LogFactory;
 import org.apache.fop.apps.FOUserAgent;
 
 /**
- * Abstract base class for {@code IFDocumentHandler} implementations.
+ * Abstract base class for {@link IFDocumentHandler} implementations.
  */
 public abstract class AbstractIFDocumentHandler implements IFDocumentHandler {
 
index 7162a976cb229be7be5d7dc3d2e1bdca1e010293..204faad00fdf67523d217e2fce578cc9bbcfb91c 100644 (file)
@@ -22,13 +22,13 @@ package org.apache.fop.render.intermediate;
 import org.apache.fop.apps.FOUserAgent;
 
 /**
- * Base class for factory classes which instantiate {@code IFDocumentHandler}s and provide
+ * Base class for factory classes which instantiate {@link IFDocumentHandler}s and provide
  * information about them.
  */
 public abstract class AbstractIFDocumentHandlerMaker {
 
     /**
-     * Instantiates a new {@code IFDocumentHandler}.
+     * Instantiates a new {@link IFDocumentHandler}.
      * @param userAgent the user agent
      * @return the newly instantiated document handler
      */
index 98706c09b3b3a8d8bbf3a26175ed36bc6c63f2b6..be65e1317f475a259a467695f4b74b333f334a63 100644 (file)
@@ -32,7 +32,7 @@ import org.xml.sax.ContentHandler;
 import org.apache.fop.util.GenerationHelperContentHandler;
 
 /**
- * Abstract base class for XML-writing {@code IFDocumentHandler} implementations.
+ * Abstract base class for XML-writing {@link IFDocumentHandler} implementations.
  */
 public abstract class AbstractXMLWritingIFDocumentHandler extends AbstractIFDocumentHandler {
 
index f13139bdbba040c91e450093d8ee9b135dae97db..bc44a255da1625d2bf16c41476bc63606df6996f 100644 (file)
@@ -28,7 +28,7 @@ import org.apache.batik.parser.TransformListHandler;
 import org.apache.batik.parser.TransformListParser;
 
 /**
- * This class parses a sequence of transformations into an array of {@code AffineTransform}
+ * This class parses a sequence of transformations into an array of {@link AffineTransform}
  * instances.
  */
 public class AffineTransformArrayParser implements TransformListHandler {
index cbd6798dafa2e475fef1052bd6cf2fd21e96136f..a0065d655ea9af8f57ab1d6a340977d07760514a 100644 (file)
@@ -29,8 +29,8 @@ import org.xml.sax.ext.LexicalHandler;
 import org.apache.fop.util.DelegatingContentHandler;
 
 /**
- * This class is a {@code DelegatingContentHandler} subclass which swallows the
- * {@code #startDocument()} and {@code #endDocument()} methods. This is useful for handling
+ * This class is a {@link DelegatingContentHandler} subclass which swallows the
+ * {@link #startDocument()} and {@link #endDocument()} methods. This is useful for handling
  * XML fragments.
  */
 public class DelegatingFragmentContentHandler extends DelegatingContentHandler {
index bfd31b5e2b32d553b20962db064d25ea0f97c86f..af1451fe384020add79c7bc5e1300b722b5f2db6 100644 (file)
@@ -153,8 +153,8 @@ public interface IFDocumentHandler {
 
     /**
      * Indicates the start of the document header. This method is called right after the
-     * {@code #startDocument()} method. Extensions sent to this painter between
-     * {@code #startDocumentHeader()} and {@code #endDocumentHeader()} apply to the document as
+     * {@link #startDocument()} method. Extensions sent to this painter between
+     * {@link #startDocumentHeader()} and {@link #endDocumentHeader()} apply to the document as
      * a whole (like document metadata).
      * @throws IFException if an error occurs while handling this event
      */
@@ -170,7 +170,7 @@ public interface IFDocumentHandler {
     /**
      * Indicates the start of the document trailer. This method is called after the last
      * page sequence. Extensions sent to the painter between
-     * {@code #startDocumentTrailer()} and {@code #endDocumentTrailer()} apply to the document as
+     * {@link #startDocumentTrailer()} and {@link #endDocumentTrailer()} apply to the document as
      * a whole and is used for document-level content that is only known after all pages have
      * been rendered (like named destinations or the bookmark tree).
      * @throws IFException if an error occurs while handling this event
@@ -179,7 +179,7 @@ public interface IFDocumentHandler {
 
     /**
      * Indicates the end of the document trailer. This method is called right before the
-     * {@code #endDocument()} method.
+     * {@link #endDocument()} method.
      * @throws IFException if an error occurs while handling this event
      */
     void endDocumentTrailer() throws IFException;
@@ -226,7 +226,7 @@ public interface IFDocumentHandler {
     void endPageHeader() throws IFException;
 
     /**
-     * Indicates the start of the page content. The method returns an {@code IFPainter} interface
+     * Indicates the start of the page content. The method returns an {@link IFPainter} interface
      * which is used to paint the page contents.
      * @throws IFException if an error occurs while handling this event
      * @return the IFPainter for the page content
@@ -234,8 +234,8 @@ public interface IFDocumentHandler {
     IFPainter startPageContent() throws IFException;
 
     /**
-     * Indicates the end of the page content. Calls to the {@code IFPainter} returned by the
-     * respective {@code #startPageContent()} method are illegal.
+     * Indicates the end of the page content. Calls to the {@link IFPainter} returned by the
+     * respective {@link #startPageContent()} method are illegal.
      * @throws IFException if an error occurs while handling this event
      */
     void endPageContent() throws IFException;
index 633e564a75b72b1192e41d80927aa45edd610a0a..3a42918f331f78e22408840a9836266d3dc28cee 100644 (file)
@@ -23,7 +23,7 @@ import org.apache.fop.apps.FOPException;
 import org.apache.fop.fonts.FontInfo;
 
 /**
- * This interface is implemented by classes that configure an {@code IFDocumentHandler} instance.
+ * This interface is implemented by classes that configure an {@link IFDocumentHandler} instance.
  */
 public interface IFDocumentHandlerConfigurator {
 
@@ -35,7 +35,7 @@ public interface IFDocumentHandlerConfigurator {
     void configure(IFDocumentHandler documentHandler) throws FOPException;
 
     /**
-     * Sets up the {@code FontInfo} object for the IFDocumentHandler.
+     * Sets up the {@link FontInfo} object for the IFDocumentHandler.
      * @param documentHandler the document handler instance
      * @param fontInfo the font info object to set up
      * @throws FOPException if an error occurs while configuring the object
index 6369b02510520f4bf9adc6bc6a25c5d0e5c6041e..00fd74209e4297696a6aea4b9422aee2a0176f88 100644 (file)
@@ -175,7 +175,7 @@ public interface IFPainter {
     void fillRect(Rectangle rect, Paint fill) throws IFException;
 
     /**
-     * Draws a border rectangle. The border segments are specified through {@code BorderProps}
+     * Draws a border rectangle. The border segments are specified through {@link BorderProps}
      * instances.
      * @param rect the rectangle's coordinates and extent
      * @param before the border segment on the before-side (top)
index fb9d54d885515f3a4126a17205cce76e560223cc..38344c364cefbe4094e926cf74a2d6c771648732 100644 (file)
@@ -63,7 +63,7 @@ import org.apache.fop.util.XMLUtil;
 
 /**
  * This is a parser for the intermediate format XML which converts the intermediate file into
- * {@code IFPainter} events.
+ * {@link IFPainter} events.
  */
 public class IFParser implements IFConstants {
 
index e22088824b347d2cf360682ee30e9a2a95a90023..059506dec31c920274d1b6afed986efc3f674c44 100644 (file)
@@ -98,7 +98,7 @@ import org.apache.fop.traits.BorderProps;
 import org.apache.fop.traits.RuleStyle;
 
 /**
- * This renderer implementation is an adapter to the {@code IFPainter} interface. It is used
+ * This renderer implementation is an adapter to the {@link IFPainter} interface. It is used
  * to generate content using FOP's intermediate format.
  */
 public class IFRenderer extends AbstractPathOrientedRenderer {
@@ -165,8 +165,8 @@ public class IFRenderer extends AbstractPathOrientedRenderer {
     }
 
     /**
-     * Sets the {@code IFDocumentHandler} to be used by the {@code IFRenderer}.
-     * @param documentHandler the {@code IFDocumentHandler}
+     * Sets the {@link IFDocumentHandler} to be used by the {@link IFRenderer}.
+     * @param documentHandler the {@link IFDocumentHandler}
      */
     public void setDocumentHandler(IFDocumentHandler documentHandler) {
         this.documentHandler = documentHandler;
@@ -220,7 +220,7 @@ public class IFRenderer extends AbstractPathOrientedRenderer {
     }
 
     /**
-     * Creates a default {@code IFDocumentHandler} when none has been set.
+     * Creates a default {@link IFDocumentHandler} when none has been set.
      * @return the default IFDocumentHandler
      */
     protected IFDocumentHandler createDefaultDocumentHandler() {
index 437648bcccd5dc395733e797c20066b781dd30a9..9551930004c6ffe09808db79b36dae53971e8d10 100644 (file)
@@ -42,7 +42,7 @@ public class IFUtil {
     }
 
     /**
-     * Converts an {@code AffineTransform} instance to an SVG style transform method.
+     * Converts an {@link AffineTransform} instance to an SVG style transform method.
      * @param transform the transformation matrix
      * @param sb the StringBuffer to write the transform method to
      * @return the StringBuffer passed to this method
@@ -73,7 +73,7 @@ public class IFUtil {
     }
 
     /**
-     * Converts an {@code AffineTransform} array to an SVG style transform method sequence.
+     * Converts an {@link AffineTransform} array to an SVG style transform method sequence.
      * @param transforms the transformation matrix array
      * @param sb the StringBuffer to write the transform method sequence to
      * @return the StringBuffer passed to this method
@@ -89,7 +89,7 @@ public class IFUtil {
     }
 
     /**
-     * Converts an {@code AffineTransform} array to an SVG style transform method sequence.
+     * Converts an {@link AffineTransform} array to an SVG style transform method sequence.
      * @param transforms the transformation matrix array
      * @return the formatted array
      */
@@ -98,7 +98,7 @@ public class IFUtil {
     }
 
     /**
-     * Converts an {@code AffineTransform} instance to an SVG style transform method.
+     * Converts an {@link AffineTransform} instance to an SVG style transform method.
      * @param transform the transformation matrix
      * @return the formatted array
      */
index cd0cec0f8d78e73dc7b7e0e9b9b5645bf712618b..c5e0a3f5ca8c5103570f65b9314378d04ad46097 100644 (file)
@@ -36,7 +36,7 @@ import org.apache.fop.traits.RuleStyle;
 import org.apache.fop.util.ColorUtil;
 
 /**
- * Java2D-specific implementation of the {@code BorderPainter}.
+ * Java2D-specific implementation of the {@link BorderPainter}.
  */
 public class Java2DBorderPainter extends BorderPainter {
 
index 3fc1787f431eb0b9b7a36bc12750d31cf9c1bcb1..63dce094d6a3840749be98c6ff909ed17481a32c 100644 (file)
@@ -34,7 +34,7 @@ import org.apache.fop.render.ImageHandler;
 import org.apache.fop.render.RenderingContext;
 
 /**
- * Image handler implementation that paints {@code Graphics2D} image on another {@code Graphics2D}
+ * Image handler implementation that paints {@link Graphics2D} image on another {@link Graphics2D}
  * target.
  */
 public class Java2DImageHandlerGraphics2D implements ImageHandler {
index 80d57fc59478fdc481bb9d5aa15bc64e4a0197f3..c2968411837ac136aaaa3387c1e12b0bd5addb9d 100644 (file)
@@ -36,7 +36,7 @@ import org.apache.fop.render.ImageHandler;
 import org.apache.fop.render.RenderingContext;
 
 /**
- * Image handler implementation that paints {@code RenderedImage} instances on a {@code Graphics2D}
+ * Image handler implementation that paints {@link RenderedImage} instances on a {@link Graphics2D}
  * object.
  */
 public class Java2DImageHandlerRenderedImage implements ImageHandler {
index 55c5b80151dc2a5f82b4fe5ae1e6843eef969836..a2b9c96130b5fe9a04f9a98c4ae74a294bd2b533 100644 (file)
@@ -43,13 +43,14 @@ import org.apache.fop.render.RenderingContext;
 import org.apache.fop.render.intermediate.AbstractIFPainter;
 import org.apache.fop.render.intermediate.IFContext;
 import org.apache.fop.render.intermediate.IFException;
+import org.apache.fop.render.intermediate.IFPainter;
 import org.apache.fop.render.intermediate.IFState;
 import org.apache.fop.traits.BorderProps;
 import org.apache.fop.traits.RuleStyle;
 import org.apache.fop.util.CharUtilities;
 
 /**
- * {@code IFPainter} implementation that paints on a Graphics2D instance.
+ * {@link IFPainter} implementation that paints on a Graphics2D instance.
  */
 public class Java2DPainter extends AbstractIFPainter {
 
@@ -105,7 +106,7 @@ public class Java2DPainter extends AbstractIFPainter {
     }
 
     /**
-     * Returns the associated {@code FontInfo} object.
+     * Returns the associated {@link FontInfo} object.
      * @return the font info
      */
     protected FontInfo getFontInfo() {
index 30f84ba2229893d3bb8f646245734a82113aa183..aa2be78e0c696b6eee117bc9ba1e32547006bc92 100644 (file)
@@ -33,7 +33,7 @@ import org.apache.fop.fonts.FontManager;
 public class Java2DUtil {
 
     /**
-     * Builds a default {@code FontInfo} object for use with output formats using the Java2D
+     * Builds a default {@link FontInfo} object for use with output formats using the Java2D
      * font setup.
      * @param fontInfo the font info object to populate
      * @param userAgent the user agent
index 2ba3582e644aee5d6bb545cf03bca22c937747de..ff0d5c9de857a0a7bd7a740c5a3404650f676378 100644 (file)
@@ -37,6 +37,7 @@ import org.apache.fop.apps.MimeConstants;
 import org.apache.fop.fonts.FontInfo;
 import org.apache.fop.render.intermediate.AbstractBinaryWritingIFDocumentHandler;
 import org.apache.fop.render.intermediate.IFContext;
+import org.apache.fop.render.intermediate.IFDocumentHandler;
 import org.apache.fop.render.intermediate.IFDocumentHandlerConfigurator;
 import org.apache.fop.render.intermediate.IFException;
 import org.apache.fop.render.intermediate.IFPainter;
@@ -45,7 +46,7 @@ import org.apache.fop.render.java2d.Java2DUtil;
 import org.apache.fop.render.pcl.extensions.PCLElementMapping;
 
 /**
- * {@code IFDocumentHandler} implementation that produces PCL 5.
+ * {@link IFDocumentHandler} implementation that produces PCL 5.
  */
 public class PCLDocumentHandler extends AbstractBinaryWritingIFDocumentHandler
             implements PCLConstants {
index ce8c26a6f40c6f52c8231e792b142774c6cbf682..ebfb1829afd45aad6022a350bf8e2aec7fb803c2 100644 (file)
@@ -33,7 +33,7 @@ import org.apache.fop.render.ImageHandler;
 import org.apache.fop.render.RenderingContext;
 
 /**
- * Image handler implementation that paints {@code RenderedImage} instances in PCL.
+ * Image handler implementation that paints {@link RenderedImage} instances in PCL.
  */
 public class PCLImageHandlerRenderedImage implements ImageHandler {
 
index da4f6a656bb57ad3c1702867f8f617c5ac8e4c75..b58b7f4953527ad16d7d6080240cbb394e900220 100644 (file)
@@ -52,6 +52,7 @@ import org.apache.fop.render.RenderingContext;
 import org.apache.fop.render.intermediate.AbstractIFPainter;
 import org.apache.fop.render.intermediate.IFContext;
 import org.apache.fop.render.intermediate.IFException;
+import org.apache.fop.render.intermediate.IFPainter;
 import org.apache.fop.render.intermediate.IFState;
 import org.apache.fop.render.java2d.FontMetricsMapper;
 import org.apache.fop.render.java2d.Java2DPainter;
@@ -60,7 +61,7 @@ import org.apache.fop.traits.RuleStyle;
 import org.apache.fop.util.CharUtilities;
 
 /**
- * {@code IFPainter} implementation that produces PCL 5.
+ * {@link IFPainter} implementation that produces PCL 5.
  */
 public class PCLPainter extends AbstractIFPainter implements PCLConstants {
 
index 9212770fcc43e440242d30bdc1fcc7f989637b43..014b267dd351e9b1f8a3780bcd931a33170de3c3 100644 (file)
@@ -95,7 +95,7 @@ public abstract class PCLRenderingContext extends AbstractRenderingContext {
     public abstract Point2D transformedPoint(int x, int y);
 
     /**
-     * Returns the current {@code GraphicContext} instance.
+     * Returns the current {@link GraphicContext} instance.
      * @return the graphic context
      */
     public abstract GraphicContext getGraphicContext();
index a9b9513d28fd1a8a16a2769d4b4c9e8b77d9b25f..a02a647171fa55729d8357ed9fb7004a72b79458 100644 (file)
@@ -84,7 +84,7 @@ public class PCLRenderingUtil {
     /**
      * Configures the renderer to trade speed for quality if desired. One example here is the way
      * that borders are rendered.
-     * @param mode one of the {@code PCLRenderingMode}.* constants
+     * @param mode one of the {@link PCLRenderingMode}.* constants
      */
     public void setRenderingMode(PCLRenderingMode mode) {
         this.renderingMode = mode;
index 019ec82a0d6a3cfc14466e8a886c0dae2113325b..d1b2e87ddd469564ef06856aaa149c3f9c8487fc 100644 (file)
@@ -32,7 +32,7 @@ import org.apache.fop.traits.RuleStyle;
 import org.apache.fop.util.ColorUtil;
 
 /**
- * PDF-specific implementation of the {@code BorderPainter}.
+ * PDF-specific implementation of the {@link BorderPainter}.
  */
 public class PDFBorderPainter extends BorderPainter {
 
index 45fb7ec5111820e129dda1d8bada682c02fa4ccd..fe5be4a39636de831db5d4aa20c8e194b2e1bd26 100644 (file)
@@ -105,7 +105,7 @@ public class PDFContentGenerator {
     }
 
     /**
-     * Returns the {@code PDFStream} associated with this instance.
+     * Returns the {@link PDFStream} associated with this instance.
      * @return the PDF stream
      */
     public PDFStream getStream() {
@@ -113,7 +113,7 @@ public class PDFContentGenerator {
     }
 
     /**
-     * Returns the {@code PDFState} associated with this instance.
+     * Returns the {@link PDFState} associated with this instance.
      * @return the PDF state
      */
     public PDFPaintingState getState() {
@@ -121,7 +121,7 @@ public class PDFContentGenerator {
     }
 
     /**
-     * Returns the {@code PDFTextUtil} associated with this instance.
+     * Returns the {@link PDFTextUtil} associated with this instance.
      * @return the text utility
      */
     public PDFTextUtil getTextUtil() {
@@ -154,7 +154,7 @@ public class PDFContentGenerator {
     }
 
     /**
-     * Restored the graphics state valid before the previous {@code #saveGraphicsState()}.
+     * Restored the graphics state valid before the previous {@link #saveGraphicsState()}.
      * @param popState true if the state should also be popped, false if only the PDF command
      *           should be issued
      */
index 12f99780bdb3586e2cf6e5afa8cd4944d3588c7e..6f4a338d63aac05f9cc10aabaff64d74c31cde85 100644 (file)
@@ -45,13 +45,14 @@ import org.apache.fop.render.extensions.prepress.PageBoundaries;
 import org.apache.fop.render.extensions.prepress.PageScale;
 import org.apache.fop.render.intermediate.AbstractBinaryWritingIFDocumentHandler;
 import org.apache.fop.render.intermediate.IFContext;
+import org.apache.fop.render.intermediate.IFDocumentHandler;
 import org.apache.fop.render.intermediate.IFDocumentHandlerConfigurator;
 import org.apache.fop.render.intermediate.IFDocumentNavigationHandler;
 import org.apache.fop.render.intermediate.IFException;
 import org.apache.fop.render.intermediate.IFPainter;
 
 /**
- * {@code IFDocumentHandler} implementation that produces PDF.
+ * {@link IFDocumentHandler} implementation that produces PDF.
  */
 public class PDFDocumentHandler extends AbstractBinaryWritingIFDocumentHandler {
 
index 97f62150700fdc4fabe66bed023ca2968f6ddc4b..cddbe9cd12f00c65bf0385e7fcad25efa7a1eb3f 100644 (file)
@@ -34,7 +34,7 @@ import org.apache.fop.traits.RuleStyle;
 import org.apache.fop.util.ColorUtil;
 
 /**
- * PostScript-specific implementation of the {@code BorderPainter}.
+ * PostScript-specific implementation of the {@link BorderPainter}.
  */
 public class PSBorderPainter extends BorderPainter {
 
index 5a6db172a06cb28358b8a31b9e13edf5e7827ed8..d55e0724b0234af859f97563d688b1659c1e958f 100644 (file)
@@ -52,6 +52,7 @@ import org.apache.xmlgraphics.ps.dsc.events.DSCCommentHiResBoundingBox;
 import org.apache.fop.apps.MimeConstants;
 import org.apache.fop.render.intermediate.AbstractBinaryWritingIFDocumentHandler;
 import org.apache.fop.render.intermediate.IFContext;
+import org.apache.fop.render.intermediate.IFDocumentHandler;
 import org.apache.fop.render.intermediate.IFDocumentHandlerConfigurator;
 import org.apache.fop.render.intermediate.IFException;
 import org.apache.fop.render.intermediate.IFPainter;
@@ -61,7 +62,7 @@ import org.apache.fop.render.ps.extensions.PSSetPageDevice;
 import org.apache.fop.render.ps.extensions.PSSetupCode;
 
 /**
- * {@code IFDocumentHandler} implementation that produces PostScript.
+ * {@link IFDocumentHandler} implementation that produces PostScript.
  */
 public class PSDocumentHandler extends AbstractBinaryWritingIFDocumentHandler {
 
index b5fa6a34ee1dfd697e1d5ee2c3ed554189d00a25..696634a489b69872107c6751419d6451f9c174c3 100644 (file)
@@ -206,7 +206,7 @@ public class PSRenderingUtil implements PSConfigurationConstants {
 
     /**
      * Indicates whether the "safe setpagedevice" mode is active.
-     * See {@code #setSafeSetPageDevice(boolean)} for more information.
+     * See {@link #setSafeSetPageDevice(boolean)} for more information.
      * @return true if active
      */
     public boolean isSafeSetPageDevice() {
index 75c06dcc7477ea29d133e7fc5dc958d146f852cf..18fdffaab19cfdb36e39433f0be583273317592a 100644 (file)
@@ -30,7 +30,7 @@ public abstract class TraitEnum implements Serializable {
     /**
      * Constructor to add a new named item.
      * @param name Name of the item.
-     * @param enumValue the {@code Constants}.EN_* value
+     * @param enumValue the {@link Constants}.EN_* value
      */
     protected TraitEnum(String name, int enumValue) {
         this.name = name;
@@ -46,7 +46,7 @@ public abstract class TraitEnum implements Serializable {
     }
 
     /**
-     * Returns the enumeration value (one of {@code Constants}.EN_*).
+     * Returns the enumeration value (one of {@link Constants}.EN_*).
      * @return the enumeration value
      */
     public int getEnumValue() {
index b4d4de0387b167e5cc2ba9feef180066c5fb4a35..d8c3b7361feb6b4ff6dae9fd7ca9e4b156a11ec1 100644 (file)
@@ -24,9 +24,9 @@ import java.text.DecimalFormatSymbols;
 import java.util.Locale;
 
 /**
- * This class provides a cache for {@code DecimalFormat} instance. {@code DecimalFormat} itself
+ * This class provides a cache for {@link DecimalFormat} instance. {@link DecimalFormat} itself
  * is not thread-safe but since FOP needs to format a lot of numbers the same way, it shall
- * be cached in a {@code ThreadLocal}.
+ * be cached in a {@link ThreadLocal}.
  */
 public class DecimalFormatCache {
 
@@ -59,7 +59,7 @@ public class DecimalFormatCache {
     }
 
     /**
-     * Returns a cached {@code DecimalFormat} instance for the given number of decimal digits.
+     * Returns a cached {@link DecimalFormat} instance for the given number of decimal digits.
      * @param dec the number of decimal digits.
      * @return the DecimalFormat instance
      */
index e42bef90e45fd1fe05d5323bfd3bee62e248aa1a..d8fe12c272f8e7424169d5bdd0ac4d8b4ead4105 100644 (file)
@@ -148,7 +148,7 @@ public class XMLUtil implements XMLConstants {
     }
 
     /**
-     * Adds an attribute to a given {@code AttributesImpl} instance.
+     * Adds an attribute to a given {@link AttributesImpl} instance.
      * @param atts the attributes collection
      * @param attribute the attribute to add
      * @param value the attribute's CDATA value
@@ -160,7 +160,7 @@ public class XMLUtil implements XMLConstants {
     }
 
     /**
-     * Adds an attribute to a given {@code AttributesImpl} instance. The attribute will be
+     * Adds an attribute to a given {@link AttributesImpl} instance. The attribute will be
      * added in the default namespace.
      * @param atts the attributes collection
      * @param localName the local name of the attribute
index ae60cf9bc88a5699ba8eebabd9cc6ef85d86942a..6c775f177ddffd93ec61a529a216ec4c82f4a386 100644 (file)
@@ -48,13 +48,14 @@ import org.apache.commons.io.IOUtils;
 import org.apache.fop.render.bitmap.BitmapRendererEventProducer;
 import org.apache.fop.render.bitmap.MultiFileRenderingUtil;
 import org.apache.fop.render.intermediate.DelegatingFragmentContentHandler;
+import org.apache.fop.render.intermediate.IFDocumentHandler;
 import org.apache.fop.render.intermediate.IFException;
 import org.apache.fop.render.intermediate.IFPainter;
 import org.apache.fop.util.GenerationHelperContentHandler;
 import org.apache.fop.util.XMLUtil;
 
 /**
- * {@code IFDocumentHandler} implementation that writes SVG 1.1.
+ * {@link IFDocumentHandler} implementation that writes SVG 1.1.
  */
 public class SVGDocumentHandler extends AbstractSVGDocumentHandler {
 
index 9746fe8ece19bc771448489d39e68964a714f2b7..e5832eba1481d12dd173d3723e29b545d0594f9b 100644 (file)
@@ -27,12 +27,13 @@ import org.xml.sax.SAXException;
 import org.xml.sax.helpers.AttributesImpl;
 
 import org.apache.fop.render.intermediate.IFConstants;
+import org.apache.fop.render.intermediate.IFDocumentHandler;
 import org.apache.fop.render.intermediate.IFException;
 import org.apache.fop.render.intermediate.IFPainter;
 import org.apache.fop.util.XMLUtil;
 
 /**
- * {@code IFDocumentHandler} implementation that writes SVG Print.
+ * {@link IFDocumentHandler} implementation that writes SVG Print.
  */
 public class SVGPrintDocumentHandler extends AbstractSVGDocumentHandler {