From: Jeremias Maerki Date: Thu, 1 Oct 2009 14:48:27 +0000 (+0000) Subject: Some javadoc fixes: @code -> @link X-Git-Tag: fop-1_0~154 X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=babc376fe8ca69531570bf3373c1989fc0ab4cc8;p=xmlgraphics-fop.git Some javadoc fixes: @code -> @link git-svn-id: https://svn.apache.org/repos/asf/xmlgraphics/fop/trunk@820672 13f79535-47bb-0310-9956-ffa450edef68 --- diff --git a/src/java/org/apache/fop/fo/FONode.java b/src/java/org/apache/fop/fo/FONode.java index debb6a4b1..9f18ee6ee 100644 --- a/src/java/org/apache/fop/fo/FONode.java +++ b/src/java/org/apache/fop/fo/FONode.java @@ -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, diff --git a/src/java/org/apache/fop/fonts/FontManager.java b/src/java/org/apache/fop/fonts/FontManager.java index daf0a0cdb..41df6bedd 100644 --- a/src/java/org/apache/fop/fonts/FontManager.java +++ b/src/java/org/apache/fop/fonts/FontManager.java @@ -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 */ diff --git a/src/java/org/apache/fop/layoutmgr/BlockStackingLayoutManager.java b/src/java/org/apache/fop/layoutmgr/BlockStackingLayoutManager.java index 53c529eaa..9a0dbe220 100644 --- a/src/java/org/apache/fop/layoutmgr/BlockStackingLayoutManager.java +++ b/src/java/org/apache/fop/layoutmgr/BlockStackingLayoutManager.java @@ -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() { diff --git a/src/java/org/apache/fop/layoutmgr/KnuthPenalty.java b/src/java/org/apache/fop/layoutmgr/KnuthPenalty.java index 5e44127df..9031b6b64 100644 --- a/src/java/org/apache/fop/layoutmgr/KnuthPenalty.java +++ b/src/java/org/apache/fop/layoutmgr/KnuthPenalty.java @@ -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) ? "-" : ""; diff --git a/src/java/org/apache/fop/render/ImageHandler.java b/src/java/org/apache/fop/render/ImageHandler.java index ec5f576aa..0078e37bd 100644 --- a/src/java/org/apache/fop/render/ImageHandler.java +++ b/src/java/org/apache/fop/render/ImageHandler.java @@ -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 diff --git a/src/java/org/apache/fop/render/ImageHandlerRegistry.java b/src/java/org/apache/fop/render/ImageHandlerRegistry.java index 3a241138a..e878e0dfe 100644 --- a/src/java/org/apache/fop/render/ImageHandlerRegistry.java +++ b/src/java/org/apache/fop/render/ImageHandlerRegistry.java @@ -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 diff --git a/src/java/org/apache/fop/render/PrintRendererConfigurator.java b/src/java/org/apache/fop/render/PrintRendererConfigurator.java index 66618b093..dd7a05067 100644 --- a/src/java/org/apache/fop/render/PrintRendererConfigurator.java +++ b/src/java/org/apache/fop/render/PrintRendererConfigurator.java @@ -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/**/ buildFontList(Configuration cfg, FontResolver fontResolver, diff --git a/src/java/org/apache/fop/render/RendererFactory.java b/src/java/org/apache/fop/render/RendererFactory.java index 3832a0714..febe5a9ea 100644 --- a/src/java/org/apache/fop/render/RendererFactory.java +++ b/src/java/org/apache/fop/render/RendererFactory.java @@ -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() { diff --git a/src/java/org/apache/fop/render/afp/AFPDocumentHandler.java b/src/java/org/apache/fop/render/afp/AFPDocumentHandler.java index 073d43e20..8ccee5b70 100644 --- a/src/java/org/apache/fop/render/afp/AFPDocumentHandler.java +++ b/src/java/org/apache/fop/render/afp/AFPDocumentHandler.java @@ -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 { diff --git a/src/java/org/apache/fop/render/bitmap/AbstractBitmapDocumentHandler.java b/src/java/org/apache/fop/render/bitmap/AbstractBitmapDocumentHandler.java index 88b054fc5..3449ffe7e 100644 --- a/src/java/org/apache/fop/render/bitmap/AbstractBitmapDocumentHandler.java +++ b/src/java/org/apache/fop/render/bitmap/AbstractBitmapDocumentHandler.java @@ -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 { diff --git a/src/java/org/apache/fop/render/bitmap/PNGDocumentHandler.java b/src/java/org/apache/fop/render/bitmap/PNGDocumentHandler.java index 09919f03e..77a024436 100644 --- a/src/java/org/apache/fop/render/bitmap/PNGDocumentHandler.java +++ b/src/java/org/apache/fop/render/bitmap/PNGDocumentHandler.java @@ -20,10 +20,11 @@ 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 { diff --git a/src/java/org/apache/fop/render/bitmap/TIFFDocumentHandler.java b/src/java/org/apache/fop/render/bitmap/TIFFDocumentHandler.java index 46603a3e6..a212d0e9e 100644 --- a/src/java/org/apache/fop/render/bitmap/TIFFDocumentHandler.java +++ b/src/java/org/apache/fop/render/bitmap/TIFFDocumentHandler.java @@ -20,10 +20,11 @@ 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 { diff --git a/src/java/org/apache/fop/render/intermediate/AbstractBinaryWritingIFDocumentHandler.java b/src/java/org/apache/fop/render/intermediate/AbstractBinaryWritingIFDocumentHandler.java index a362d0fb5..cc5406acf 100644 --- a/src/java/org/apache/fop/render/intermediate/AbstractBinaryWritingIFDocumentHandler.java +++ b/src/java/org/apache/fop/render/intermediate/AbstractBinaryWritingIFDocumentHandler.java @@ -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 { diff --git a/src/java/org/apache/fop/render/intermediate/AbstractIFDocumentHandler.java b/src/java/org/apache/fop/render/intermediate/AbstractIFDocumentHandler.java index deefe0b94..cd15a9d72 100644 --- a/src/java/org/apache/fop/render/intermediate/AbstractIFDocumentHandler.java +++ b/src/java/org/apache/fop/render/intermediate/AbstractIFDocumentHandler.java @@ -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 { diff --git a/src/java/org/apache/fop/render/intermediate/AbstractIFDocumentHandlerMaker.java b/src/java/org/apache/fop/render/intermediate/AbstractIFDocumentHandlerMaker.java index 7162a976c..204faad00 100644 --- a/src/java/org/apache/fop/render/intermediate/AbstractIFDocumentHandlerMaker.java +++ b/src/java/org/apache/fop/render/intermediate/AbstractIFDocumentHandlerMaker.java @@ -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 */ diff --git a/src/java/org/apache/fop/render/intermediate/AbstractXMLWritingIFDocumentHandler.java b/src/java/org/apache/fop/render/intermediate/AbstractXMLWritingIFDocumentHandler.java index 98706c09b..be65e1317 100644 --- a/src/java/org/apache/fop/render/intermediate/AbstractXMLWritingIFDocumentHandler.java +++ b/src/java/org/apache/fop/render/intermediate/AbstractXMLWritingIFDocumentHandler.java @@ -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 { diff --git a/src/java/org/apache/fop/render/intermediate/AffineTransformArrayParser.java b/src/java/org/apache/fop/render/intermediate/AffineTransformArrayParser.java index f13139bdb..bc44a255d 100644 --- a/src/java/org/apache/fop/render/intermediate/AffineTransformArrayParser.java +++ b/src/java/org/apache/fop/render/intermediate/AffineTransformArrayParser.java @@ -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 { diff --git a/src/java/org/apache/fop/render/intermediate/DelegatingFragmentContentHandler.java b/src/java/org/apache/fop/render/intermediate/DelegatingFragmentContentHandler.java index cbd6798da..a0065d655 100644 --- a/src/java/org/apache/fop/render/intermediate/DelegatingFragmentContentHandler.java +++ b/src/java/org/apache/fop/render/intermediate/DelegatingFragmentContentHandler.java @@ -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 { diff --git a/src/java/org/apache/fop/render/intermediate/IFDocumentHandler.java b/src/java/org/apache/fop/render/intermediate/IFDocumentHandler.java index bfd31b5e2..af1451fe3 100644 --- a/src/java/org/apache/fop/render/intermediate/IFDocumentHandler.java +++ b/src/java/org/apache/fop/render/intermediate/IFDocumentHandler.java @@ -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; diff --git a/src/java/org/apache/fop/render/intermediate/IFDocumentHandlerConfigurator.java b/src/java/org/apache/fop/render/intermediate/IFDocumentHandlerConfigurator.java index 633e564a7..3a42918f3 100644 --- a/src/java/org/apache/fop/render/intermediate/IFDocumentHandlerConfigurator.java +++ b/src/java/org/apache/fop/render/intermediate/IFDocumentHandlerConfigurator.java @@ -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 diff --git a/src/java/org/apache/fop/render/intermediate/IFPainter.java b/src/java/org/apache/fop/render/intermediate/IFPainter.java index 6369b0251..00fd74209 100644 --- a/src/java/org/apache/fop/render/intermediate/IFPainter.java +++ b/src/java/org/apache/fop/render/intermediate/IFPainter.java @@ -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) diff --git a/src/java/org/apache/fop/render/intermediate/IFParser.java b/src/java/org/apache/fop/render/intermediate/IFParser.java index fb9d54d88..38344c364 100644 --- a/src/java/org/apache/fop/render/intermediate/IFParser.java +++ b/src/java/org/apache/fop/render/intermediate/IFParser.java @@ -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 { diff --git a/src/java/org/apache/fop/render/intermediate/IFRenderer.java b/src/java/org/apache/fop/render/intermediate/IFRenderer.java index e22088824..059506dec 100644 --- a/src/java/org/apache/fop/render/intermediate/IFRenderer.java +++ b/src/java/org/apache/fop/render/intermediate/IFRenderer.java @@ -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() { diff --git a/src/java/org/apache/fop/render/intermediate/IFUtil.java b/src/java/org/apache/fop/render/intermediate/IFUtil.java index 437648bcc..955193000 100644 --- a/src/java/org/apache/fop/render/intermediate/IFUtil.java +++ b/src/java/org/apache/fop/render/intermediate/IFUtil.java @@ -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 */ diff --git a/src/java/org/apache/fop/render/java2d/Java2DBorderPainter.java b/src/java/org/apache/fop/render/java2d/Java2DBorderPainter.java index cd0cec0f8..c5e0a3f5c 100644 --- a/src/java/org/apache/fop/render/java2d/Java2DBorderPainter.java +++ b/src/java/org/apache/fop/render/java2d/Java2DBorderPainter.java @@ -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 { diff --git a/src/java/org/apache/fop/render/java2d/Java2DImageHandlerGraphics2D.java b/src/java/org/apache/fop/render/java2d/Java2DImageHandlerGraphics2D.java index 3fc1787f4..63dce094d 100644 --- a/src/java/org/apache/fop/render/java2d/Java2DImageHandlerGraphics2D.java +++ b/src/java/org/apache/fop/render/java2d/Java2DImageHandlerGraphics2D.java @@ -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 { diff --git a/src/java/org/apache/fop/render/java2d/Java2DImageHandlerRenderedImage.java b/src/java/org/apache/fop/render/java2d/Java2DImageHandlerRenderedImage.java index 80d57fc59..c29684118 100644 --- a/src/java/org/apache/fop/render/java2d/Java2DImageHandlerRenderedImage.java +++ b/src/java/org/apache/fop/render/java2d/Java2DImageHandlerRenderedImage.java @@ -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 { diff --git a/src/java/org/apache/fop/render/java2d/Java2DPainter.java b/src/java/org/apache/fop/render/java2d/Java2DPainter.java index 55c5b8015..a2b9c9613 100644 --- a/src/java/org/apache/fop/render/java2d/Java2DPainter.java +++ b/src/java/org/apache/fop/render/java2d/Java2DPainter.java @@ -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() { diff --git a/src/java/org/apache/fop/render/java2d/Java2DUtil.java b/src/java/org/apache/fop/render/java2d/Java2DUtil.java index 30f84ba22..aa2be78e0 100644 --- a/src/java/org/apache/fop/render/java2d/Java2DUtil.java +++ b/src/java/org/apache/fop/render/java2d/Java2DUtil.java @@ -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 diff --git a/src/java/org/apache/fop/render/pcl/PCLDocumentHandler.java b/src/java/org/apache/fop/render/pcl/PCLDocumentHandler.java index 2ba3582e6..ff0d5c9de 100644 --- a/src/java/org/apache/fop/render/pcl/PCLDocumentHandler.java +++ b/src/java/org/apache/fop/render/pcl/PCLDocumentHandler.java @@ -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 { diff --git a/src/java/org/apache/fop/render/pcl/PCLImageHandlerRenderedImage.java b/src/java/org/apache/fop/render/pcl/PCLImageHandlerRenderedImage.java index ce8c26a6f..ebfb1829a 100644 --- a/src/java/org/apache/fop/render/pcl/PCLImageHandlerRenderedImage.java +++ b/src/java/org/apache/fop/render/pcl/PCLImageHandlerRenderedImage.java @@ -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 { diff --git a/src/java/org/apache/fop/render/pcl/PCLPainter.java b/src/java/org/apache/fop/render/pcl/PCLPainter.java index da4f6a656..b58b7f495 100644 --- a/src/java/org/apache/fop/render/pcl/PCLPainter.java +++ b/src/java/org/apache/fop/render/pcl/PCLPainter.java @@ -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 { diff --git a/src/java/org/apache/fop/render/pcl/PCLRenderingContext.java b/src/java/org/apache/fop/render/pcl/PCLRenderingContext.java index 9212770fc..014b267dd 100644 --- a/src/java/org/apache/fop/render/pcl/PCLRenderingContext.java +++ b/src/java/org/apache/fop/render/pcl/PCLRenderingContext.java @@ -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(); diff --git a/src/java/org/apache/fop/render/pcl/PCLRenderingUtil.java b/src/java/org/apache/fop/render/pcl/PCLRenderingUtil.java index a9b9513d2..a02a64717 100644 --- a/src/java/org/apache/fop/render/pcl/PCLRenderingUtil.java +++ b/src/java/org/apache/fop/render/pcl/PCLRenderingUtil.java @@ -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; diff --git a/src/java/org/apache/fop/render/pdf/PDFBorderPainter.java b/src/java/org/apache/fop/render/pdf/PDFBorderPainter.java index 019ec82a0..d1b2e87dd 100644 --- a/src/java/org/apache/fop/render/pdf/PDFBorderPainter.java +++ b/src/java/org/apache/fop/render/pdf/PDFBorderPainter.java @@ -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 { diff --git a/src/java/org/apache/fop/render/pdf/PDFContentGenerator.java b/src/java/org/apache/fop/render/pdf/PDFContentGenerator.java index 45fb7ec51..fe5be4a39 100644 --- a/src/java/org/apache/fop/render/pdf/PDFContentGenerator.java +++ b/src/java/org/apache/fop/render/pdf/PDFContentGenerator.java @@ -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 */ diff --git a/src/java/org/apache/fop/render/pdf/PDFDocumentHandler.java b/src/java/org/apache/fop/render/pdf/PDFDocumentHandler.java index 12f99780b..6f4a338d6 100644 --- a/src/java/org/apache/fop/render/pdf/PDFDocumentHandler.java +++ b/src/java/org/apache/fop/render/pdf/PDFDocumentHandler.java @@ -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 { diff --git a/src/java/org/apache/fop/render/ps/PSBorderPainter.java b/src/java/org/apache/fop/render/ps/PSBorderPainter.java index 97f621507..cddbe9cd1 100644 --- a/src/java/org/apache/fop/render/ps/PSBorderPainter.java +++ b/src/java/org/apache/fop/render/ps/PSBorderPainter.java @@ -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 { diff --git a/src/java/org/apache/fop/render/ps/PSDocumentHandler.java b/src/java/org/apache/fop/render/ps/PSDocumentHandler.java index 5a6db172a..d55e0724b 100644 --- a/src/java/org/apache/fop/render/ps/PSDocumentHandler.java +++ b/src/java/org/apache/fop/render/ps/PSDocumentHandler.java @@ -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 { diff --git a/src/java/org/apache/fop/render/ps/PSRenderingUtil.java b/src/java/org/apache/fop/render/ps/PSRenderingUtil.java index b5fa6a34e..696634a48 100644 --- a/src/java/org/apache/fop/render/ps/PSRenderingUtil.java +++ b/src/java/org/apache/fop/render/ps/PSRenderingUtil.java @@ -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() { diff --git a/src/java/org/apache/fop/traits/TraitEnum.java b/src/java/org/apache/fop/traits/TraitEnum.java index 75c06dcc7..18fdffaab 100644 --- a/src/java/org/apache/fop/traits/TraitEnum.java +++ b/src/java/org/apache/fop/traits/TraitEnum.java @@ -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() { diff --git a/src/java/org/apache/fop/util/DecimalFormatCache.java b/src/java/org/apache/fop/util/DecimalFormatCache.java index b4d4de038..d8c3b7361 100644 --- a/src/java/org/apache/fop/util/DecimalFormatCache.java +++ b/src/java/org/apache/fop/util/DecimalFormatCache.java @@ -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 */ diff --git a/src/java/org/apache/fop/util/XMLUtil.java b/src/java/org/apache/fop/util/XMLUtil.java index e42bef90e..d8fe12c27 100644 --- a/src/java/org/apache/fop/util/XMLUtil.java +++ b/src/java/org/apache/fop/util/XMLUtil.java @@ -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 diff --git a/src/sandbox/org/apache/fop/render/svg/SVGDocumentHandler.java b/src/sandbox/org/apache/fop/render/svg/SVGDocumentHandler.java index ae60cf9bc..6c775f177 100644 --- a/src/sandbox/org/apache/fop/render/svg/SVGDocumentHandler.java +++ b/src/sandbox/org/apache/fop/render/svg/SVGDocumentHandler.java @@ -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 { diff --git a/src/sandbox/org/apache/fop/render/svg/SVGPrintDocumentHandler.java b/src/sandbox/org/apache/fop/render/svg/SVGPrintDocumentHandler.java index 9746fe8ec..e5832eba1 100644 --- a/src/sandbox/org/apache/fop/render/svg/SVGPrintDocumentHandler.java +++ b/src/sandbox/org/apache/fop/render/svg/SVGPrintDocumentHandler.java @@ -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 {