diff options
Diffstat (limited to 'src/java/org')
432 files changed, 1724 insertions, 1993 deletions
diff --git a/src/java/org/apache/fop/apps/FOUserAgent.java b/src/java/org/apache/fop/apps/FOUserAgent.java index c30976e13..07928fef2 100644 --- a/src/java/org/apache/fop/apps/FOUserAgent.java +++ b/src/java/org/apache/fop/apps/FOUserAgent.java @@ -524,7 +524,6 @@ public class FOUserAgent { * messages. * * @param enableLocator <code>false</code> if SAX Locators should be disabled - * @return true if context information should be stored on each node in the FO tree. */ public void setLocatorEnabled(boolean enableLocator) { locatorEnabled = enableLocator; diff --git a/src/java/org/apache/fop/apps/FopFactory.java b/src/java/org/apache/fop/apps/FopFactory.java index 99af1671a..c87a3041b 100644 --- a/src/java/org/apache/fop/apps/FopFactory.java +++ b/src/java/org/apache/fop/apps/FopFactory.java @@ -405,7 +405,7 @@ public class FopFactory { /** * Sets the URI Resolver. It is used for resolving factory-level URIs like hyphenation * patterns and as backup for URI resolution performed during a rendering run. - * @param resolver the new URI resolver + * @param uriResolver the new URI resolver */ public void setURIResolver(URIResolver uriResolver) { foURIResolver.setCustomURIResolver(uriResolver); diff --git a/src/java/org/apache/fop/area/Area.java b/src/java/org/apache/fop/area/Area.java index d9257e2cd..73b167b99 100644 --- a/src/java/org/apache/fop/area/Area.java +++ b/src/java/org/apache/fop/area/Area.java @@ -457,7 +457,7 @@ public class Area extends AreaTreeObject implements Serializable { } /** - * @see java.lang.Object#toString() + * {@inheritDoc} * @return ipd and bpd of area * */ public String toString() { diff --git a/src/java/org/apache/fop/area/AreaTreeHandler.java b/src/java/org/apache/fop/area/AreaTreeHandler.java index 6903510d0..be06aabfc 100644 --- a/src/java/org/apache/fop/area/AreaTreeHandler.java +++ b/src/java/org/apache/fop/area/AreaTreeHandler.java @@ -189,7 +189,7 @@ public class AreaTreeHandler extends FOEventHandler { } /** - * @see org.apache.fop.fo.FOEventHandler + * {@inheritDoc} * @param pageSequence * is the pageSequence being started */ diff --git a/src/java/org/apache/fop/area/AreaTreeParser.java b/src/java/org/apache/fop/area/AreaTreeParser.java index ba819621e..aa499338b 100644 --- a/src/java/org/apache/fop/area/AreaTreeParser.java +++ b/src/java/org/apache/fop/area/AreaTreeParser.java @@ -224,7 +224,7 @@ public class AreaTreeParser { return (Viewport)findAreaType(Viewport.class); } - /** @see org.xml.sax.helpers.DefaultHandler */ + /** {@inheritDoc} */ public void startElement(String uri, String localName, String qName, Attributes attributes) throws SAXException { if (delegate != null) { @@ -288,7 +288,7 @@ public class AreaTreeParser { } } - /** @see org.xml.sax.helpers.DefaultHandler */ + /** {@inheritDoc} */ public void endElement(String uri, String localName, String qName) throws SAXException { if (delegate != null) { delegate.endElement(uri, localName, qName); @@ -1131,7 +1131,7 @@ public class AreaTreeParser { } } - /** @see org.xml.sax.ContentHandler#characters(char[], int, int) */ + /** {@inheritDoc} */ public void characters(char[] ch, int start, int length) throws SAXException { if (delegate != null) { delegate.characters(ch, start, length); diff --git a/src/java/org/apache/fop/area/BeforeFloat.java b/src/java/org/apache/fop/area/BeforeFloat.java index 23883f133..9fc048af1 100644 --- a/src/java/org/apache/fop/area/BeforeFloat.java +++ b/src/java/org/apache/fop/area/BeforeFloat.java @@ -62,7 +62,7 @@ public class BeforeFloat extends BlockParent { return h; } - /** @see org.apache.fop.area.BlockParent#isEmpty() */ + /** {@inheritDoc} */ public boolean isEmpty() { return true; // before floats are not yet implemented } diff --git a/src/java/org/apache/fop/area/BlockParent.java b/src/java/org/apache/fop/area/BlockParent.java index 626b18ae5..caca5befc 100644 --- a/src/java/org/apache/fop/area/BlockParent.java +++ b/src/java/org/apache/fop/area/BlockParent.java @@ -53,7 +53,7 @@ public class BlockParent extends Area { // orientation if reference area private int orientation = ORIENT_0; - /** @see org.apache.fop.area.Area#addChildArea(org.apache.fop.area.Area) */ + /** {@inheritDoc} */ public void addChildArea(Area childArea) { if (children == null) { children = new ArrayList(); diff --git a/src/java/org/apache/fop/area/BookmarkData.java b/src/java/org/apache/fop/area/BookmarkData.java index 2ad8273a9..30bd704b1 100644 --- a/src/java/org/apache/fop/area/BookmarkData.java +++ b/src/java/org/apache/fop/area/BookmarkData.java @@ -194,7 +194,7 @@ public class BookmarkData extends AbstractOffDocumentItem implements Resolvable } /** - * @see org.apache.fop.area.Resolvable#getIDRefs() + * {@inheritDoc} */ public String[] getIDRefs() { return (String[])unresolvedIDRefs.keySet().toArray(new String[] {}); @@ -206,7 +206,7 @@ public class BookmarkData extends AbstractOffDocumentItem implements Resolvable * resolves id references of child elements that have the same * id reference. * - * @see org.apache.fop.area.Resolvable#resolveIDRef(String, List) + * {@inheritDoc} List) * @todo check to make sure it works if multiple bookmark-items * have the same idref */ @@ -225,7 +225,7 @@ public class BookmarkData extends AbstractOffDocumentItem implements Resolvable } /** - * @see org.apache.fop.area.OffDocumentItem#getName() + * {@inheritDoc} */ public String getName() { return "Bookmarks"; diff --git a/src/java/org/apache/fop/area/CachedRenderPagesModel.java b/src/java/org/apache/fop/area/CachedRenderPagesModel.java index 4d4237078..363fa02d1 100644 --- a/src/java/org/apache/fop/area/CachedRenderPagesModel.java +++ b/src/java/org/apache/fop/area/CachedRenderPagesModel.java @@ -65,7 +65,7 @@ public class CachedRenderPagesModel extends RenderPagesModel { } /** - * @see org.apache.fop.area.RenderPagesModel#checkPreparedPages(PageViewport, boolean) + * {@inheritDoc} */ protected boolean checkPreparedPages(PageViewport newpage, boolean renderUnresolved) { for (Iterator iter = prepared.iterator(); iter.hasNext();) { @@ -152,7 +152,7 @@ public class CachedRenderPagesModel extends RenderPagesModel { } } - /** @see org.apache.fop.area.RenderPagesModel#endDocument() */ + /** {@inheritDoc} */ public void endDocument() throws SAXException { super.endDocument(); } diff --git a/src/java/org/apache/fop/area/DestinationData.java b/src/java/org/apache/fop/area/DestinationData.java index 6b873ef84..b23605972 100644 --- a/src/java/org/apache/fop/area/DestinationData.java +++ b/src/java/org/apache/fop/area/DestinationData.java @@ -60,7 +60,7 @@ public class DestinationData extends AbstractOffDocumentItem implements Resolvab } /** - * @see org.apache.fop.area.Resolvable#getIDRefs() + * {@inheritDoc} */ public String[] getIDRefs() { return idRefs; @@ -90,7 +90,7 @@ public class DestinationData extends AbstractOffDocumentItem implements Resolvab * Resolves the idref of this object by getting the PageViewport * object that corresponds to the IDRef * - * @see org.apache.fop.area.Resolvable#resolveIDRef(String, List) + * {@inheritDoc} List) * @todo check to make sure it works if multiple bookmark-items * have the same idref */ @@ -100,7 +100,7 @@ public class DestinationData extends AbstractOffDocumentItem implements Resolvab } /** - * @see org.apache.fop.area.OffDocumentItem#getName() + * {@inheritDoc} */ public String getName() { return "Destination"; diff --git a/src/java/org/apache/fop/area/LinkResolver.java b/src/java/org/apache/fop/area/LinkResolver.java index 0b0441bd2..0fdd4ba4c 100644 --- a/src/java/org/apache/fop/area/LinkResolver.java +++ b/src/java/org/apache/fop/area/LinkResolver.java @@ -67,7 +67,7 @@ public class LinkResolver implements Resolvable, Serializable { /** * Resolve by adding an internal link to the first PageViewport in the list. * - * @see org.apache.fop.area.Resolvable#resolveIDRef(String, List) + * {@inheritDoc} */ public void resolveIDRef(String id, List pages) { resolveIDRef(id, (PageViewport)pages.get(0)); diff --git a/src/java/org/apache/fop/area/NormalFlow.java b/src/java/org/apache/fop/area/NormalFlow.java index e927122c9..715a61cb0 100644 --- a/src/java/org/apache/fop/area/NormalFlow.java +++ b/src/java/org/apache/fop/area/NormalFlow.java @@ -34,7 +34,7 @@ public class NormalFlow extends BlockParent { setIPD(ipd); } - /** @see org.apache.fop.area.BlockParent#addBlock(org.apache.fop.area.Block) */ + /** {@inheritDoc} */ public void addBlock(Block block) { super.addBlock(block); bpd += block.getAllocBPD(); diff --git a/src/java/org/apache/fop/area/OffDocumentExtensionAttachment.java b/src/java/org/apache/fop/area/OffDocumentExtensionAttachment.java index cd75e203b..7fd811d45 100644 --- a/src/java/org/apache/fop/area/OffDocumentExtensionAttachment.java +++ b/src/java/org/apache/fop/area/OffDocumentExtensionAttachment.java @@ -43,12 +43,12 @@ public class OffDocumentExtensionAttachment implements OffDocumentItem { return this.attachment; } - /** @see org.apache.fop.area.OffDocumentItem#getWhenToProcess() */ + /** {@inheritDoc} */ public int getWhenToProcess() { return OffDocumentItem.IMMEDIATELY; } - /** @see org.apache.fop.area.OffDocumentItem#getName() */ + /** {@inheritDoc} */ public String getName() { return attachment.getCategory(); } diff --git a/src/java/org/apache/fop/area/PageViewport.java b/src/java/org/apache/fop/area/PageViewport.java index 953cb3840..184eb9d32 100644 --- a/src/java/org/apache/fop/area/PageViewport.java +++ b/src/java/org/apache/fop/area/PageViewport.java @@ -304,7 +304,7 @@ public class PageViewport extends AreaTreeObject implements Resolvable, Cloneabl } /** - * @see org.apache.fop.area.Resolvable#resolveIDRef(String, List) + * {@inheritDoc} */ public void resolveIDRef(String id, List pages) { if (page == null) { @@ -565,7 +565,7 @@ public class PageViewport extends AreaTreeObject implements Resolvable, Cloneabl } /** - * @see java.lang.Object#toString() + * {@inheritDoc} */ public String toString() { StringBuffer sb = new StringBuffer(64); diff --git a/src/java/org/apache/fop/area/RegionReference.java b/src/java/org/apache/fop/area/RegionReference.java index 00b51263d..c41de7c7a 100644 --- a/src/java/org/apache/fop/area/RegionReference.java +++ b/src/java/org/apache/fop/area/RegionReference.java @@ -68,7 +68,7 @@ public class RegionReference extends Area implements Cloneable { regionViewport = parent; } - /** @see org.apache.fop.area.Area#addChildArea(org.apache.fop.area.Area) */ + /** {@inheritDoc} */ public void addChildArea(Area child) { blocks.add(child); } diff --git a/src/java/org/apache/fop/area/RenderPagesModel.java b/src/java/org/apache/fop/area/RenderPagesModel.java index b8dc28a6f..81ffac746 100644 --- a/src/java/org/apache/fop/area/RenderPagesModel.java +++ b/src/java/org/apache/fop/area/RenderPagesModel.java @@ -204,7 +204,7 @@ public class RenderPagesModel extends AreaTreeModel { } /** - * @see org.apache.fop.area.AreaTreeModel#handleOffDocumentItem(OffDocumentItem) + * {@inheritDoc} */ public void handleOffDocumentItem(OffDocumentItem oDI) { switch(oDI.getWhenToProcess()) { @@ -231,7 +231,7 @@ public class RenderPagesModel extends AreaTreeModel { /** * End the document. Render any end document OffDocumentItems - * @see org.apache.fop.area.AreaTreeModel#endDocument() + * {@inheritDoc} */ public void endDocument() throws SAXException { // render any pages that had unresolved ids diff --git a/src/java/org/apache/fop/area/Span.java b/src/java/org/apache/fop/area/Span.java index 401adda64..cf9dd3c42 100644 --- a/src/java/org/apache/fop/area/Span.java +++ b/src/java/org/apache/fop/area/Span.java @@ -180,7 +180,7 @@ public class Span extends Area { return (areaCount == 0); } - /** @see java.lang.Object#toString() */ + /** {@inheritDoc} */ public String toString() { StringBuffer sb = new StringBuffer(super.toString()); if (colCount > 1) { diff --git a/src/java/org/apache/fop/area/Trait.java b/src/java/org/apache/fop/area/Trait.java index fb7065e77..b3c3d3947 100644 --- a/src/java/org/apache/fop/area/Trait.java +++ b/src/java/org/apache/fop/area/Trait.java @@ -365,7 +365,7 @@ public class Trait implements Serializable { /** * Return the string for debugging. - * @see java.lang.Object#toString() + * {@inheritDoc} */ public String toString() { return data.toString(); @@ -536,7 +536,7 @@ public class Trait implements Serializable { /** * Return the human-friendly string for debugging. - * @see java.lang.Object#toString() + * {@inheritDoc} */ public String toString() { StringBuffer sb = new StringBuffer(); @@ -700,7 +700,7 @@ public class Trait implements Serializable { /** * Return the string for debugging. - * @see java.lang.Object#toString() + * {@inheritDoc} */ public String toString() { StringBuffer sb = new StringBuffer(); diff --git a/src/java/org/apache/fop/area/inline/FilledArea.java b/src/java/org/apache/fop/area/inline/FilledArea.java index a111e7f89..02d9b4820 100644 --- a/src/java/org/apache/fop/area/inline/FilledArea.java +++ b/src/java/org/apache/fop/area/inline/FilledArea.java @@ -86,7 +86,7 @@ public class FilledArea extends InlineParent { } /** - * @see org.apache.fop.area.Area#getBPD + * {@inheritDoc} */ public int getBPD() { int bpd = 0; diff --git a/src/java/org/apache/fop/area/inline/InlineArea.java b/src/java/org/apache/fop/area/inline/InlineArea.java index d4f834441..0655cabe4 100644 --- a/src/java/org/apache/fop/area/inline/InlineArea.java +++ b/src/java/org/apache/fop/area/inline/InlineArea.java @@ -104,7 +104,7 @@ public class InlineArea extends Area { * Create a new adjustment information object * @param stretch the available space for stretching * @param shrink the available space for shrinking - * @param adj space adjustment type + * @param adjustment space adjustment type */ public void setAdjustingInfo(int stretch, int shrink, int adjustment) { adjustingInfo = new InlineAdjustingInfo(stretch, shrink, adjustment); @@ -169,7 +169,7 @@ public class InlineArea extends Area { /** * Set the parent for the child area. * - * @see org.apache.fop.area.Area#addChildArea(Area) + * {@inheritDoc} */ public void addChildArea(Area childArea) { super.addChildArea(childArea); diff --git a/src/java/org/apache/fop/cli/AreaTreeInputHandler.java b/src/java/org/apache/fop/cli/AreaTreeInputHandler.java index 4662a0ebc..b32cfcacd 100644 --- a/src/java/org/apache/fop/cli/AreaTreeInputHandler.java +++ b/src/java/org/apache/fop/cli/AreaTreeInputHandler.java @@ -58,7 +58,7 @@ public class AreaTreeInputHandler extends InputHandler { super(atfile); } - /** @see org.apache.fop.cli.InputHandler */ + /** {@inheritDoc} */ public void renderTo(FOUserAgent userAgent, String outputFormat, OutputStream out) throws FOPException { FontInfo fontInfo = new FontInfo(); diff --git a/src/java/org/apache/fop/cli/InputHandler.java b/src/java/org/apache/fop/cli/InputHandler.java index bdf4f6a6a..bfbce269d 100644 --- a/src/java/org/apache/fop/cli/InputHandler.java +++ b/src/java/org/apache/fop/cli/InputHandler.java @@ -115,7 +115,7 @@ public class InputHandler implements ErrorListener, Renderable { transformTo(res); } - /** @see org.apache.fop.render.awt.viewer.Renderable */ + /** {@inheritDoc} */ public void renderTo(FOUserAgent userAgent, String outputFormat) throws FOPException { renderTo(userAgent, outputFormat, null); } @@ -172,21 +172,21 @@ public class InputHandler implements ErrorListener, Renderable { // --- Implementation of the ErrorListener interface --- /** - * @see javax.xml.transform.ErrorListener#warning(javax.xml.transform.TransformerException) + * {@inheritDoc} */ public void warning(TransformerException exc) { log.warn(exc.toString()); } /** - * @see javax.xml.transform.ErrorListener#error(javax.xml.transform.TransformerException) + * {@inheritDoc} */ public void error(TransformerException exc) { log.error(exc.toString()); } /** - * @see javax.xml.transform.ErrorListener#fatalError(javax.xml.transform.TransformerException) + * {@inheritDoc} */ public void fatalError(TransformerException exc) throws TransformerException { diff --git a/src/java/org/apache/fop/datatypes/LengthBase.java b/src/java/org/apache/fop/datatypes/LengthBase.java index 74150ca50..a06f7f746 100644 --- a/src/java/org/apache/fop/datatypes/LengthBase.java +++ b/src/java/org/apache/fop/datatypes/LengthBase.java @@ -83,7 +83,6 @@ public class LengthBase implements PercentBase { /** * Constructor - * @param parentFO parent FO for this * @param plist property list for this * @param baseType a constant defining the type of teh percent base * @throws PropertyException In case an problem occurs while evaluating values @@ -120,7 +119,7 @@ public class LengthBase implements PercentBase { } /** - * @see org.apache.fop.datatypes.PercentBase#getBaseLength(PercentBaseContext) + * {@inheritDoc} */ public int getBaseLength(PercentBaseContext context) throws PropertyException { int baseLen = 0; diff --git a/src/java/org/apache/fop/datatypes/SimplePercentBaseContext.java b/src/java/org/apache/fop/datatypes/SimplePercentBaseContext.java index e755f45ea..3b3c87525 100644 --- a/src/java/org/apache/fop/datatypes/SimplePercentBaseContext.java +++ b/src/java/org/apache/fop/datatypes/SimplePercentBaseContext.java @@ -46,7 +46,7 @@ public class SimplePercentBaseContext implements PercentBaseContext { /** * Returns the value for the given lengthBase. - * @see org.apache.fop.datatypes.PercentBaseContext#getBaseLength(int, FObj) + * {@inheritDoc} */ public int getBaseLength(int lengthBase, FObj fobj) { // if its for us return our value otherwise delegate to parent context diff --git a/src/java/org/apache/fop/datatypes/ValidationPercentBaseContext.java b/src/java/org/apache/fop/datatypes/ValidationPercentBaseContext.java index c9db5d524..6301c4d85 100644 --- a/src/java/org/apache/fop/datatypes/ValidationPercentBaseContext.java +++ b/src/java/org/apache/fop/datatypes/ValidationPercentBaseContext.java @@ -39,7 +39,7 @@ public final class ValidationPercentBaseContext implements PercentBaseContext { /** * Returns the value for the given lengthBase. - * @see org.apache.fop.datatypes.PercentBaseContext#getBaseLength(int, FObj) + * {@inheritDoc} */ public int getBaseLength(int lengthBase, FObj fobj) { //Simply return a dummy value which produces a non-zero value when a non-zero percentage diff --git a/src/java/org/apache/fop/fo/CharIterator.java b/src/java/org/apache/fop/fo/CharIterator.java index fae2743f3..1d6b312a7 100644 --- a/src/java/org/apache/fop/fo/CharIterator.java +++ b/src/java/org/apache/fop/fo/CharIterator.java @@ -30,7 +30,7 @@ import java.util.NoSuchElementException; public abstract class CharIterator implements Iterator, Cloneable { /** - * @see java.util.Iterator#hasNext() + * {@inheritDoc} */ public abstract boolean hasNext(); @@ -42,14 +42,14 @@ public abstract class CharIterator implements Iterator, Cloneable { public abstract char nextChar() throws NoSuchElementException; /** - * @see java.util.Iterator#next() + * {@inheritDoc} */ public Object next() throws NoSuchElementException { return new Character(nextChar()); } /** - * @see java.util.Iterator#remove() + * {@inheritDoc} */ public void remove() { throw new UnsupportedOperationException(); @@ -65,7 +65,7 @@ public abstract class CharIterator implements Iterator, Cloneable { } /** - * @see java.lang.Object#clone() + * {@inheritDoc} */ public Object clone() { try { diff --git a/src/java/org/apache/fop/fo/FOElementMapping.java b/src/java/org/apache/fop/fo/FOElementMapping.java index c3b99f6e4..f316e5a8d 100644 --- a/src/java/org/apache/fop/fo/FOElementMapping.java +++ b/src/java/org/apache/fop/fo/FOElementMapping.java @@ -138,12 +138,12 @@ public class FOElementMapping extends ElementMapping { } } - /** @see org.apache.fop.fo.ElementMapping#getStandardPrefix() */ + /** {@inheritDoc} */ public String getStandardPrefix() { return "fo"; } - /** @see org.apache.fop.fo.ElementMapping#isAttributeProperty(org.apache.fop.util.QName) */ + /** {@inheritDoc} */ public boolean isAttributeProperty(QName attributeName) { return true; //All XSL-FO attributes are to be converted to properties. } @@ -513,4 +513,5 @@ public class FOElementMapping extends ElementMapping { return new org.apache.fop.fo.flow.RetrieveMarker(parent); } } + } diff --git a/src/java/org/apache/fop/fo/FONode.java b/src/java/org/apache/fop/fo/FONode.java index a90d564ec..848e06a65 100644 --- a/src/java/org/apache/fop/fo/FONode.java +++ b/src/java/org/apache/fop/fo/FONode.java @@ -91,7 +91,7 @@ public abstract class FONode implements Cloneable { /** * Perform a shallow cloning operation * - * @see java.lang.Object#clone() + * {@inheritDoc} * @return the cloned object */ protected Object clone() { @@ -103,6 +103,20 @@ public abstract class FONode implements Cloneable { } /** + * Bind the given <code>PropertyList</code> to this node + * Does nothing by default. Subclasses should override this method + * in case they want to use the properties available on the + * <code>PropertyList</code>. + * + * @param propertyList the <code>PropertyList</code> + * @throws <code>FOPException</code> if there was an error when + * processing the <code>PropertyList</code> + */ + public void bind(PropertyList propertyList) throws FOPException { + //nop + } + + /** * Set the location information for this element * @param locator the org.xml.sax.Locator object */ diff --git a/src/java/org/apache/fop/fo/FOText.java b/src/java/org/apache/fop/fo/FOText.java index 2205c0170..b2baf58a7 100644 --- a/src/java/org/apache/fop/fo/FOText.java +++ b/src/java/org/apache/fop/fo/FOText.java @@ -122,7 +122,7 @@ public class FOText extends FONode { super(parent); } - /** @see org.apache.fop.fo.FONode */ + /** {@inheritDoc} */ protected void addCharacters(char[] data, int start, int end, PropertyList list, Locator locator) throws FOPException { @@ -142,14 +142,15 @@ public class FOText extends FONode { } /** - * @see org.apache.fop.fo.FONode#clone(FONode, boolean) + * {@inheritDoc} */ public FONode clone(FONode parent, boolean removeChildren) throws FOPException { FOText ft = (FOText) super.clone(parent, removeChildren); if (removeChildren) { //not really removing, but just make sure the char array - //pointed to is really a different one + //pointed to is really a different one, and reset any + //possible whitespace-handling effects if (ca != null) { ft.ca = new char[ca.length]; System.arraycopy(ca, 0, ft.ca, 0, ca.length); @@ -159,7 +160,7 @@ public class FOText extends FONode { } /** - * @see org.apache.fop.fo.FObj#bind(PropertyList) + * {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { commonFont = pList.getFontProps(); @@ -176,7 +177,7 @@ public class FOText extends FONode { baselineShift = pList.get(Constants.PR_BASELINE_SHIFT).getLength(); } - /** @see org.apache.fop.fo.FONode#endOfNode() */ + /** {@inheritDoc} */ protected void endOfNode() throws FOPException { textTransform(); getFOEventHandler().characters(ca, startIndex, endIndex); @@ -600,24 +601,24 @@ public class FOText extends FONode { return baselineShift; } - /** @see java.lang.Object#toString() */ + /** {@inheritDoc} */ public String toString() { StringBuffer sb = new StringBuffer(super.toString()); sb.append(" (").append(ca).append(")"); return sb.toString(); } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return null; } - /** @see org.apache.fop.fo.FONode#getNormalNamespacePrefix() */ + /** {@inheritDoc} */ public String getNormalNamespacePrefix() { return null; } - /** @see org.apache.fop.fo.FONode#gatherContextInfo() */ + /** {@inheritDoc} */ protected String gatherContextInfo() { if (getLocator() != null) { return super.gatherContextInfo(); diff --git a/src/java/org/apache/fop/fo/FOTreeBuilder.java b/src/java/org/apache/fop/fo/FOTreeBuilder.java index 1aa9ce3e2..c4ab4fdc8 100644 --- a/src/java/org/apache/fop/fo/FOTreeBuilder.java +++ b/src/java/org/apache/fop/fo/FOTreeBuilder.java @@ -117,8 +117,7 @@ public class FOTreeBuilder extends DefaultHandler { } /** - * SAX Handler for locator - * @see org.xml.sax.ContentHandler#setDocumentLocator(Locator) + * {@inheritDoc} */ public void setDocumentLocator(Locator locator) { this.locator = locator; @@ -130,8 +129,7 @@ public class FOTreeBuilder extends DefaultHandler { } /** - * SAX Handler for characters - * @see org.xml.sax.ContentHandler#characters(char[], int, int) + * {@inheritDoc} */ public void characters(char[] data, int start, int length) throws SAXException { @@ -139,8 +137,7 @@ public class FOTreeBuilder extends DefaultHandler { } /** - * SAX Handler for the start of the document - * @see org.xml.sax.ContentHandler#startDocument() + * {@inheritDoc} */ public void startDocument() throws SAXException { if (used) { @@ -159,8 +156,7 @@ public class FOTreeBuilder extends DefaultHandler { } /** - * SAX Handler for the end of the document - * @see org.xml.sax.ContentHandler#endDocument() + * {@inheritDoc} */ public void endDocument() throws SAXException { this.delegate.endDocument(); @@ -176,8 +172,7 @@ public class FOTreeBuilder extends DefaultHandler { } /** - * SAX Handler for the start of an element - * @see org.xml.sax.ContentHandler#startElement(String, String, String, Attributes) + * {@inheritDoc} */ public void startElement(String namespaceURI, String localName, String rawName, Attributes attlist) throws SAXException { @@ -186,8 +181,7 @@ public class FOTreeBuilder extends DefaultHandler { } /** - * SAX Handler for the end of an element - * @see org.xml.sax.ContentHandler#endElement(String, String, String) + * {@inheritDoc} */ public void endElement(String uri, String localName, String rawName) throws SAXException { @@ -214,17 +208,17 @@ public class FOTreeBuilder extends DefaultHandler { return elementMappingRegistry.findFOMaker(namespaceURI, localName, locator); } - /** @see org.xml.sax.ErrorHandler#warning(org.xml.sax.SAXParseException) */ + /** {@inheritDoc} */ public void warning(SAXParseException e) { log.warn(e.toString()); } - /** @see org.xml.sax.ErrorHandler#error(org.xml.sax.SAXParseException) */ + /** {@inheritDoc} */ public void error(SAXParseException e) { log.error(e.toString()); } - /** @see org.xml.sax.ErrorHandler#fatalError(org.xml.sax.SAXParseException) */ + /** {@inheritDoc} */ public void fatalError(SAXParseException e) throws SAXException { log.error(e.toString()); throw e; @@ -275,8 +269,7 @@ public class FOTreeBuilder extends DefaultHandler { private int nestedMarkerDepth = 0; /** - * SAX Handler for the start of an element - * @see org.xml.sax.ContentHandler#startElement(String, String, String, Attributes) + * {@inheritDoc} */ public void startElement(String namespaceURI, String localName, String rawName, Attributes attlist) throws SAXException { @@ -358,8 +351,7 @@ public class FOTreeBuilder extends DefaultHandler { } /** - * SAX Handler for the end of an element - * @see org.xml.sax.ContentHandler#endElement(String, String, String) + * {@inheritDoc} */ public void endElement(String uri, String localName, String rawName) throws SAXException { @@ -399,8 +391,7 @@ public class FOTreeBuilder extends DefaultHandler { } /** - * SAX Handler for characters - * @see org.xml.sax.ContentHandler#characters(char[], int, int) + * {@inheritDoc} */ public void characters(char[] data, int start, int length) throws FOPException { diff --git a/src/java/org/apache/fop/fo/FObj.java b/src/java/org/apache/fop/fo/FObj.java index 00fdc3c8b..71849bd72 100644 --- a/src/java/org/apache/fop/fo/FObj.java +++ b/src/java/org/apache/fop/fo/FObj.java @@ -91,7 +91,7 @@ public abstract class FObj extends FONode implements Constants { } /** - * @see org.apache.fop.fo.FONode#clone(FONode, boolean) + * {@inheritDoc} */ public FONode clone(FONode parent, boolean removeChildren) throws FOPException { @@ -112,7 +112,7 @@ public abstract class FObj extends FONode implements Constants { } /** - * @see org.apache.fop.fo.FONode#processNode + * {@inheritDoc} */ public void processNode(String elementName, Locator locator, Attributes attlist, PropertyList pList) @@ -128,7 +128,7 @@ public abstract class FObj extends FONode implements Constants { /** * Create a default property list for this element. - * @see org.apache.fop.fo.FONode + * {@inheritDoc} */ protected PropertyList createPropertyList(PropertyList parent, FOEventHandler foEventHandler) throws FOPException { @@ -147,7 +147,7 @@ public abstract class FObj extends FONode implements Constants { } /** - * @see org.apache.fop.fo.FONode#startOfNode + * {@inheritDoc} * @throws FOPException FOP Exception */ protected void startOfNode() throws FOPException { @@ -203,7 +203,7 @@ public abstract class FObj extends FONode implements Constants { } /** - * @see org.apache.fop.fo.FONode#addChildNode(FONode) + * {@inheritDoc} */ protected void addChildNode(FONode child) throws FOPException { if (canHaveMarkers() && child.getNameId() == FO_MARKER) { @@ -242,7 +242,7 @@ public abstract class FObj extends FONode implements Constants { parent.addChildNode(child); } - /** @see org.apache.fop.fo.FONode#removeChild(org.apache.fop.fo.FONode) */ + /** {@inheritDoc} */ public void removeChild(FONode child) { FONode nextChild = null; if (child.siblings != null) { @@ -284,7 +284,7 @@ public abstract class FObj extends FONode implements Constants { } /** - * @see org.apache.fop.fo.FONode#getChildNodes() + * {@inheritDoc} */ public FONodeIterator getChildNodes() { if (firstChild != null) { @@ -382,7 +382,7 @@ public abstract class FObj extends FONode implements Constants { return markers; } - /** @see org.apache.fop.fo.FONode#gatherContextInfo() */ + /** {@inheritDoc} */ protected String gatherContextInfo() { if (getLocator() != null) { return super.gatherContextInfo(); @@ -513,12 +513,12 @@ public abstract class FObj extends FONode implements Constants { return id != null && id.length() > 0; } - /** @see org.apache.fop.fo.FONode#getNamespaceURI() */ + /** {@inheritDoc} */ public String getNamespaceURI() { return FOElementMapping.URI; } - /** @see org.apache.fop.fo.FONode#getNormalNamespacePrefix() */ + /** {@inheritDoc} */ public String getNormalNamespacePrefix() { return "fo"; } @@ -600,14 +600,14 @@ public abstract class FObj extends FONode implements Constants { } /** - * @see FONodeIterator#parentNode() + * {@inheritDoc} */ public FObj parentNode() { return parentNode; } /** - * @see java.util.ListIterator#next() + * {@inheritDoc} */ public Object next() { if (currentNode != null) { @@ -628,7 +628,7 @@ public abstract class FObj extends FONode implements Constants { } /** - * @see java.util.ListIterator#previous() + * {@inheritDoc} */ public Object previous() { if (currentNode.siblings != null @@ -643,7 +643,7 @@ public abstract class FObj extends FONode implements Constants { } /** - * @see java.util.ListIterator#set(Object) + * {@inheritDoc} */ public void set(Object o) { if ((flags & F_SET_ALLOWED) == F_SET_ALLOWED) { @@ -663,7 +663,7 @@ public abstract class FObj extends FONode implements Constants { } /** - * @see java.util.ListIterator#add(Object) + * {@inheritDoc} */ public void add(Object o) { FONode newNode = (FONode) o; @@ -685,7 +685,7 @@ public abstract class FObj extends FONode implements Constants { } /** - * @see java.util.ListIterator#hasNext() + * {@inheritDoc} */ public boolean hasNext() { return (currentNode != null) @@ -695,7 +695,7 @@ public abstract class FObj extends FONode implements Constants { } /** - * @see java.util.ListIterator#hasPrevious() + * {@inheritDoc} */ public boolean hasPrevious() { return (currentIndex != 0) @@ -704,21 +704,21 @@ public abstract class FObj extends FONode implements Constants { } /** - * @see java.util.ListIterator#nextIndex() + * {@inheritDoc} */ public int nextIndex() { return currentIndex + 1; } /** - * @see java.util.ListIterator#previousIndex() + * {@inheritDoc} */ public int previousIndex() { return currentIndex - 1; } /** - * @see java.util.ListIterator#remove() + * {@inheritDoc} */ public void remove() { if ((flags & F_REMOVE_ALLOWED) == F_REMOVE_ALLOWED) { @@ -739,6 +739,9 @@ public abstract class FObj extends FONode implements Constants { } } + /** + * {@inheritDoc} + */ public FONode lastNode() { while (currentNode != null && currentNode.siblings != null @@ -749,16 +752,25 @@ public abstract class FObj extends FONode implements Constants { return currentNode; } + /** + * {@inheritDoc} + */ public FONode firstNode() { currentNode = parentNode.firstChild; currentIndex = 0; return currentNode; } + /** + * {@inheritDoc} + */ public FONode nextNode() { return (FONode) next(); } + /** + * {@inheritDoc} + */ public FONode previousNode() { return (FONode) previous(); } diff --git a/src/java/org/apache/fop/fo/FObjMixed.java b/src/java/org/apache/fop/fo/FObjMixed.java index 87f31216b..4360c7758 100644 --- a/src/java/org/apache/fop/fo/FObjMixed.java +++ b/src/java/org/apache/fop/fo/FObjMixed.java @@ -47,7 +47,7 @@ public abstract class FObjMixed extends FObj { super(parent); } - /** @see org.apache.fop.fo.FONode */ + /** {@inheritDoc} */ protected void addCharacters(char[] data, int start, int end, PropertyList pList, Locator locator) throws FOPException { @@ -61,7 +61,7 @@ public abstract class FObjMixed extends FObj { ft.addCharacters(data, start, end, null, null); } - /** @see org.apache.fop.fo.FONode#endOfNode() */ + /** {@inheritDoc} */ protected void endOfNode() throws FOPException { flushText(); if (!inMarker() @@ -146,7 +146,7 @@ public abstract class FObjMixed extends FObj { } /** - * @see org.apache.fop.fo.FONode#addChildNode(FONode) + * {@inheritDoc} */ protected void addChildNode(FONode child) throws FOPException { flushText(); diff --git a/src/java/org/apache/fop/fo/NullCharIterator.java b/src/java/org/apache/fop/fo/NullCharIterator.java index 494d167fd..bb98b4a52 100644 --- a/src/java/org/apache/fop/fo/NullCharIterator.java +++ b/src/java/org/apache/fop/fo/NullCharIterator.java @@ -42,12 +42,12 @@ public class NullCharIterator extends CharIterator { //nop } - /** @see java.util.Iterator#hasNext() */ + /** {@inheritDoc} */ public boolean hasNext() { return false; } - /** @see org.apache.fop.fo.CharIterator#nextChar() */ + /** {@inheritDoc} */ public char nextChar() throws NoSuchElementException { throw new NoSuchElementException(); } diff --git a/src/java/org/apache/fop/fo/RecursiveCharIterator.java b/src/java/org/apache/fop/fo/RecursiveCharIterator.java index 4af014f12..22ece76f3 100644 --- a/src/java/org/apache/fop/fo/RecursiveCharIterator.java +++ b/src/java/org/apache/fop/fo/RecursiveCharIterator.java @@ -123,7 +123,7 @@ public class RecursiveCharIterator extends CharIterator { } /** - * @see org.apache.fop.fo.CharIterator#nextChar() + * {@inheritDoc} */ public char nextChar() throws NoSuchElementException { if (curCharIter != null) { @@ -134,7 +134,7 @@ public class RecursiveCharIterator extends CharIterator { } /** - * @see java.util.Iterator#remove + * {@inheritDoc} */ public void remove() { if (curCharIter != null) { diff --git a/src/java/org/apache/fop/fo/UnknownXMLObj.java b/src/java/org/apache/fop/fo/UnknownXMLObj.java index 406e869fc..487aed2fa 100644 --- a/src/java/org/apache/fop/fo/UnknownXMLObj.java +++ b/src/java/org/apache/fop/fo/UnknownXMLObj.java @@ -62,18 +62,18 @@ public class UnknownXMLObj extends XMLObj { this.namespace = space; } - /** @see org.apache.fop.fo.FONode#getNamespaceURI() */ + /** {@inheritDoc} */ public String getNamespaceURI() { return this.namespace; } - /** @see org.apache.fop.fo.FONode#getNormalNamespacePrefix() */ + /** {@inheritDoc} */ public String getNormalNamespacePrefix() { return null; //We don't know that in this case. } /** - * @see org.apache.fop.fo.FONode#addChildNode(FONode) + * {@inheritDoc} */ protected void addChildNode(FONode child) { if (doc == null) { @@ -83,7 +83,7 @@ public class UnknownXMLObj extends XMLObj { } /** - * @see XMLObj#addCharacters + * {@inheritDoc} */ protected void addCharacters(char data[], int start, int length, PropertyList pList, Locator locator) { diff --git a/src/java/org/apache/fop/fo/XMLObj.java b/src/java/org/apache/fop/fo/XMLObj.java index f7d140732..0297bd483 100644 --- a/src/java/org/apache/fop/fo/XMLObj.java +++ b/src/java/org/apache/fop/fo/XMLObj.java @@ -60,7 +60,7 @@ public abstract class XMLObj extends FONode implements ObjectBuiltListener { } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} * here, blocks XSL FO's from having non-FO parents. */ protected void validateChildNode(Locator loc, String nsURI, String localName) @@ -71,7 +71,7 @@ public abstract class XMLObj extends FONode implements ObjectBuiltListener { } /** - * @see org.apache.fop.fo.FONode#processNode + * {@inheritDoc} */ public void processNode(String elementName, Locator locator, Attributes attlist, PropertyList propertyList) throws FOPException { @@ -104,7 +104,7 @@ public abstract class XMLObj extends FONode implements ObjectBuiltListener { return null; } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return name; } @@ -187,7 +187,7 @@ public abstract class XMLObj extends FONode implements ObjectBuiltListener { } /** - * @see org.apache.fop.fo.FONode#addChildNode(FONode) + * {@inheritDoc} */ protected void addChildNode(FONode child) { if (child instanceof XMLObj) { @@ -215,7 +215,7 @@ public abstract class XMLObj extends FONode implements ObjectBuiltListener { element.appendChild(text); } - /** @see org.apache.fop.util.ContentHandlerFactory.ObjectBuiltListener */ + /** {@inheritDoc} */ public void notifyObjectBuilt(Object obj) { this.doc = (Document)obj; } diff --git a/src/java/org/apache/fop/fo/XMLWhiteSpaceHandler.java b/src/java/org/apache/fop/fo/XMLWhiteSpaceHandler.java index e0e5898e3..dc0cf3b48 100644 --- a/src/java/org/apache/fop/fo/XMLWhiteSpaceHandler.java +++ b/src/java/org/apache/fop/fo/XMLWhiteSpaceHandler.java @@ -22,7 +22,6 @@ package org.apache.fop.fo; import java.util.List; import java.util.Stack; import org.apache.fop.fo.flow.Block; -import org.apache.fop.fo.flow.Character; import org.apache.fop.util.CharUtilities; /** @@ -50,12 +49,9 @@ import org.apache.fop.util.CharUtilities; * <br> * The iteration always starts at <code>firstTextNode</code>, * goes on until the last text-node is reached, and deals only - * with FOText nodes (characters are immediately removed) or - * Character nodes (characters are kept track of and removed - * from the list of child nodes later, when the iterator goes - * out of scope) - * - * Note: if the method is called from an inline's endOfNode(), + * with <code>FOText</code> or <code>Character</code> nodes. + * <br> + * <em>Note</em>: if the method is called from an inline's endOfNode(), * there is too little context to decide whether trailing * white-space may be removed, so the pending inline is stored * in a List, together with an iterator for which the next() diff --git a/src/java/org/apache/fop/fo/expr/CMYKcolorFunction.java b/src/java/org/apache/fop/fo/expr/CMYKcolorFunction.java index a66e8492a..ff3ca25eb 100644 --- a/src/java/org/apache/fop/fo/expr/CMYKcolorFunction.java +++ b/src/java/org/apache/fop/fo/expr/CMYKcolorFunction.java @@ -29,13 +29,13 @@ class CMYKcolorFunction extends FunctionBase { /** * cmyk takes four arguments. - * @see org.apache.fop.fo.expr.Function#nbArgs() + * {@inheritDoc} */ public int nbArgs() { return 4; } - /** @see org.apache.fop.fo.expr.Function */ + /** {@inheritDoc} */ public Property eval(Property[] args, PropertyInfo pInfo) throws PropertyException { StringBuffer sb = new StringBuffer(); diff --git a/src/java/org/apache/fop/fo/expr/ICCColorFunction.java b/src/java/org/apache/fop/fo/expr/ICCColorFunction.java index fce073467..389bf42e9 100644 --- a/src/java/org/apache/fop/fo/expr/ICCColorFunction.java +++ b/src/java/org/apache/fop/fo/expr/ICCColorFunction.java @@ -32,13 +32,13 @@ class ICCColorFunction extends FunctionBase { /** * rgb-icc takes a variable number of arguments. * At least 4 should be passed - returns -4 - * @see org.apache.fop.fo.expr.Function#nbArgs() + * {@inheritDoc} */ public int nbArgs() { return -4; } - /** @see org.apache.fop.fo.expr.Function */ + /** {@inheritDoc} */ public Property eval(Property[] args, PropertyInfo pInfo) throws PropertyException { StringBuffer sb = new StringBuffer(); diff --git a/src/java/org/apache/fop/fo/expr/NumericProperty.java b/src/java/org/apache/fop/fo/expr/NumericProperty.java index 4c112964d..9c0b9e2ba 100644 --- a/src/java/org/apache/fop/fo/expr/NumericProperty.java +++ b/src/java/org/apache/fop/fo/expr/NumericProperty.java @@ -49,7 +49,7 @@ public class NumericProperty extends Property implements Numeric, Length { /** * Return the dimension. - * @see Numeric#getDimension() + * {@inheritDoc} */ public int getDimension() { return dim; @@ -57,14 +57,14 @@ public class NumericProperty extends Property implements Numeric, Length { /** * Return the value. - * @see Numeric#getNumericValue() + * {@inheritDoc} */ public double getNumericValue() { return value; } /** - * @see Numeric#getNumericValue(PercentBaseContext) + * {@inheritDoc} */ public double getNumericValue(PercentBaseContext context) { return value; @@ -72,33 +72,33 @@ public class NumericProperty extends Property implements Numeric, Length { /** * Return true of the numeric is absolute. - * @see Numeric#isAbsolute() + * {@inheritDoc} */ public boolean isAbsolute() { return true; } - /** @see org.apache.fop.fo.properties.Property#getNumeric() */ + /** {@inheritDoc} */ public Numeric getNumeric() { return this; } - /** @see org.apache.fop.fo.properties.Property#getNumber() */ + /** {@inheritDoc} */ public Number getNumber() { return new Double(value); } - /** @see org.apache.fop.datatypes.Numeric#getValue() */ + /** {@inheritDoc} */ public int getValue() { return (int) value; } - /** @see org.apache.fop.datatypes.Numeric#getValue(PercentBaseContext) */ + /** {@inheritDoc} */ public int getValue(PercentBaseContext context) { return (int) value; } - /** @see org.apache.fop.fo.properties.Property#getLength() */ + /** {@inheritDoc} */ public Length getLength() { if (dim == 1) { return this; @@ -107,18 +107,18 @@ public class NumericProperty extends Property implements Numeric, Length { return null; } - /** @see org.apache.fop.fo.properties.Property#getColor(FOUserAgent) */ + /** {@inheritDoc} */ public Color getColor(FOUserAgent foUserAgent) { // TODO: try converting to numeric number and then to color return null; } - /** @see org.apache.fop.fo.properties.Property#getObject() */ + /** {@inheritDoc} */ public Object getObject() { return this; } - /** @see java.lang.Object#toString() */ + /** {@inheritDoc} */ public String toString() { if (dim == 1) { return (int) value + "mpt"; diff --git a/src/java/org/apache/fop/fo/expr/PropertyException.java b/src/java/org/apache/fop/fo/expr/PropertyException.java index 3e4b5f9d1..d9a0b2edd 100644 --- a/src/java/org/apache/fop/fo/expr/PropertyException.java +++ b/src/java/org/apache/fop/fo/expr/PropertyException.java @@ -52,7 +52,7 @@ public class PropertyException extends FOPException { this.propertyName = propertyName; } - /** @see java.lang.Throwable#getMessage()*/ + /** {@inheritDoc} */ public String getMessage() { if (propertyName != null) { return super.getMessage() + "; property:'" + propertyName + "'"; diff --git a/src/java/org/apache/fop/fo/expr/PropertyInfo.java b/src/java/org/apache/fop/fo/expr/PropertyInfo.java index dc104b465..491be64fc 100644 --- a/src/java/org/apache/fop/fo/expr/PropertyInfo.java +++ b/src/java/org/apache/fop/fo/expr/PropertyInfo.java @@ -45,7 +45,6 @@ public class PropertyInfo { * Constructor * @param maker Property.Maker object * @param plist PropertyList object - * @param fo FObj */ public PropertyInfo(PropertyMaker maker, PropertyList plist) { this.maker = maker; diff --git a/src/java/org/apache/fop/fo/expr/RGBColorFunction.java b/src/java/org/apache/fop/fo/expr/RGBColorFunction.java index 805d8014f..6c6162731 100644 --- a/src/java/org/apache/fop/fo/expr/RGBColorFunction.java +++ b/src/java/org/apache/fop/fo/expr/RGBColorFunction.java @@ -30,7 +30,7 @@ import org.apache.fop.fo.properties.Property; */ class RGBColorFunction extends FunctionBase { - /** @see org.apache.fop.fo.expr.Function#nbArgs() */ + /** {@inheritDoc} */ public int nbArgs() { return 3; } @@ -44,7 +44,7 @@ class RGBColorFunction extends FunctionBase { return new RGBPercentBase(); } - /** @see org.apache.fop.fo.expr.Function */ + /** {@inheritDoc} */ public Property eval(Property[] args, PropertyInfo pInfo) throws PropertyException { FOUserAgent ua = (pInfo == null) diff --git a/src/java/org/apache/fop/fo/expr/RelativeNumericProperty.java b/src/java/org/apache/fop/fo/expr/RelativeNumericProperty.java index b42cb11a7..ae140b6b7 100755 --- a/src/java/org/apache/fop/fo/expr/RelativeNumericProperty.java +++ b/src/java/org/apache/fop/fo/expr/RelativeNumericProperty.java @@ -128,14 +128,14 @@ public class RelativeNumericProperty extends Property implements Numeric, Length /** * Return the resolved (calculated) value of the expression. - * @see org.apache.fop.datatypes.Numeric#getNumericValue() + * {@inheritDoc} */ public double getNumericValue() throws PropertyException { return getResolved(null).getNumericValue(null); } /** - * @see org.apache.fop.datatypes.Numeric#getNumericValue(PercentBaseContext) + * {@inheritDoc} */ public double getNumericValue(PercentBaseContext context) throws PropertyException { return getResolved(context).getNumericValue(context); @@ -172,7 +172,7 @@ public class RelativeNumericProperty extends Property implements Numeric, Length } /** - * @see org.apache.fop.datatypes.Numeric#getValue() + * {@inheritDoc} */ public int getValue() { try { @@ -184,7 +184,7 @@ public class RelativeNumericProperty extends Property implements Numeric, Length } /** - * @see org.apache.fop.datatypes.Numeric#getValue(PercentBaseContext) + * {@inheritDoc} */ public int getValue(PercentBaseContext context) { try { diff --git a/src/java/org/apache/fop/fo/expr/SystemColorFunction.java b/src/java/org/apache/fop/fo/expr/SystemColorFunction.java index ea9e4562e..5398b7051 100644 --- a/src/java/org/apache/fop/fo/expr/SystemColorFunction.java +++ b/src/java/org/apache/fop/fo/expr/SystemColorFunction.java @@ -28,12 +28,12 @@ import org.apache.fop.fo.properties.Property; */ class SystemColorFunction extends FunctionBase { - /** @see org.apache.fop.fo.expr.Function#nbArgs() */ + /** {@inheritDoc} */ public int nbArgs() { return 1; } - /** @see org.apache.fop.fo.expr.Function */ + /** {@inheritDoc} */ public Property eval(Property[] args, PropertyInfo pInfo) throws PropertyException { FOUserAgent ua = (pInfo == null) diff --git a/src/java/org/apache/fop/fo/extensions/ExtensionElementMapping.java b/src/java/org/apache/fop/fo/extensions/ExtensionElementMapping.java index b5ed3e61c..989726d22 100644 --- a/src/java/org/apache/fop/fo/extensions/ExtensionElementMapping.java +++ b/src/java/org/apache/fop/fo/extensions/ExtensionElementMapping.java @@ -71,12 +71,12 @@ public class ExtensionElementMapping extends ElementMapping { } } - /** @see org.apache.fop.fo.ElementMapping#getStandardPrefix() */ + /** {@inheritDoc} */ public String getStandardPrefix() { return "fox"; } - /** @see org.apache.fop.fo.ElementMapping#isAttributeProperty(org.apache.fop.util.QName) */ + /** {@inheritDoc} */ public boolean isAttributeProperty(QName attributeName) { if (!URI.equals(attributeName.getNamespaceURI())) { throw new IllegalArgumentException("The namespace URIs don't match"); diff --git a/src/java/org/apache/fop/fo/extensions/ExtensionObj.java b/src/java/org/apache/fop/fo/extensions/ExtensionObj.java index 9123a8bb7..f22c6fbbc 100644 --- a/src/java/org/apache/fop/fo/extensions/ExtensionObj.java +++ b/src/java/org/apache/fop/fo/extensions/ExtensionObj.java @@ -43,7 +43,7 @@ public abstract class ExtensionObj extends FObj { } /** - * @see org.apache.fop.fo.FONode#processNode + * {@inheritDoc} */ public void processNode(String elementName, Locator locator, Attributes attlist, PropertyList pList) diff --git a/src/java/org/apache/fop/fo/extensions/destination/Destination.java b/src/java/org/apache/fop/fo/extensions/destination/Destination.java index b4611661e..d1e631e42 100644 --- a/src/java/org/apache/fop/fo/extensions/destination/Destination.java +++ b/src/java/org/apache/fop/fo/extensions/destination/Destination.java @@ -48,8 +48,7 @@ public class Destination extends FONode { } /** - * @see org.apache.fop.fo.FONode#processNode(java.lang.String, org.xml.sax.Locator, - * org.xml.sax.Attributes, org.apache.fop.fo.PropertyList) + * {@inheritDoc} */ public void processNode(String elementName, Locator locator, Attributes attlist, PropertyList pList) throws FOPException { @@ -60,14 +59,14 @@ public class Destination extends FONode { } /** - * @see org.apache.fop.fo.FONode#endOfNode + * {@inheritDoc} */ protected void endOfNode() throws FOPException { root.addDestination(this); } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} XSL/FOP: empty */ protected void validateChildNode(Locator loc, String nsURI, String localName) @@ -83,17 +82,17 @@ public class Destination extends FONode { return internalDestination; } - /** @see org.apache.fop.fo.FONode#getNamespaceURI() */ + /** {@inheritDoc} */ public String getNamespaceURI() { return ExtensionElementMapping.URI; } - /** @see org.apache.fop.fo.FONode#getNormalNamespacePrefix() */ + /** {@inheritDoc} */ public String getNormalNamespacePrefix() { return "fox"; } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "destination"; } diff --git a/src/java/org/apache/fop/fo/extensions/svg/BatikExtensionElementMapping.java b/src/java/org/apache/fop/fo/extensions/svg/BatikExtensionElementMapping.java index cb6e69a13..a39562877 100644 --- a/src/java/org/apache/fop/fo/extensions/svg/BatikExtensionElementMapping.java +++ b/src/java/org/apache/fop/fo/extensions/svg/BatikExtensionElementMapping.java @@ -43,7 +43,7 @@ public class BatikExtensionElementMapping extends ElementMapping { namespaceURI = URI; } - /** @see org.apache.fop.fo.ElementMapping#getDOMImplementation() */ + /** {@inheritDoc} */ public DOMImplementation getDOMImplementation() { return null; //no DOMImplementation necessary here } diff --git a/src/java/org/apache/fop/fo/extensions/svg/SVGElement.java b/src/java/org/apache/fop/fo/extensions/svg/SVGElement.java index 351327a26..521f3b81b 100644 --- a/src/java/org/apache/fop/fo/extensions/svg/SVGElement.java +++ b/src/java/org/apache/fop/fo/extensions/svg/SVGElement.java @@ -62,7 +62,7 @@ public class SVGElement extends SVGObj { } /** - * @see org.apache.fop.fo.FONode#getContentHandlerFactory() + * {@inheritDoc} */ public ContentHandlerFactory getContentHandlerFactory() { return new DOMBuilderContentHandlerFactory(getNamespaceURI(), @@ -70,7 +70,7 @@ public class SVGElement extends SVGObj { } /** - * @see org.apache.fop.fo.FONode#processNode + * {@inheritDoc} */ public void processNode(String elementName, Locator locator, Attributes attlist, PropertyList propertyList) throws FOPException { diff --git a/src/java/org/apache/fop/fo/extensions/svg/SVGElementMapping.java b/src/java/org/apache/fop/fo/extensions/svg/SVGElementMapping.java index 2d8939dc2..586fd2d92 100644 --- a/src/java/org/apache/fop/fo/extensions/svg/SVGElementMapping.java +++ b/src/java/org/apache/fop/fo/extensions/svg/SVGElementMapping.java @@ -51,7 +51,7 @@ public class SVGElementMapping extends ElementMapping { namespaceURI = URI; } - /** @see org.apache.fop.fo.ElementMapping#getDOMImplementation() */ + /** {@inheritDoc} */ public DOMImplementation getDOMImplementation() { return SVGDOMImplementation.getDOMImplementation(); } @@ -70,7 +70,7 @@ public class SVGElementMapping extends ElementMapping { } } - /** @see org.apache.fop.fo.ElementMapping#initialize() */ + /** {@inheritDoc} */ protected void initialize() { if (foObjs == null && batikAvailable) { // this sets the parser that will be used @@ -92,7 +92,7 @@ public class SVGElementMapping extends ElementMapping { } } - /** @see org.apache.fop.fo.ElementMapping#getStandardPrefix() */ + /** {@inheritDoc} */ public String getStandardPrefix() { return "svg"; } diff --git a/src/java/org/apache/fop/fo/extensions/svg/SVGObj.java b/src/java/org/apache/fop/fo/extensions/svg/SVGObj.java index 60ba9d276..93193aac4 100644 --- a/src/java/org/apache/fop/fo/extensions/svg/SVGObj.java +++ b/src/java/org/apache/fop/fo/extensions/svg/SVGObj.java @@ -37,12 +37,12 @@ public class SVGObj extends XMLObj { super(parent); } - /** @see org.apache.fop.fo.FONode#getNamespaceURI() */ + /** {@inheritDoc} */ public String getNamespaceURI() { return SVGElementMapping.URI; } - /** @see org.apache.fop.fo.FONode#getNormalNamespacePrefix() */ + /** {@inheritDoc} */ public String getNormalNamespacePrefix() { return "svg"; } diff --git a/src/java/org/apache/fop/fo/extensions/xmp/AbstractMetadataElement.java b/src/java/org/apache/fop/fo/extensions/xmp/AbstractMetadataElement.java index ca6019aae..0fff78623 100644 --- a/src/java/org/apache/fop/fo/extensions/xmp/AbstractMetadataElement.java +++ b/src/java/org/apache/fop/fo/extensions/xmp/AbstractMetadataElement.java @@ -42,13 +42,13 @@ public abstract class AbstractMetadataElement extends FONode implements ObjectBu } /** - * @see org.apache.fop.fo.FONode#getContentHandlerFactory() + * {@inheritDoc} */ public ContentHandlerFactory getContentHandlerFactory() { return new XMPContentHandlerFactory(); } - /** @see org.apache.fop.fo.FONode#getExtensionAttachment() */ + /** {@inheritDoc} */ public ExtensionAttachment getExtensionAttachment() { if (parent instanceof FObj) { if (attachment == null) { @@ -60,7 +60,7 @@ public abstract class AbstractMetadataElement extends FONode implements ObjectBu } } - /** @see org.apache.fop.fo.XMLObj#notifyObjectBuilt(java.lang.Object) */ + /** {@inheritDoc} */ public void notifyObjectBuilt(Object obj) { attachment.setMetadata((Metadata)obj); } diff --git a/src/java/org/apache/fop/fo/extensions/xmp/RDFElement.java b/src/java/org/apache/fop/fo/extensions/xmp/RDFElement.java index 51ec81dc8..6a67575c5 100644 --- a/src/java/org/apache/fop/fo/extensions/xmp/RDFElement.java +++ b/src/java/org/apache/fop/fo/extensions/xmp/RDFElement.java @@ -35,17 +35,17 @@ public class RDFElement extends AbstractMetadataElement { super(parent); } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "RDF"; } - /** @see org.apache.fop.fo.FONode#getNormalNamespacePrefix() */ + /** {@inheritDoc} */ public String getNormalNamespacePrefix() { return "rdf"; } - /** @see org.apache.fop.fo.FONode#getNamespaceURI() */ + /** {@inheritDoc} */ public String getNamespaceURI() { return XMPConstants.RDF_NAMESPACE; } diff --git a/src/java/org/apache/fop/fo/extensions/xmp/RDFElementMapping.java b/src/java/org/apache/fop/fo/extensions/xmp/RDFElementMapping.java index 7f4df95a3..e2aa1ba95 100644 --- a/src/java/org/apache/fop/fo/extensions/xmp/RDFElementMapping.java +++ b/src/java/org/apache/fop/fo/extensions/xmp/RDFElementMapping.java @@ -37,12 +37,12 @@ public class RDFElementMapping extends ElementMapping { namespaceURI = XMPConstants.RDF_NAMESPACE; } - /** @see org.apache.fop.fo.ElementMapping#getDOMImplementation() */ + /** {@inheritDoc} */ public DOMImplementation getDOMImplementation() { return getDefaultDOMImplementation(); } - /** @see org.apache.fop.fo.ElementMapping#initialize() */ + /** {@inheritDoc} */ protected void initialize() { if (foObjs == null) { foObjs = new HashMap(); diff --git a/src/java/org/apache/fop/fo/extensions/xmp/XMPContentHandlerFactory.java b/src/java/org/apache/fop/fo/extensions/xmp/XMPContentHandlerFactory.java index 970cc62a2..5c30801f2 100644 --- a/src/java/org/apache/fop/fo/extensions/xmp/XMPContentHandlerFactory.java +++ b/src/java/org/apache/fop/fo/extensions/xmp/XMPContentHandlerFactory.java @@ -33,12 +33,12 @@ public class XMPContentHandlerFactory implements ContentHandlerFactory { private static final String[] NAMESPACES = new String[] {XMPConstants.XMP_NAMESPACE, XMPConstants.RDF_NAMESPACE}; - /** @see org.apache.fop.util.ContentHandlerFactory#getSupportedNamespaces() */ + /** {@inheritDoc} */ public String[] getSupportedNamespaces() { return NAMESPACES; } - /** @see org.apache.fop.util.ContentHandlerFactory#createContentHandler() */ + /** {@inheritDoc} */ public ContentHandler createContentHandler() throws SAXException { return new FOPXMPHandler(); } @@ -54,12 +54,12 @@ public class XMPContentHandlerFactory implements ContentHandlerFactory { return getMetadata(); } - /** @see org.apache.fop.util.ContentHandlerFactory.ObjectSource */ + /** {@inheritDoc} */ public void setObjectBuiltListener(ObjectBuiltListener listener) { this.obListener = listener; } - /** @see org.xml.sax.helpers.DefaultHandler#endDocument() */ + /** {@inheritDoc} */ public void endDocument() throws SAXException { if (obListener != null) { obListener.notifyObjectBuilt(getObject()); diff --git a/src/java/org/apache/fop/fo/extensions/xmp/XMPElementMapping.java b/src/java/org/apache/fop/fo/extensions/xmp/XMPElementMapping.java index 62e940c18..dd250f8b4 100644 --- a/src/java/org/apache/fop/fo/extensions/xmp/XMPElementMapping.java +++ b/src/java/org/apache/fop/fo/extensions/xmp/XMPElementMapping.java @@ -37,12 +37,12 @@ public class XMPElementMapping extends ElementMapping { namespaceURI = XMPConstants.XMP_NAMESPACE; } - /** @see org.apache.fop.fo.ElementMapping#getDOMImplementation() */ + /** {@inheritDoc} */ public DOMImplementation getDOMImplementation() { return getDefaultDOMImplementation(); } - /** @see org.apache.fop.fo.ElementMapping#initialize() */ + /** {@inheritDoc} */ protected void initialize() { if (foObjs == null) { foObjs = new HashMap(); diff --git a/src/java/org/apache/fop/fo/extensions/xmp/XMPMetaElement.java b/src/java/org/apache/fop/fo/extensions/xmp/XMPMetaElement.java index 3398fbda5..2d3058d3f 100644 --- a/src/java/org/apache/fop/fo/extensions/xmp/XMPMetaElement.java +++ b/src/java/org/apache/fop/fo/extensions/xmp/XMPMetaElement.java @@ -35,17 +35,17 @@ public class XMPMetaElement extends AbstractMetadataElement { super(parent); } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "xmpmeta"; } - /** @see org.apache.fop.fo.FONode#getNormalNamespacePrefix() */ + /** {@inheritDoc} */ public String getNormalNamespacePrefix() { return "x"; } - /** @see org.apache.fop.fo.FONode#getNamespaceURI() */ + /** {@inheritDoc} */ public String getNamespaceURI() { return XMPConstants.XMP_NAMESPACE; } diff --git a/src/java/org/apache/fop/fo/extensions/xmp/XMPMetadata.java b/src/java/org/apache/fop/fo/extensions/xmp/XMPMetadata.java index c761a08ed..f08b1f433 100644 --- a/src/java/org/apache/fop/fo/extensions/xmp/XMPMetadata.java +++ b/src/java/org/apache/fop/fo/extensions/xmp/XMPMetadata.java @@ -80,12 +80,12 @@ public class XMPMetadata implements ExtensionAttachment, Serializable, XMLizable this.readOnly = readOnly; } - /** @see org.apache.fop.fo.extensions.ExtensionAttachment#getCategory() */ + /** {@inheritDoc} */ public String getCategory() { return CATEGORY; } - /** @see org.apache.fop.util.XMLizable#toSAX(org.xml.sax.ContentHandler) */ + /** {@inheritDoc} */ public void toSAX(ContentHandler handler) throws SAXException { getMetadata().toSAX(handler); } diff --git a/src/java/org/apache/fop/fo/flow/AbstractGraphics.java b/src/java/org/apache/fop/fo/flow/AbstractGraphics.java index f48052009..74b91eb53 100644 --- a/src/java/org/apache/fop/fo/flow/AbstractGraphics.java +++ b/src/java/org/apache/fop/fo/flow/AbstractGraphics.java @@ -24,12 +24,7 @@ import org.apache.fop.datatypes.Length; import org.apache.fop.fo.FONode; import org.apache.fop.fo.FObj; import org.apache.fop.fo.PropertyList; -import org.apache.fop.fo.properties.CommonAccessibility; -import org.apache.fop.fo.properties.CommonAural; import org.apache.fop.fo.properties.CommonBorderPaddingBackground; -import org.apache.fop.fo.properties.CommonMarginInline; -import org.apache.fop.fo.properties.CommonRelativePosition; -import org.apache.fop.fo.properties.KeepProperty; import org.apache.fop.fo.properties.LengthRangeProperty; import org.apache.fop.fo.properties.SpaceProperty; @@ -82,7 +77,7 @@ public abstract class AbstractGraphics extends FObj { } /** - * @see org.apache.fop.fo.FObj#bind(PropertyList) + * {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { commonBorderPaddingBackground = pList.getBorderPaddingBackgroundProps(); diff --git a/src/java/org/apache/fop/fo/flow/AbstractListItemPart.java b/src/java/org/apache/fop/fo/flow/AbstractListItemPart.java index 2996f5edd..0fe6ed718 100644 --- a/src/java/org/apache/fop/fo/flow/AbstractListItemPart.java +++ b/src/java/org/apache/fop/fo/flow/AbstractListItemPart.java @@ -26,11 +26,10 @@ import org.apache.fop.fo.FONode; import org.apache.fop.fo.FObj; import org.apache.fop.fo.PropertyList; import org.apache.fop.fo.ValidationException; -import org.apache.fop.fo.properties.CommonAccessibility; import org.apache.fop.fo.properties.KeepProperty; /** - * Class modelling the fo:list-item-body object. + * Common superclass for list-item-label and list-item-body. */ public abstract class AbstractListItemPart extends FObj { // The value of properties relevant for fo:list-item-label and fo:list-item-body. @@ -50,7 +49,7 @@ public abstract class AbstractListItemPart extends FObj { } /** - * @see org.apache.fop.fo.FObj#bind(PropertyList) + * {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { super.bind(pList); @@ -58,7 +57,7 @@ public abstract class AbstractListItemPart extends FObj { } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} * XSL Content Model: marker* (%block;)+ */ protected void validateChildNode(Locator loc, String nsURI, String localName) @@ -75,7 +74,7 @@ public abstract class AbstractListItemPart extends FObj { } /** - * @see org.apache.fop.fo.FONode#endOfNode + * {@inheritDoc} */ protected void endOfNode() throws FOPException { if (!this.blockItemFound) { diff --git a/src/java/org/apache/fop/fo/flow/BasicLink.java b/src/java/org/apache/fop/fo/flow/BasicLink.java index c07c31289..61a4f8d19 100644 --- a/src/java/org/apache/fop/fo/flow/BasicLink.java +++ b/src/java/org/apache/fop/fo/flow/BasicLink.java @@ -27,7 +27,7 @@ import org.apache.fop.fo.PropertyList; import org.apache.fop.fo.ValidationException; /** - * The fo:basic-link formatting object. + * Class modelling the fo:basic-link object. * * This class contains the logic to determine the link represented by this FO, * and whether that link is external (uses a URI) or internal (an id @@ -58,7 +58,7 @@ public class BasicLink extends Inline { } /** - * @see org.apache.fop.fo.FObj#bind(PropertyList) + * {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { super.bind(pList); @@ -82,7 +82,7 @@ public class BasicLink extends Inline { } /** - * @see org.apache.fop.fo.FONode#startOfNode + * {@inheritDoc} */ protected void startOfNode() throws FOPException { super.startOfNode(); @@ -90,7 +90,7 @@ public class BasicLink extends Inline { } /** - * @see org.apache.fop.fo.FONode#endOfNode + * {@inheritDoc} */ protected void endOfNode() throws FOPException { super.endOfNode(); @@ -98,7 +98,7 @@ public class BasicLink extends Inline { } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} String, String) * XSL Content Model: marker* (#PCDATA|%inline;|%block;)* */ protected void validateChildNode(Locator loc, String nsURI, String localName) @@ -142,12 +142,12 @@ public class BasicLink extends Inline { return externalDestination != null && externalDestination.length() > 0; } - /** @see org.apache.fop.fo.FObj#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "basic-link"; } - /** @see org.apache.fop.fo.FObj#getNameId() */ + /** {@inheritDoc} */ public int getNameId() { return FO_BASIC_LINK; } diff --git a/src/java/org/apache/fop/fo/flow/BidiOverride.java b/src/java/org/apache/fop/fo/flow/BidiOverride.java index 3a63b96cf..2157085ad 100644 --- a/src/java/org/apache/fop/fo/flow/BidiOverride.java +++ b/src/java/org/apache/fop/fo/flow/BidiOverride.java @@ -19,21 +19,16 @@ package org.apache.fop.fo.flow; -import java.awt.Color; - import org.apache.fop.apps.FOPException; import org.apache.fop.fo.FONode; import org.apache.fop.fo.FObjMixed; import org.apache.fop.fo.PropertyList; import org.apache.fop.fo.ValidationException; -import org.apache.fop.fo.properties.CommonAural; -import org.apache.fop.fo.properties.CommonFont; -import org.apache.fop.fo.properties.CommonRelativePosition; import org.apache.fop.fo.properties.SpaceProperty; import org.xml.sax.Locator; /** - * fo:bidi-override element. + * Class modelling the fo:bidi-override object. */ public class BidiOverride extends FObjMixed { @@ -82,7 +77,7 @@ public class BidiOverride extends FObjMixed { } /** - * @see org.apache.fop.fo.FObj#bind(PropertyList) + * {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { // prDirection = pList.get(PR_DIRECTION); @@ -93,7 +88,7 @@ public class BidiOverride extends FObjMixed { } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} * XSL Content Model: marker* (#PCDATA|%inline;|%block;)* * Additionally: "An fo:bidi-override that is a descendant of an fo:leader * or of the fo:inline child of an fo:footnote may not have block-level @@ -127,13 +122,13 @@ public class BidiOverride extends FObjMixed { return lineHeight; } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "bidi-override"; } /** - * @see org.apache.fop.fo.FObj#getNameId() + * {@inheritDoc} */ public int getNameId() { return FO_BIDI_OVERRIDE; diff --git a/src/java/org/apache/fop/fo/flow/Block.java b/src/java/org/apache/fop/fo/flow/Block.java index 894339b8d..30b4c5495 100644 --- a/src/java/org/apache/fop/fo/flow/Block.java +++ b/src/java/org/apache/fop/fo/flow/Block.java @@ -95,7 +95,7 @@ public class Block extends FObjMixed { } /** - * @see org.apache.fop.fo.FObj#bind(PropertyList) + * {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { super.bind(pList); @@ -131,7 +131,7 @@ public class Block extends FObjMixed { } /** - * @see org.apache.fop.fo.FONode#startOfNode + * {@inheritDoc} */ protected void startOfNode() throws FOPException { super.startOfNode(); @@ -139,7 +139,7 @@ public class Block extends FObjMixed { } /** - * @see org.apache.fop.fo.FONode#endOfNode + * {@inheritDoc} */ protected void endOfNode() throws FOPException { super.endOfNode(); @@ -276,7 +276,7 @@ public class Block extends FObjMixed { } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} * XSL Content Model: marker* initial-property-set? (#PCDATA|%inline;|%block;)* * Additionally: "An fo:bidi-override that is a descendant of an fo:leader * or of the fo:inline child of an fo:footnote may not have block-level @@ -363,18 +363,18 @@ public class Block extends FObjMixed { return this.lineHeightShiftAdjustment; } - /** @see org.apache.fop.fo.FONode#charIterator() */ + /** {@inheritDoc} */ public CharIterator charIterator() { return NullCharIterator.getInstance(); } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "block"; } /** - * @see org.apache.fop.fo.FObj#getNameId() + * {@inheritDoc} */ public int getNameId() { return FO_BLOCK; diff --git a/src/java/org/apache/fop/fo/flow/BlockContainer.java b/src/java/org/apache/fop/fo/flow/BlockContainer.java index acffa083f..a71999938 100644 --- a/src/java/org/apache/fop/fo/flow/BlockContainer.java +++ b/src/java/org/apache/fop/fo/flow/BlockContainer.java @@ -73,7 +73,7 @@ public class BlockContainer extends FObj { } /** - * @see org.apache.fop.fo.FObj#bind(PropertyList) + * {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { super.bind(pList); @@ -98,7 +98,7 @@ public class BlockContainer extends FObj { } /** - * @see org.apache.fop.fo.FONode#startOfNode + * {@inheritDoc} */ protected void startOfNode() throws FOPException { super.startOfNode(); @@ -106,7 +106,7 @@ public class BlockContainer extends FObj { } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} * XSL Content Model: marker* (%block;)+ * But: "In addition an fo:block-container that does not generate an * absolutely positioned area may have a sequence of zero or more @@ -127,7 +127,7 @@ public class BlockContainer extends FObj { } /** - * @see org.apache.fop.fo.FONode#endOfNode + * {@inheritDoc} */ protected void endOfNode() throws FOPException { if (!blockItemFound) { @@ -251,13 +251,13 @@ public class BlockContainer extends FObj { return height; } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "block-container"; } /** - * @see org.apache.fop.fo.FObj#getNameId() + * {@inheritDoc} */ public int getNameId() { return FO_BLOCK_CONTAINER; diff --git a/src/java/org/apache/fop/fo/flow/Character.java b/src/java/org/apache/fop/fo/flow/Character.java index 78a1ea0ef..022d54af7 100644 --- a/src/java/org/apache/fop/fo/flow/Character.java +++ b/src/java/org/apache/fop/fo/flow/Character.java @@ -29,30 +29,26 @@ import org.apache.fop.fo.FONode; import org.apache.fop.fo.FObj; import org.apache.fop.fo.PropertyList; import org.apache.fop.fo.ValidationException; -import org.apache.fop.fo.properties.CommonAural; import org.apache.fop.fo.properties.CommonBorderPaddingBackground; import org.apache.fop.fo.properties.CommonFont; import org.apache.fop.fo.properties.CommonHyphenation; -import org.apache.fop.fo.properties.CommonMarginInline; -import org.apache.fop.fo.properties.CommonRelativePosition; import org.apache.fop.fo.properties.CommonTextDecoration; -import org.apache.fop.fo.properties.KeepProperty; import org.apache.fop.fo.properties.Property; import org.apache.fop.fo.properties.SpaceProperty; -import org.apache.fop.util.CharUtilities; import org.xml.sax.Locator; /** - * This class represents the flow object 'fo:character'. Its use is defined by - * the spec: "The fo:character flow object represents a character that is mapped to - * a glyph for presentation. It is an atomic unit to the formatter. - * When the result tree is interpreted as a tree of formatting objects, - * a character in the result tree is treated as if it were an empty - * element of type fo:character with a character attribute - * equal to the Unicode representation of the character. - * The semantics of an "auto" value for character properties, which is - * typically their initial value, are based on the Unicode codepoint. - * Overrides may be specified in an implementation-specific manner." (6.6.3) + * Class modelling the fo:character object. + * Its use is defined by the spec: + * "The fo:character flow object represents a character that is mapped to + * a glyph for presentation. It is an atomic unit to the formatter. + * When the result tree is interpreted as a tree of formatting objects, + * a character in the result tree is treated as if it were an empty + * element of type fo:character with a character attribute + * equal to the Unicode representation of the character. + * The semantics of an "auto" value for character properties, which is + * typically their initial value, are based on the Unicode codepoint. + * Overrides may be specified in an implementation-specific manner." (6.6.3) * */ public class Character extends FObj { @@ -102,7 +98,7 @@ public class Character extends FObj { } /** - * @see org.apache.fop.fo.FObj#bind(PropertyList) + * {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { super.bind(pList); @@ -126,7 +122,7 @@ public class Character extends FObj { } /** - * @see org.apache.fop.fo.FONode#startOfNode + * {@inheritDoc} */ protected void startOfNode() throws FOPException { super.startOfNode(); @@ -134,7 +130,7 @@ public class Character extends FObj { } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} * XSL Content Model: empty */ protected void validateChildNode(Locator loc, String nsURI, String localName) @@ -143,7 +139,7 @@ public class Character extends FObj { } /** - * @see org.apache.fop.fo.FObj#charIterator + * {@inheritDoc} */ public CharIterator charIterator() { return new FOCharIterator(this); @@ -238,13 +234,13 @@ public class Character extends FObj { return wordSpacing; } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "character"; } /** - * @see org.apache.fop.fo.FObj#getNameId() + * {@inheritDoc} */ public int getNameId() { return FO_CHARACTER; diff --git a/src/java/org/apache/fop/fo/flow/ExternalGraphic.java b/src/java/org/apache/fop/fo/flow/ExternalGraphic.java index 3ca8cf777..f0285e6f4 100644 --- a/src/java/org/apache/fop/fo/flow/ExternalGraphic.java +++ b/src/java/org/apache/fop/fo/flow/ExternalGraphic.java @@ -30,7 +30,7 @@ import org.apache.fop.image.ImageFactory; import org.xml.sax.Locator; /** - * External graphic formatting object. + * Class modelling the fo:external-graphic object. * This FO node handles the external graphic. It creates an image * inline area that can be added to the area tree. */ @@ -57,7 +57,7 @@ public class ExternalGraphic extends AbstractGraphics { } /** - * @see org.apache.fop.fo.FObj#bind(PropertyList) + * {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { super.bind(pList); @@ -83,7 +83,7 @@ public class ExternalGraphic extends AbstractGraphics { } /** - * @see org.apache.fop.fo.FONode#startOfNode + * {@inheritDoc} */ protected void startOfNode() throws FOPException { super.startOfNode(); @@ -91,7 +91,7 @@ public class ExternalGraphic extends AbstractGraphics { } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} * XSL Content Model: empty */ protected void validateChildNode(Locator loc, String nsURI, String localName) @@ -113,34 +113,34 @@ public class ExternalGraphic extends AbstractGraphics { return url; } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "external-graphic"; } /** - * @see org.apache.fop.fo.FObj#getNameId() + * {@inheritDoc} */ public int getNameId() { return FO_EXTERNAL_GRAPHIC; } /** - * @see org.apache.fop.fo.flow.AbstractGraphics#getIntrinsicWidth() + * {@inheritDoc} */ public int getIntrinsicWidth() { return this.intrinsicWidth; } /** - * @see org.apache.fop.fo.flow.AbstractGraphics#getIntrinsicHeight() + * {@inheritDoc} */ public int getIntrinsicHeight() { return this.intrinsicHeight; } /** - * @see org.apache.fop.fo.flow.AbstractGraphics#getIntrinsicAlignmentAdjust() + * {@inheritDoc} */ public Length getIntrinsicAlignmentAdjust() { return this.intrinsicAlignmentAdjust; diff --git a/src/java/org/apache/fop/fo/flow/Float.java b/src/java/org/apache/fop/fo/flow/Float.java index 475ffee09..997f96c89 100644 --- a/src/java/org/apache/fop/fo/flow/Float.java +++ b/src/java/org/apache/fop/fo/flow/Float.java @@ -29,7 +29,7 @@ import org.apache.fop.fo.PropertyList; import org.apache.fop.fo.ValidationException; /** - * fo:float element. + * Class modelling the fo:float object. */ public class Float extends FObj { // The value of properties relevant for fo:float (commented out for performance. @@ -52,14 +52,14 @@ public class Float extends FObj { } /** - * @see org.apache.fop.fo.FObj#bind(PropertyList) + * {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { // No active properties -> Nothing to do. } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} * XSL Content Model: (%block;)+ */ protected void validateChildNode(Locator loc, String nsURI, String localName) @@ -70,9 +70,7 @@ public class Float extends FObj { } /** - * Make sure content model satisfied, if so then tell the - * FOEventHandler that we are at the end of the flow. - * @see org.apache.fop.fo.FONode#endOfNode + * {@inheritDoc} */ protected void endOfNode() throws FOPException { if (firstChild == null) { @@ -80,13 +78,13 @@ public class Float extends FObj { } } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "float"; } /** - * @see org.apache.fop.fo.FObj#getNameId() + * {@inheritDoc} */ public int getNameId() { return FO_FLOAT; diff --git a/src/java/org/apache/fop/fo/flow/Footnote.java b/src/java/org/apache/fop/fo/flow/Footnote.java index 0f22b441e..95c9f25bc 100644 --- a/src/java/org/apache/fop/fo/flow/Footnote.java +++ b/src/java/org/apache/fop/fo/flow/Footnote.java @@ -26,7 +26,6 @@ import org.apache.fop.fo.FONode; import org.apache.fop.fo.FObj; import org.apache.fop.fo.PropertyList; import org.apache.fop.fo.ValidationException; -import org.apache.fop.fo.properties.CommonAccessibility; /** * Class modelling the fo:footnote object. @@ -47,14 +46,14 @@ public class Footnote extends FObj { } /** - * @see org.apache.fop.fo.FObj#bind(PropertyList) + * {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { // No active properties -> do nothing. } /** - * @see org.apache.fop.fo.FONode#startOfNode + * {@inheritDoc} */ protected void startOfNode() throws FOPException { getFOEventHandler().startFootnote(this); @@ -63,7 +62,7 @@ public class Footnote extends FObj { /** * Make sure content model satisfied, if so then tell the * FOEventHandler that we are at the end of the flow. - * @see org.apache.fop.fo.FONode#endOfNode + * {@inheritDoc} */ protected void endOfNode() throws FOPException { super.endOfNode(); @@ -74,7 +73,7 @@ public class Footnote extends FObj { } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} * XSL Content Model: (inline,footnote-body) * @todo implement additional constraint: A fo:footnote is not permitted * to have a fo:float, fo:footnote, or fo:marker as a descendant. @@ -100,7 +99,7 @@ public class Footnote extends FObj { } /** - * @see org.apache.fop.fo.FONode#addChildNode(FONode) + * {@inheritDoc} */ public void addChildNode(FONode child) { if (((FObj)child).getNameId() == FO_INLINE) { @@ -126,13 +125,13 @@ public class Footnote extends FObj { return footnoteBody; } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "footnote"; } /** - * @see org.apache.fop.fo.FObj#getNameId() + * {@inheritDoc} */ public int getNameId() { return FO_FOOTNOTE; diff --git a/src/java/org/apache/fop/fo/flow/FootnoteBody.java b/src/java/org/apache/fop/fo/flow/FootnoteBody.java index ef42012a8..bb4c9b482 100644 --- a/src/java/org/apache/fop/fo/flow/FootnoteBody.java +++ b/src/java/org/apache/fop/fo/flow/FootnoteBody.java @@ -27,7 +27,6 @@ import org.apache.fop.fo.FONode; import org.apache.fop.fo.FObj; import org.apache.fop.fo.PropertyList; import org.apache.fop.fo.ValidationException; -import org.apache.fop.fo.properties.CommonAccessibility; /** * Class modelling the fo:footnote-body object. @@ -45,13 +44,13 @@ public class FootnoteBody extends FObj { } /** - * @see org.apache.fop.fo.FObj#bind(PropertyList) + * {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { } /** - * @see org.apache.fop.fo.FONode#startOfNode + * {@inheritDoc} */ protected void startOfNode() throws FOPException { getFOEventHandler().startFootnoteBody(this); @@ -60,7 +59,7 @@ public class FootnoteBody extends FObj { /** * Make sure content model satisfied, if so then tell the * FOEventHandler that we are at the end of the flow. - * @see org.apache.fop.fo.FONode#endOfNode + * {@inheritDoc} */ protected void endOfNode() throws FOPException { if (firstChild == null) { @@ -70,7 +69,7 @@ public class FootnoteBody extends FObj { } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} * XSL Content Model: (%block;)+ */ protected void validateChildNode(Locator loc, String nsURI, String localName) @@ -80,13 +79,13 @@ public class FootnoteBody extends FObj { } } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "footnote-body"; } /** - * @see org.apache.fop.fo.FObj#getNameId() + * {@inheritDoc} */ public int getNameId() { return FO_FOOTNOTE_BODY; diff --git a/src/java/org/apache/fop/fo/flow/InitialPropertySet.java b/src/java/org/apache/fop/fo/flow/InitialPropertySet.java index 637c54065..63299978d 100644 --- a/src/java/org/apache/fop/fo/flow/InitialPropertySet.java +++ b/src/java/org/apache/fop/fo/flow/InitialPropertySet.java @@ -20,8 +20,6 @@ package org.apache.fop.fo.flow; // XML -import java.awt.Color; - import org.xml.sax.Locator; import org.apache.fop.apps.FOPException; @@ -29,11 +27,6 @@ import org.apache.fop.fo.FONode; import org.apache.fop.fo.FObj; import org.apache.fop.fo.PropertyList; import org.apache.fop.fo.ValidationException; -import org.apache.fop.fo.properties.CommonAccessibility; -import org.apache.fop.fo.properties.CommonAural; -import org.apache.fop.fo.properties.CommonBorderPaddingBackground; -import org.apache.fop.fo.properties.CommonFont; -import org.apache.fop.fo.properties.CommonRelativePosition; import org.apache.fop.fo.properties.SpaceProperty; /** @@ -41,7 +34,6 @@ import org.apache.fop.fo.properties.SpaceProperty; */ public class InitialPropertySet extends FObj { // The value of properties relevant for fo:initial-property-set. - private String id; // private ToBeImplementedProperty letterSpacing; private SpaceProperty lineHeight; // private ToBeImplementedProperty textShadow; @@ -66,7 +58,7 @@ public class InitialPropertySet extends FObj { } /** - * @see org.apache.fop.fo.FObj#bind(PropertyList) + * {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { super.bind(pList); @@ -76,7 +68,7 @@ public class InitialPropertySet extends FObj { } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} * XSL Content Model: empty */ protected void validateChildNode(Locator loc, String nsURI, String localName) @@ -91,13 +83,13 @@ public class InitialPropertySet extends FObj { return lineHeight; } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "initial-property-set"; } /** - * @see org.apache.fop.fo.FObj#getNameId() + * {@inheritDoc} */ public int getNameId() { return FO_INITIAL_PROPERTY_SET; diff --git a/src/java/org/apache/fop/fo/flow/Inline.java b/src/java/org/apache/fop/fo/flow/Inline.java index d9ac5136b..6bbd90ad1 100644 --- a/src/java/org/apache/fop/fo/flow/Inline.java +++ b/src/java/org/apache/fop/fo/flow/Inline.java @@ -23,14 +23,9 @@ import org.xml.sax.Locator; import org.apache.fop.apps.FOPException; import org.apache.fop.datatypes.Length; -import org.apache.fop.fo.CharIterator; import org.apache.fop.fo.FONode; -import org.apache.fop.fo.OneCharIterator; import org.apache.fop.fo.PropertyList; import org.apache.fop.fo.ValidationException; -import org.apache.fop.fo.properties.CommonRelativePosition; -import org.apache.fop.fo.properties.KeepProperty; -import org.apache.fop.fo.properties.LengthRangeProperty; /** * Class modelling the fo:inline formatting object. @@ -47,9 +42,6 @@ public class Inline extends InlineLevel { // private LengthRangeProperty blockProgressionDimension; // private Length height; // private LengthRangeProperty inlineProgressionDimension; - // private KeepProperty keepTogether; - // private KeepProperty keepWithNext; - // private KeepProperty keepWithPrevious; // private Length width; // private int wrapOption; // End of property values @@ -65,7 +57,7 @@ public class Inline extends InlineLevel { } /** - * @see org.apache.fop.fo.FObj#bind(PropertyList) + * {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { super.bind(pList); @@ -76,7 +68,7 @@ public class Inline extends InlineLevel { } /** - * @see org.apache.fop.fo.FONode#startOfNode + * {@inheritDoc} */ protected void startOfNode() throws FOPException { super.startOfNode(); @@ -103,7 +95,7 @@ public class Inline extends InlineLevel { } /** - * @see org.apache.fop.fo.FONode#endOfNode + * {@inheritDoc} */ protected void endOfNode() throws FOPException { super.endOfNode(); @@ -111,7 +103,7 @@ public class Inline extends InlineLevel { } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} * XSL Content Model: marker* (#PCDATA|%inline;|%block;)* * Additionally: " An fo:inline that is a descendant of an fo:leader * or fo:footnote may not have block-level children, unless it has a @@ -166,14 +158,12 @@ public class Inline extends InlineLevel { return dominantBaseline; } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "inline"; } - /** - * @see org.apache.fop.fo.FObj#getNameId() - */ + /** {@inheritDoc} */ public int getNameId() { return FO_INLINE; } diff --git a/src/java/org/apache/fop/fo/flow/InlineContainer.java b/src/java/org/apache/fop/fo/flow/InlineContainer.java index 1d4f621b8..a8fb7858d 100644 --- a/src/java/org/apache/fop/fo/flow/InlineContainer.java +++ b/src/java/org/apache/fop/fo/flow/InlineContainer.java @@ -23,16 +23,10 @@ import org.xml.sax.Locator; import org.apache.fop.apps.FOPException; import org.apache.fop.datatypes.Length; -import org.apache.fop.datatypes.Numeric; import org.apache.fop.fo.FONode; import org.apache.fop.fo.FObj; import org.apache.fop.fo.PropertyList; import org.apache.fop.fo.ValidationException; -import org.apache.fop.fo.properties.CommonBorderPaddingBackground; -import org.apache.fop.fo.properties.CommonMarginInline; -import org.apache.fop.fo.properties.CommonRelativePosition; -import org.apache.fop.fo.properties.KeepProperty; -import org.apache.fop.fo.properties.LengthRangeProperty; import org.apache.fop.fo.properties.SpaceProperty; /** @@ -75,7 +69,7 @@ public class InlineContainer extends FObj { } /** - * @see org.apache.fop.fo.FObj#bind(PropertyList) + * {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { super.bind(pList); @@ -88,7 +82,7 @@ public class InlineContainer extends FObj { } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} * XSL Content Model: marker* (%block;)+ */ protected void validateChildNode(Locator loc, String nsURI, String localName) @@ -105,7 +99,7 @@ public class InlineContainer extends FObj { } /** - * @see org.apache.fop.fo.FONode#endOfNode + * {@inheritDoc} */ protected void endOfNode() throws FOPException { if (!blockItemFound) { @@ -148,13 +142,13 @@ public class InlineContainer extends FObj { return lineHeight; } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "inline-container"; } /** - * @see org.apache.fop.fo.FObj#getNameId() + * {@inheritDoc} */ public int getNameId() { return FO_INLINE_CONTAINER; diff --git a/src/java/org/apache/fop/fo/flow/InlineLevel.java b/src/java/org/apache/fop/fo/flow/InlineLevel.java index ed9d0abe9..096a2ed66 100644 --- a/src/java/org/apache/fop/fo/flow/InlineLevel.java +++ b/src/java/org/apache/fop/fo/flow/InlineLevel.java @@ -30,6 +30,7 @@ import org.apache.fop.fo.properties.CommonAural; import org.apache.fop.fo.properties.CommonBorderPaddingBackground; import org.apache.fop.fo.properties.CommonFont; import org.apache.fop.fo.properties.CommonMarginInline; +import org.apache.fop.fo.properties.KeepProperty; import org.apache.fop.fo.properties.SpaceProperty; /** @@ -57,7 +58,7 @@ public abstract class InlineLevel extends FObjMixed { } /** - * @see org.apache.fop.fo.FObj#bind(PropertyList) + * {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { super.bind(pList); @@ -107,4 +108,3 @@ public abstract class InlineLevel extends FObjMixed { } } - diff --git a/src/java/org/apache/fop/fo/flow/InstreamForeignObject.java b/src/java/org/apache/fop/fo/flow/InstreamForeignObject.java index b201b95b1..531bd657a 100644 --- a/src/java/org/apache/fop/fo/flow/InstreamForeignObject.java +++ b/src/java/org/apache/fop/fo/flow/InstreamForeignObject.java @@ -28,9 +28,8 @@ import org.apache.fop.fo.XMLObj; import org.xml.sax.Locator; /** - * The instream-foreign-object flow formatting object. - * This is an atomic inline object that contains - * xml data. + * Class modelling the fo:instream-foreign-object object. + * This is an atomic inline object that contains XML data. */ public class InstreamForeignObject extends AbstractGraphics { @@ -55,7 +54,7 @@ public class InstreamForeignObject extends AbstractGraphics { /** * Make sure content model satisfied, if so then tell the * FOEventHandler that we are at the end of the flow. - * @see org.apache.fop.fo.FONode#endOfNode + * {@inheritDoc} */ protected void endOfNode() throws FOPException { if (firstChild == null) { @@ -65,7 +64,7 @@ public class InstreamForeignObject extends AbstractGraphics { } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} * XSL Content Model: one (1) non-XSL namespace child */ protected void validateChildNode(Locator loc, String nsURI, String localName) @@ -77,13 +76,13 @@ public class InstreamForeignObject extends AbstractGraphics { } } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "instream-foreign-object"; } /** - * @see org.apache.fop.fo.FObj#getNameId() + * {@inheritDoc} */ public int getNameId() { return FO_INSTREAM_FOREIGN_OBJECT; @@ -106,7 +105,7 @@ public class InstreamForeignObject extends AbstractGraphics { } /** - * @see org.apache.fop.fo.flow.AbstractGraphics#getIntrinsicWidth() + * {@inheritDoc} */ public int getIntrinsicWidth() { prepareIntrinsicSize(); @@ -118,7 +117,7 @@ public class InstreamForeignObject extends AbstractGraphics { } /** - * @see org.apache.fop.fo.flow.AbstractGraphics#getIntrinsicHeight() + * {@inheritDoc} */ public int getIntrinsicHeight() { prepareIntrinsicSize(); @@ -130,7 +129,7 @@ public class InstreamForeignObject extends AbstractGraphics { } /** - * @see org.apache.fop.fo.flow.AbstractGraphics#getIntrinsicAlignmentAdjust() + * {@inheritDoc} */ public Length getIntrinsicAlignmentAdjust() { @@ -138,7 +137,7 @@ public class InstreamForeignObject extends AbstractGraphics { return intrinsicAlignmentAdjust; } - /** @see org.apache.fop.fo.FONode#addChildNode(org.apache.fop.fo.FONode) */ + /** {@inheritDoc} */ protected void addChildNode(FONode child) throws FOPException { super.addChildNode(child); } diff --git a/src/java/org/apache/fop/fo/flow/Leader.java b/src/java/org/apache/fop/fo/flow/Leader.java index 403c6f8a2..82584b614 100644 --- a/src/java/org/apache/fop/fo/flow/Leader.java +++ b/src/java/org/apache/fop/fo/flow/Leader.java @@ -23,10 +23,7 @@ import org.apache.fop.apps.FOPException; import org.apache.fop.datatypes.Length; import org.apache.fop.fo.FONode; import org.apache.fop.fo.PropertyList; -import org.apache.fop.fo.properties.CommonRelativePosition; -import org.apache.fop.fo.properties.KeepProperty; import org.apache.fop.fo.properties.LengthRangeProperty; -import org.apache.fop.fo.properties.SpaceProperty; /** * Class modelling fo:leader object. @@ -53,9 +50,6 @@ public class Leader extends InlineLevel { // private CommonRelativePosition commonRelativePosition; // private Length textDepth; // private Length textAltitude; - // private KeepProperty keepWithNext; - // private KeepProperty keepWithPrevious; - // private SpaceProperty wordSpacing; // End of property values /** @@ -66,7 +60,7 @@ public class Leader extends InlineLevel { } /** - * @see org.apache.fop.fo.FObj#bind(PropertyList) + * {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { super.bind(pList); @@ -171,13 +165,13 @@ public class Leader extends InlineLevel { return dominantBaseline; } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "leader"; } /** - * @see org.apache.fop.fo.FObj#getNameId() + * {@inheritDoc} */ public int getNameId() { return FO_LEADER; diff --git a/src/java/org/apache/fop/fo/flow/ListBlock.java b/src/java/org/apache/fop/fo/flow/ListBlock.java index 6c1321024..86c581cc3 100644 --- a/src/java/org/apache/fop/fo/flow/ListBlock.java +++ b/src/java/org/apache/fop/fo/flow/ListBlock.java @@ -27,11 +27,8 @@ import org.apache.fop.fo.FONode; import org.apache.fop.fo.FObj; import org.apache.fop.fo.PropertyList; import org.apache.fop.fo.ValidationException; -import org.apache.fop.fo.properties.CommonAccessibility; -import org.apache.fop.fo.properties.CommonAural; import org.apache.fop.fo.properties.CommonBorderPaddingBackground; import org.apache.fop.fo.properties.CommonMarginBlock; -import org.apache.fop.fo.properties.CommonRelativePosition; import org.apache.fop.fo.properties.KeepProperty; /** @@ -70,7 +67,7 @@ public class ListBlock extends FObj { } /** - * @see org.apache.fop.fo.FObj#bind(PropertyList) + * {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { super.bind(pList); @@ -87,7 +84,7 @@ public class ListBlock extends FObj { } /** - * @see org.apache.fop.fo.FONode#startOfNode + * {@inheritDoc} */ protected void startOfNode() throws FOPException { super.startOfNode(); @@ -97,7 +94,7 @@ public class ListBlock extends FObj { /** * Make sure content model satisfied, if so then tell the * FOEventHandler that we are at the end of the flow. - * @see org.apache.fop.fo.FONode#endOfNode + * {@inheritDoc} */ protected void endOfNode() throws FOPException { if (!hasListItem) { @@ -107,7 +104,7 @@ public class ListBlock extends FObj { } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} * XSL Content Model: marker* (list-item)+ */ protected void validateChildNode(Locator loc, String nsURI, String localName) @@ -176,12 +173,12 @@ public class ListBlock extends FObj { return orphanContentLimit; } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "list-block"; } - /** @see org.apache.fop.fo.FObj#getNameId() */ + /** {@inheritDoc} */ public int getNameId() { return FO_LIST_BLOCK; } diff --git a/src/java/org/apache/fop/fo/flow/ListItem.java b/src/java/org/apache/fop/fo/flow/ListItem.java index 35a134571..c09313ef6 100644 --- a/src/java/org/apache/fop/fo/flow/ListItem.java +++ b/src/java/org/apache/fop/fo/flow/ListItem.java @@ -26,11 +26,8 @@ import org.apache.fop.fo.FONode; import org.apache.fop.fo.FObj; import org.apache.fop.fo.PropertyList; import org.apache.fop.fo.ValidationException; -import org.apache.fop.fo.properties.CommonAccessibility; -import org.apache.fop.fo.properties.CommonAural; import org.apache.fop.fo.properties.CommonBorderPaddingBackground; import org.apache.fop.fo.properties.CommonMarginBlock; -import org.apache.fop.fo.properties.CommonRelativePosition; import org.apache.fop.fo.properties.KeepProperty; /** @@ -64,7 +61,7 @@ public class ListItem extends FObj { } /** - * @see org.apache.fop.fo.FObj#bind(PropertyList) + * {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { super.bind(pList); @@ -78,7 +75,7 @@ public class ListItem extends FObj { } /** - * @see org.apache.fop.fo.FONode#startOfNode + * {@inheritDoc} */ protected void startOfNode() throws FOPException { super.startOfNode(); @@ -86,9 +83,7 @@ public class ListItem extends FObj { } /** - * Make sure content model satisfied, if so then tell the - * FOEventHandler that we are at the end of the flow. - * @see org.apache.fop.fo.FONode#endOfNode + * {@inheritDoc} */ protected void endOfNode() throws FOPException { if (label == null || body == null) { @@ -98,7 +93,7 @@ public class ListItem extends FObj { } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} * XSL Content Model: marker* (list-item-label,list-item-body) */ protected void validateChildNode(Locator loc, String nsURI, String localName) @@ -123,7 +118,7 @@ public class ListItem extends FObj { } /** - * @see org.apache.fop.fo.FONode#addChildNode(FONode) + * {@inheritDoc} * @todo see if can/should rely on base class for this * (i.e., add to childNodes instead) */ @@ -196,13 +191,13 @@ public class ListItem extends FObj { return body; } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "list-item"; } /** - * @see org.apache.fop.fo.FObj#getNameId() + * {@inheritDoc} */ public int getNameId() { return FO_LIST_ITEM; diff --git a/src/java/org/apache/fop/fo/flow/ListItemBody.java b/src/java/org/apache/fop/fo/flow/ListItemBody.java index 2c7b9afc1..3d5d4562e 100644 --- a/src/java/org/apache/fop/fo/flow/ListItemBody.java +++ b/src/java/org/apache/fop/fo/flow/ListItemBody.java @@ -35,7 +35,7 @@ public class ListItemBody extends AbstractListItemPart { } /** - * @see org.apache.fop.fo.FONode#startOfNode + * {@inheritDoc} */ protected void startOfNode() throws FOPException { super.startOfNode(); @@ -43,20 +43,20 @@ public class ListItemBody extends AbstractListItemPart { } /** - * @see org.apache.fop.fo.FONode#endOfNode + * {@inheritDoc} */ protected void endOfNode() throws FOPException { super.endOfNode(); getFOEventHandler().endListBody(); } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "list-item-body"; } /** - * @see org.apache.fop.fo.FObj#getNameId() + * {@inheritDoc} */ public int getNameId() { return FO_LIST_ITEM_BODY; diff --git a/src/java/org/apache/fop/fo/flow/ListItemLabel.java b/src/java/org/apache/fop/fo/flow/ListItemLabel.java index 8b9214abf..dcdf1b3a1 100644 --- a/src/java/org/apache/fop/fo/flow/ListItemLabel.java +++ b/src/java/org/apache/fop/fo/flow/ListItemLabel.java @@ -35,7 +35,7 @@ public class ListItemLabel extends AbstractListItemPart { } /** - * @see org.apache.fop.fo.FONode#startOfNode + * {@inheritDoc} */ protected void startOfNode() throws FOPException { super.startOfNode(); @@ -43,20 +43,20 @@ public class ListItemLabel extends AbstractListItemPart { } /** - * @see org.apache.fop.fo.FONode#endOfNode + * {@inheritDoc} */ protected void endOfNode() throws FOPException { super.endOfNode(); getFOEventHandler().endListLabel(); } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "list-item-label"; } /** - * @see org.apache.fop.fo.FObj#getNameId() + * {@inheritDoc} */ public int getNameId() { return FO_LIST_ITEM_LABEL; diff --git a/src/java/org/apache/fop/fo/flow/Marker.java b/src/java/org/apache/fop/fo/flow/Marker.java index 8bc37dc3b..05c9862b2 100644 --- a/src/java/org/apache/fop/fo/flow/Marker.java +++ b/src/java/org/apache/fop/fo/flow/Marker.java @@ -20,7 +20,6 @@ package org.apache.fop.fo.flow; import java.util.Collections; -import java.util.List; import java.util.Map; import org.xml.sax.Attributes; @@ -37,7 +36,7 @@ import org.apache.fop.fo.ValidationException; import org.apache.fop.fo.properties.Property; /** - * Marker formatting object. + * Class modelling the fo:marker object. */ public class Marker extends FObjMixed { // The value of properties relevant for fo:marker. @@ -56,7 +55,7 @@ public class Marker extends FObjMixed { } /** - * @see org.apache.fop.fo.FObj#bind(PropertyList) + * {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { if (findAncestor(FO_FLOW) < 0) { @@ -82,7 +81,7 @@ public class Marker extends FObjMixed { descendantPropertyLists.get(foNode); } - /** @see org.apache.fop.fo.FONode#startOfNode() */ + /** {@inheritDoc} */ protected void startOfNode() { FOEventHandler foEventHandler = getFOEventHandler(); // Push a new property list maker which will make MarkerPropertyLists. @@ -96,7 +95,7 @@ public class Marker extends FObjMixed { }); } - /** @see org.apache.fop.fo.FONode#endOfNode() */ + /** {@inheritDoc} */ protected void endOfNode() throws FOPException { super.endOfNode(); // Pop the MarkerPropertyList maker. @@ -105,7 +104,7 @@ public class Marker extends FObjMixed { } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} * XSL Content Model: (#PCDATA|%inline;|%block;)* * Additionally: "An fo:marker may contain any formatting objects that * are permitted as a replacement of any fo:retrieve-marker that retrieves @@ -130,19 +129,19 @@ public class Marker extends FObjMixed { return markerClassName; } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "marker"; } /** - * @see org.apache.fop.fo.FObj#getNameId() + * {@inheritDoc} */ public int getNameId() { return FO_MARKER; } - /** @see java.lang.Object#toString() */ + /** {@inheritDoc} */ public String toString() { StringBuffer sb = new StringBuffer(super.toString()); sb.append(" {").append(getMarkerClassName()).append("}"); @@ -203,7 +202,6 @@ public class Marker extends FObjMixed { /** * Null implementation; not used by this type of PropertyList - * @see org.apache.fop.fo.PropertyList#putExplicit(int, Property) */ public void putExplicit(int propId, Property value) { //nop @@ -211,14 +209,13 @@ public class Marker extends FObjMixed { /** * Null implementation; not used by this type of PropertyList - * @see org.apache.fop.fo.PropertyList#getExplicit(int) */ public Property getExplicit(int propId) { return null; } /** - * @see org.xml.sax.Attributes#getLength() + * {@inheritDoc} */ public int getLength() { if (attribs == null) { @@ -229,7 +226,7 @@ public class Marker extends FObjMixed { } /** - * @see org.xml.sax.Attributes#getURI(int) + * {@inheritDoc} */ public String getURI(int index) { if (attribs != null @@ -243,7 +240,7 @@ public class Marker extends FObjMixed { } /** - * @see org.xml.sax.Attributes#getLocalName(int) + * {@inheritDoc} */ public String getLocalName(int index) { if (attribs != null @@ -257,7 +254,7 @@ public class Marker extends FObjMixed { } /** - * @see org.xml.sax.Attributes#getQName(int) + * {@inheritDoc} */ public String getQName(int index) { if (attribs != null @@ -272,14 +269,13 @@ public class Marker extends FObjMixed { /** * Default implementation; not used - * @see org.xml.sax.Attributes#getType(int) */ public String getType(int index) { return "CDATA"; } /** - * @see org.xml.sax.Attributes#getValue(int) + * {@inheritDoc} */ public String getValue(int index) { if (attribs != null @@ -293,7 +289,7 @@ public class Marker extends FObjMixed { } /** - * @see org.xml.sax.Attributes#getIndex(String, String) + * {@inheritDoc} */ public int getIndex(String name, String namespace) { int index = -1; @@ -310,7 +306,7 @@ public class Marker extends FObjMixed { } /** - * @see org.xml.sax.Attributes#getIndex(String) + * {@inheritDoc} */ public int getIndex(String qname) { int index = -1; @@ -327,7 +323,6 @@ public class Marker extends FObjMixed { /** * Default implementation; not used - * @see org.xml.sax.Attributes#getType(String, String) */ public String getType(String name, String namespace) { return "CDATA"; @@ -335,14 +330,13 @@ public class Marker extends FObjMixed { /** * Default implementation; not used - * @see org.xml.sax.Attributes#getType(String) */ public String getType(String qname) { return "CDATA"; } /** - * @see org.xml.sax.Attributes#getValue(String, String) + * {@inheritDoc} */ public String getValue(String name, String namespace) { int index = getIndex(name, namespace); @@ -353,7 +347,7 @@ public class Marker extends FObjMixed { } /** - * @see org.xml.sax.Attributes#getValue(String) + * {@inheritDoc} */ public String getValue(String qname) { int index = getIndex(qname); @@ -415,7 +409,7 @@ public class Marker extends FObjMixed { } /** - * @see java.lang.Object#equals(Object) + * {@inheritDoc} */ public boolean equals(Object o) { if (o instanceof MarkerAttribute) { diff --git a/src/java/org/apache/fop/fo/flow/MultiCase.java b/src/java/org/apache/fop/fo/flow/MultiCase.java index a5528a975..42ec9d9d0 100644 --- a/src/java/org/apache/fop/fo/flow/MultiCase.java +++ b/src/java/org/apache/fop/fo/flow/MultiCase.java @@ -23,7 +23,6 @@ import org.apache.fop.apps.FOPException; import org.apache.fop.fo.FONode; import org.apache.fop.fo.FObj; import org.apache.fop.fo.PropertyList; -import org.apache.fop.fo.properties.CommonAccessibility; /** * Class modelling the fo:multi-case object. @@ -31,7 +30,6 @@ import org.apache.fop.fo.properties.CommonAccessibility; */ public class MultiCase extends FObj { // The value of properties relevant for fo:multi-case. - private String id; private int startingState; // private ToBeImplementedProperty caseName; // private ToBeImplementedProperty caseTitle; @@ -54,7 +52,7 @@ public class MultiCase extends FObj { } /** - * @see org.apache.fop.fo.FObj#bind(PropertyList) + * {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { super.bind(pList); @@ -70,13 +68,13 @@ public class MultiCase extends FObj { return startingState; } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "multi-case"; } /** - * @see org.apache.fop.fo.FObj#getNameId() + * {@inheritDoc} */ public int getNameId() { return FO_MULTI_CASE; diff --git a/src/java/org/apache/fop/fo/flow/MultiProperties.java b/src/java/org/apache/fop/fo/flow/MultiProperties.java index 09b0747c0..00cb85dc7 100644 --- a/src/java/org/apache/fop/fo/flow/MultiProperties.java +++ b/src/java/org/apache/fop/fo/flow/MultiProperties.java @@ -26,7 +26,6 @@ import org.apache.fop.apps.FOPException; import org.apache.fop.fo.FONode; import org.apache.fop.fo.FObj; import org.apache.fop.fo.ValidationException; -import org.apache.fop.fo.properties.CommonAccessibility; /** * Class modelling the fo:multi-properties object. @@ -56,9 +55,7 @@ public class MultiProperties extends FObj { } /** - * Make sure content model satisfied, if so then tell the - * FOEventHandler that we are at the end of the flow. - * @see org.apache.fop.fo.FONode#endOfNode + * {@inheritDoc} */ protected void endOfNode() throws FOPException { if (!hasMultiPropertySet || !hasWrapper) { @@ -67,7 +64,7 @@ public class MultiProperties extends FObj { } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} * XSL Content Model: (multi-property-set+, wrapper) */ protected void validateChildNode(Locator loc, String nsURI, String localName) @@ -89,13 +86,13 @@ public class MultiProperties extends FObj { } } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "multi-properties"; } /** - * @see org.apache.fop.fo.FObj#getNameId() + * {@inheritDoc} */ public int getNameId() { return FO_MULTI_PROPERTIES; diff --git a/src/java/org/apache/fop/fo/flow/MultiPropertySet.java b/src/java/org/apache/fop/fo/flow/MultiPropertySet.java index 29ab86810..3c9c55b4f 100644 --- a/src/java/org/apache/fop/fo/flow/MultiPropertySet.java +++ b/src/java/org/apache/fop/fo/flow/MultiPropertySet.java @@ -51,7 +51,7 @@ public class MultiPropertySet extends FObj { } /** - * @see org.apache.fop.fo.FObj#bind(PropertyList) + * {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { super.bind(pList); @@ -59,7 +59,7 @@ public class MultiPropertySet extends FObj { } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} * XSL Content Model: empty */ protected void validateChildNode(Locator loc, String nsURI, String localName) @@ -67,13 +67,13 @@ public class MultiPropertySet extends FObj { invalidChildError(loc, nsURI, localName); } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "multi-property-set"; } /** - * @see org.apache.fop.fo.FObj#getNameId() + * {@inheritDoc} */ public int getNameId() { return FO_MULTI_PROPERTY_SET; diff --git a/src/java/org/apache/fop/fo/flow/MultiSwitch.java b/src/java/org/apache/fop/fo/flow/MultiSwitch.java index 097b09862..7c70a7346 100644 --- a/src/java/org/apache/fop/fo/flow/MultiSwitch.java +++ b/src/java/org/apache/fop/fo/flow/MultiSwitch.java @@ -27,11 +27,9 @@ import org.apache.fop.fo.FONode; import org.apache.fop.fo.FObj; import org.apache.fop.fo.PropertyList; import org.apache.fop.fo.ValidationException; -import org.apache.fop.fo.properties.CommonAccessibility; /** * Class modelling the fo:multi-switch object. - * @todo needs implementation */ public class MultiSwitch extends FObj { // The value of properties relevant for fo:multi-switch. @@ -55,7 +53,7 @@ public class MultiSwitch extends FObj { } /** - * @see org.apache.fop.fo.FObj#bind(PropertyList) + * {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { super.bind(pList); @@ -64,8 +62,7 @@ public class MultiSwitch extends FObj { /** - * Make sure content model satisfied. - * @see org.apache.fop.fo.FONode#endOfNode + * {@inheritDoc} */ protected void endOfNode() throws FOPException { if (firstChild == null) { @@ -74,7 +71,7 @@ public class MultiSwitch extends FObj { } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} * XSL Content Model: (multi-case+) */ protected void validateChildNode(Locator loc, String nsURI, String localName) @@ -84,13 +81,13 @@ public class MultiSwitch extends FObj { } } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "multi-switch"; } /** - * @see org.apache.fop.fo.FObj#getNameId() + * {@inheritDoc} */ public int getNameId() { return FO_MULTI_SWITCH; diff --git a/src/java/org/apache/fop/fo/flow/MultiToggle.java b/src/java/org/apache/fop/fo/flow/MultiToggle.java index b8466e073..80b36f9f4 100644 --- a/src/java/org/apache/fop/fo/flow/MultiToggle.java +++ b/src/java/org/apache/fop/fo/flow/MultiToggle.java @@ -27,7 +27,6 @@ import org.apache.fop.fo.FONode; import org.apache.fop.fo.FObj; import org.apache.fop.fo.PropertyList; import org.apache.fop.fo.ValidationException; -import org.apache.fop.fo.properties.CommonAccessibility; /** @@ -54,7 +53,7 @@ public class MultiToggle extends FObj { } /** - * @see org.apache.fop.fo.FObj#bind(PropertyList) + * {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { // prSwitchTo = pList.get(PR_SWITCH_TO); @@ -62,7 +61,7 @@ public class MultiToggle extends FObj { } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} * XSL Content Model: (#PCDATA|%inline;|%block;)* */ protected void validateChildNode(Locator loc, String nsURI, String localName) @@ -72,13 +71,13 @@ public class MultiToggle extends FObj { } } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "multi-toggle"; } /** - * @see org.apache.fop.fo.FObj#getNameId() + * {@inheritDoc} */ public int getNameId() { return FO_MULTI_TOGGLE; diff --git a/src/java/org/apache/fop/fo/flow/PageNumber.java b/src/java/org/apache/fop/fo/flow/PageNumber.java index 989df2f88..3eca1e16e 100644 --- a/src/java/org/apache/fop/fo/flow/PageNumber.java +++ b/src/java/org/apache/fop/fo/flow/PageNumber.java @@ -30,14 +30,9 @@ import org.apache.fop.fo.FONode; import org.apache.fop.fo.FObj; import org.apache.fop.fo.PropertyList; import org.apache.fop.fo.ValidationException; -import org.apache.fop.fo.properties.CommonAccessibility; -import org.apache.fop.fo.properties.CommonAural; import org.apache.fop.fo.properties.CommonBorderPaddingBackground; import org.apache.fop.fo.properties.CommonFont; -import org.apache.fop.fo.properties.CommonMarginInline; -import org.apache.fop.fo.properties.CommonRelativePosition; import org.apache.fop.fo.properties.CommonTextDecoration; -import org.apache.fop.fo.properties.KeepProperty; import org.apache.fop.fo.properties.SpaceProperty; /** @@ -83,7 +78,7 @@ public class PageNumber extends FObj { } /** - * @see org.apache.fop.fo.FObj#bind(PropertyList) + * {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { super.bind(pList); @@ -103,7 +98,7 @@ public class PageNumber extends FObj { } /** - * @see org.apache.fop.fo.FONode#startOfNode + * {@inheritDoc} */ protected void startOfNode() throws FOPException { super.startOfNode(); @@ -111,14 +106,14 @@ public class PageNumber extends FObj { } /** - * @see org.apache.fop.fo.FONode#endOfNode + * {@inheritDoc} */ protected void endOfNode() throws FOPException { getFOEventHandler().endPageNumber(this); } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} * XSL Content Model: empty */ protected void validateChildNode(Locator loc, String nsURI, String localName) @@ -181,12 +176,12 @@ public class PageNumber extends FObj { return lineHeight; } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "page-number"; } - /** @see org.apache.fop.fo.FObj#getNameId() */ + /** {@inheritDoc} */ public int getNameId() { return FO_PAGE_NUMBER; } diff --git a/src/java/org/apache/fop/fo/flow/PageNumberCitation.java b/src/java/org/apache/fop/fo/flow/PageNumberCitation.java index d72dd604e..dc824e142 100644 --- a/src/java/org/apache/fop/fo/flow/PageNumberCitation.java +++ b/src/java/org/apache/fop/fo/flow/PageNumberCitation.java @@ -30,14 +30,9 @@ import org.apache.fop.fo.FONode; import org.apache.fop.fo.FObj; import org.apache.fop.fo.PropertyList; import org.apache.fop.fo.ValidationException; -import org.apache.fop.fo.properties.CommonAccessibility; -import org.apache.fop.fo.properties.CommonAural; import org.apache.fop.fo.properties.CommonBorderPaddingBackground; import org.apache.fop.fo.properties.CommonFont; -import org.apache.fop.fo.properties.CommonMarginInline; -import org.apache.fop.fo.properties.CommonRelativePosition; import org.apache.fop.fo.properties.CommonTextDecoration; -import org.apache.fop.fo.properties.KeepProperty; import org.apache.fop.fo.properties.SpaceProperty; /** @@ -87,7 +82,7 @@ public class PageNumberCitation extends FObj { } /** - * @see org.apache.fop.fo.FObj#bind(PropertyList) + * {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { super.bind(pList); @@ -108,7 +103,7 @@ public class PageNumberCitation extends FObj { } /** - * @see org.apache.fop.fo.FONode#startOfNode + * {@inheritDoc} */ protected void startOfNode() throws FOPException { super.startOfNode(); @@ -118,7 +113,7 @@ public class PageNumberCitation extends FObj { } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} * XSL Content Model: empty */ protected void validateChildNode(Locator loc, String nsURI, String localName) @@ -186,12 +181,12 @@ public class PageNumberCitation extends FObj { return refId; } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "page-number-citation"; } - /** @see org.apache.fop.fo.FObj#getNameId() */ + /** {@inheritDoc} */ public int getNameId() { return FO_PAGE_NUMBER_CITATION; } diff --git a/src/java/org/apache/fop/fo/flow/PageNumberCitationLast.java b/src/java/org/apache/fop/fo/flow/PageNumberCitationLast.java index 7bce6cd14..44ef52aec 100644 --- a/src/java/org/apache/fop/fo/flow/PageNumberCitationLast.java +++ b/src/java/org/apache/fop/fo/flow/PageNumberCitationLast.java @@ -38,12 +38,12 @@ public class PageNumberCitationLast extends PageNumberCitation { super(parent); } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "page-number-citation-last"; } - /** @see org.apache.fop.fo.FObj#getNameId() */ + /** {@inheritDoc} */ public int getNameId() { return FO_PAGE_NUMBER_CITATION_LAST; } diff --git a/src/java/org/apache/fop/fo/flow/RetrieveMarker.java b/src/java/org/apache/fop/fo/flow/RetrieveMarker.java index 016f84e47..316d5411a 100644 --- a/src/java/org/apache/fop/fo/flow/RetrieveMarker.java +++ b/src/java/org/apache/fop/fo/flow/RetrieveMarker.java @@ -31,7 +31,7 @@ import org.apache.fop.fo.ValidationException; import org.xml.sax.Locator; /** - * The retrieve-marker formatting object. + * Class modelling the fo:retrieve-marker object. * This will create a layout manager that will retrieve * a marker based on the information. */ @@ -54,7 +54,7 @@ public class RetrieveMarker extends FObjMixed { } /** - * @see org.apache.fop.fo.FObj#bind(PropertyList) + * {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { if (findAncestor(FO_STATIC_CONTENT) < 0) { @@ -75,7 +75,7 @@ public class RetrieveMarker extends FObjMixed { } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} * XSL Content Model: empty */ protected void validateChildNode(Locator loc, String nsURI, String localName) @@ -203,13 +203,13 @@ public class RetrieveMarker extends FObjMixed { return; } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "retrieve-marker"; } /** - * @see org.apache.fop.fo.FObj#getNameId() + * {@inheritDoc} */ public int getNameId() { return FO_RETRIEVE_MARKER; diff --git a/src/java/org/apache/fop/fo/flow/Table.java b/src/java/org/apache/fop/fo/flow/Table.java index dbbfdf94b..b70e5ea21 100644 --- a/src/java/org/apache/fop/fo/flow/Table.java +++ b/src/java/org/apache/fop/fo/flow/Table.java @@ -32,11 +32,8 @@ import org.apache.fop.fo.FObj; import org.apache.fop.fo.PropertyList; import org.apache.fop.fo.StaticPropertyList; import org.apache.fop.fo.ValidationException; -import org.apache.fop.fo.properties.CommonAccessibility; -import org.apache.fop.fo.properties.CommonAural; import org.apache.fop.fo.properties.CommonBorderPaddingBackground; import org.apache.fop.fo.properties.CommonMarginBlock; -import org.apache.fop.fo.properties.CommonRelativePosition; import org.apache.fop.fo.properties.KeepProperty; import org.apache.fop.fo.properties.LengthPairProperty; import org.apache.fop.fo.properties.LengthRangeProperty; @@ -72,8 +69,6 @@ public class Table extends TableFObj { private Length widowContentLimit; private Length orphanContentLimit; - private static final int MINCOLWIDTH = 10000; // 10pt - /** collection of columns in this table */ protected List columns = null; @@ -106,7 +101,7 @@ public class Table extends TableFObj { } /** - * @see org.apache.fop.fo.FObj#bind(PropertyList) + * {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { super.bind(pList); @@ -155,7 +150,7 @@ public class Table extends TableFObj { } /** - * @see org.apache.fop.fo.FONode#startOfNode + * {@inheritDoc} */ protected void startOfNode() throws FOPException { super.startOfNode(); @@ -163,7 +158,7 @@ public class Table extends TableFObj { } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} * XSL Content Model: (marker*,table-column*,table-header?,table-footer?,table-body+) */ protected void validateChildNode(Locator loc, String nsURI, String localName) @@ -212,7 +207,7 @@ public class Table extends TableFObj { } /** - * @see org.apache.fop.fo.FONode#endOfNode + * {@inheritDoc} */ protected void endOfNode() throws FOPException { @@ -236,7 +231,7 @@ public class Table extends TableFObj { } /** - * @see org.apache.fop.fo.FONode#addChildNode(FONode) + * {@inheritDoc} */ protected void addChildNode(FONode child) throws FOPException { @@ -455,12 +450,12 @@ public class Table extends TableFObj { return orphanContentLimit; } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "table"; } - /** @see org.apache.fop.fo.FObj#getNameId() */ + /** {@inheritDoc} */ public int getNameId() { return FO_TABLE; } @@ -496,7 +491,7 @@ public class Table extends TableFObj { } /** - * @see org.apache.fop.fo.flow.TableFObj#flagColumnIndices(int, int) + * {@inheritDoc} */ protected void flagColumnIndices(int start, int end) { for (int i = start; i < end; i++) { @@ -509,7 +504,7 @@ public class Table extends TableFObj { } /** - * @see org.apache.fop.fo.FONode#clone(FONode, boolean) + * {@inheritDoc} */ public FONode clone(FONode parent, boolean removeChildren) throws FOPException { diff --git a/src/java/org/apache/fop/fo/flow/TableAndCaption.java b/src/java/org/apache/fop/fo/flow/TableAndCaption.java index d71f6530a..f9eb5b97f 100644 --- a/src/java/org/apache/fop/fo/flow/TableAndCaption.java +++ b/src/java/org/apache/fop/fo/flow/TableAndCaption.java @@ -25,14 +25,7 @@ import org.xml.sax.Locator; import org.apache.fop.apps.FOPException; import org.apache.fop.fo.FONode; import org.apache.fop.fo.FObj; -import org.apache.fop.fo.PropertyList; import org.apache.fop.fo.ValidationException; -import org.apache.fop.fo.properties.CommonAccessibility; -import org.apache.fop.fo.properties.CommonAural; -import org.apache.fop.fo.properties.CommonBorderPaddingBackground; -import org.apache.fop.fo.properties.CommonMarginBlock; -import org.apache.fop.fo.properties.CommonRelativePosition; -import org.apache.fop.fo.properties.KeepProperty; /** * Class modelling the fo:table-and-caption property. @@ -77,7 +70,7 @@ public class TableAndCaption extends FObj { /** * Make sure content model satisfied, if so then tell the * FOEventHandler that we are at the end of the flow. - * @see org.apache.fop.fo.FONode#endOfNode + * {@inheritDoc} */ protected void endOfNode() throws FOPException { if (!tableFound) { @@ -86,7 +79,7 @@ public class TableAndCaption extends FObj { } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} * XSL Content Model: marker* table-caption? table */ protected void validateChildNode(Locator loc, String nsURI, String localName) @@ -117,13 +110,13 @@ public class TableAndCaption extends FObj { } } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "table-and-caption"; } /** - * @see org.apache.fop.fo.FObj#getNameId() + * {@inheritDoc} */ public int getNameId() { return FO_TABLE_AND_CAPTION; diff --git a/src/java/org/apache/fop/fo/flow/TableBody.java b/src/java/org/apache/fop/fo/flow/TableBody.java index d38d96033..9811a7c15 100644 --- a/src/java/org/apache/fop/fo/flow/TableBody.java +++ b/src/java/org/apache/fop/fo/flow/TableBody.java @@ -21,9 +21,7 @@ package org.apache.fop.fo.flow; // Java import java.util.BitSet; -import java.util.Iterator; import java.util.List; -import java.util.ListIterator; import org.xml.sax.Attributes; import org.xml.sax.Locator; @@ -31,15 +29,9 @@ import org.xml.sax.Locator; import org.apache.fop.apps.FOPException; import org.apache.fop.datatypes.Length; import org.apache.fop.fo.FONode; -import org.apache.fop.fo.FObj; import org.apache.fop.fo.PropertyList; -import org.apache.fop.fo.StaticPropertyList; import org.apache.fop.fo.ValidationException; -import org.apache.fop.fo.flow.TableFObj.PendingSpan; -import org.apache.fop.fo.properties.CommonAccessibility; -import org.apache.fop.fo.properties.CommonAural; import org.apache.fop.fo.properties.CommonBorderPaddingBackground; -import org.apache.fop.fo.properties.CommonRelativePosition; /** * Class modelling the fo:table-body object. @@ -54,8 +46,6 @@ public class TableBody extends TableFObj { // private int visibility; // End of property values - private PropertyList savedPropertyList; - /** * used for validation */ @@ -78,17 +68,15 @@ public class TableBody extends TableFObj { } /** - * @see FObj#bind(PropertyList) + * {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { commonBorderPaddingBackground = pList.getBorderPaddingBackgroundProps(); super.bind(pList); - //Used by convertCellsToRows() - savedPropertyList = pList; } /** - * @see org.apache.fop.fo.FONode#processNode(String, Locator, Attributes, PropertyList) + * {@inheritDoc} */ public void processNode(String elementName, Locator locator, Attributes attlist, PropertyList pList) @@ -108,20 +96,18 @@ public class TableBody extends TableFObj { } /** - * @see org.apache.fop.fo.FONode#startOfNode + * {@inheritDoc} */ protected void startOfNode() throws FOPException { getFOEventHandler().startBody(this); } /** - * @see org.apache.fop.fo.FONode#endOfNode + * {@inheritDoc} */ protected void endOfNode() throws FOPException { if (!inMarker()) { - // clean up - savedPropertyList = null; pendingSpans = null; usedColumnIndices = null; } @@ -136,17 +122,11 @@ public class TableBody extends TableFObj { + "Expected: marker* (table-row+|table-cell+)"); getParent().removeChild(this); } - } - - /* - if (tableCellsFound) { - convertCellsToRows(); - } - */ + } } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} String, String) * XSL Content Model: marker* (table-row+|table-cell+) */ protected void validateChildNode(Locator loc, String nsURI, String localName) @@ -180,7 +160,7 @@ public class TableBody extends TableFObj { } /** - * @see org.apache.fop.fo.FONode#addChildNode(FONode) + * {@inheritDoc} */ protected void addChildNode(FONode child) throws FOPException { if (!inMarker()) { @@ -238,13 +218,13 @@ public class TableBody extends TableFObj { return commonBorderPaddingBackground; } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "table-body"; } /** - * @see org.apache.fop.fo.FObj#getNameId() + * {@inheritDoc} */ public int getNameId() { return FO_TABLE_BODY; @@ -384,7 +364,7 @@ public class TableBody extends TableFObj { } /** - * @see org.apache.fop.fo.flow.TableFObj#flagColumnIndices(int, int) + * {@inheritDoc} */ protected void flagColumnIndices(int start, int end) { for (int i = start; i < end; i++) { diff --git a/src/java/org/apache/fop/fo/flow/TableCaption.java b/src/java/org/apache/fop/fo/flow/TableCaption.java index c1105a41f..dc3188466 100644 --- a/src/java/org/apache/fop/fo/flow/TableCaption.java +++ b/src/java/org/apache/fop/fo/flow/TableCaption.java @@ -23,27 +23,17 @@ package org.apache.fop.fo.flow; import org.xml.sax.Locator; import org.apache.fop.apps.FOPException; -import org.apache.fop.datatypes.Length; import org.apache.fop.fo.FONode; import org.apache.fop.fo.FObj; import org.apache.fop.fo.PropertyList; import org.apache.fop.fo.ValidationException; -import org.apache.fop.fo.properties.CommonAccessibility; -import org.apache.fop.fo.properties.CommonAural; -import org.apache.fop.fo.properties.CommonBorderPaddingBackground; -import org.apache.fop.fo.properties.CommonRelativePosition; -import org.apache.fop.fo.properties.KeepProperty; -import org.apache.fop.fo.properties.LengthRangeProperty; /** * Class modelling the fo:table-caption object. - * @todo needs implementation */ public class TableCaption extends FObj { // The value of properties relevant for fo:table-caption. - private CommonAccessibility commonAccessibility; - private CommonBorderPaddingBackground commonBorderPaddingBackground; // Unused but valid items, commented out for performance: // private CommonAural commonAural; // private CommonRelativePosition commonRelativePosition; @@ -73,25 +63,14 @@ public class TableCaption extends FObj { } /** - * @see org.apache.fop.fo.FObj#bind(PropertyList) + * {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { super.bind(pList); - commonAccessibility = pList.getAccessibilityProps(); - commonBorderPaddingBackground = pList.getBorderPaddingBackgroundProps(); } /** - * @return the Common Border, Padding, and Background Properties. - */ - public CommonBorderPaddingBackground getCommonBorderPaddingBackground() { - return commonBorderPaddingBackground; - } - - /** - * Make sure content model satisfied, if so then tell the - * FOEventHandler that we are at the end of the flow. - * @see org.apache.fop.fo.FONode#endOfNode + * {@inheritDoc} */ protected void endOfNode() throws FOPException { if (firstChild == null) { @@ -100,7 +79,7 @@ public class TableCaption extends FObj { } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} * XSL Content Model: marker* (%block;) */ protected void validateChildNode(Locator loc, String nsURI, String localName) @@ -116,13 +95,13 @@ public class TableCaption extends FObj { } } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "table-caption"; } /** - * @see org.apache.fop.fo.FObj#getNameId() + * {@inheritDoc} */ public int getNameId() { return FO_TABLE_CAPTION; diff --git a/src/java/org/apache/fop/fo/flow/TableCell.java b/src/java/org/apache/fop/fo/flow/TableCell.java index 3d6f5fb3c..585d670d3 100644 --- a/src/java/org/apache/fop/fo/flow/TableCell.java +++ b/src/java/org/apache/fop/fo/flow/TableCell.java @@ -23,20 +23,14 @@ import org.xml.sax.Locator; import org.apache.fop.apps.FOPException; import org.apache.fop.datatypes.Length; -import org.apache.fop.datatypes.Numeric; import org.apache.fop.fo.FONode; import org.apache.fop.fo.PropertyList; import org.apache.fop.fo.ValidationException; -import org.apache.fop.fo.properties.CommonAccessibility; -import org.apache.fop.fo.properties.CommonAural; import org.apache.fop.fo.properties.CommonBorderPaddingBackground; -import org.apache.fop.fo.properties.CommonRelativePosition; -import org.apache.fop.fo.properties.KeepProperty; import org.apache.fop.fo.properties.LengthRangeProperty; /** * Class modelling the fo:table-cell object. - * @todo check need for all instance variables stored here */ public class TableCell extends TableFObj { // The value of properties relevant for fo:table-cell. @@ -73,7 +67,7 @@ public class TableCell extends TableFObj { } /** - * @see org.apache.fop.fo.FObj#bind(PropertyList) + * {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { super.bind(pList); @@ -90,7 +84,7 @@ public class TableCell extends TableFObj { } /** - * @see org.apache.fop.fo.FONode#startOfNode + * {@inheritDoc} */ protected void startOfNode() throws FOPException { super.startOfNode(); @@ -100,7 +94,7 @@ public class TableCell extends TableFObj { /** * Make sure content model satisfied, if so then tell the * FOEventHandler that we are at the end of the flow. - * @see org.apache.fop.fo.FONode#endOfNode + * {@inheritDoc} */ protected void endOfNode() throws FOPException { if (!blockItemFound) { @@ -120,7 +114,7 @@ public class TableCell extends TableFObj { } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} * XSL Content Model: marker* (%block;)+ */ protected void validateChildNode(Locator loc, String nsURI, String localName) @@ -136,7 +130,7 @@ public class TableCell extends TableFObj { } } - /** @see org.apache.fop.fo.FObj#generatesReferenceAreas() */ + /** {@inheritDoc} */ public boolean generatesReferenceAreas() { return true; } @@ -203,13 +197,13 @@ public class TableCell extends TableFObj { return (endsRow == EN_TRUE); } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "table-cell"; } /** - * @see org.apache.fop.fo.FObj#getNameId() + * {@inheritDoc} */ public final int getNameId() { return FO_TABLE_CELL; diff --git a/src/java/org/apache/fop/fo/flow/TableColumn.java b/src/java/org/apache/fop/fo/flow/TableColumn.java index d6868e0d6..30fb494f0 100644 --- a/src/java/org/apache/fop/fo/flow/TableColumn.java +++ b/src/java/org/apache/fop/fo/flow/TableColumn.java @@ -67,7 +67,7 @@ public class TableColumn extends TableFObj { /** - * @see org.apache.fop.fo.FObj#bind(PropertyList) + * {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { commonBorderPaddingBackground = pList.getBorderPaddingBackgroundProps(); @@ -111,21 +111,21 @@ public class TableColumn extends TableFObj { } /** - * @see org.apache.fop.fo.FONode#startOfNode() + * {@inheritDoc} */ protected void startOfNode() throws FOPException { getFOEventHandler().startColumn(this); } /** - * @see org.apache.fop.fo.FONode#endOfNode + * {@inheritDoc} */ protected void endOfNode() throws FOPException { getFOEventHandler().endColumn(this); } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} * XSL Content Model: empty */ protected void validateChildNode(Locator loc, @@ -181,12 +181,12 @@ public class TableColumn extends TableFObj { return numberColumnsSpanned; } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "table-column"; } - /** @see org.apache.fop.fo.FObj#getNameId() */ + /** {@inheritDoc} */ public int getNameId() { return FO_TABLE_COLUMN; } @@ -203,7 +203,7 @@ public class TableColumn extends TableFObj { return defaultColumn; } - /** @see java.lang.Object#toString() */ + /** {@inheritDoc} */ public String toString() { StringBuffer sb = new StringBuffer("fo:table-column"); sb.append(" column-number=").append(getColumnNumber()); diff --git a/src/java/org/apache/fop/fo/flow/TableFObj.java b/src/java/org/apache/fop/fo/flow/TableFObj.java index ee4029cd7..58fbcb447 100644 --- a/src/java/org/apache/fop/fo/flow/TableFObj.java +++ b/src/java/org/apache/fop/fo/flow/TableFObj.java @@ -32,10 +32,9 @@ import org.apache.fop.fo.expr.PropertyException; import org.apache.fop.fo.properties.CommonBorderPaddingBackground; import org.apache.fop.fo.properties.NumberProperty; import org.apache.fop.fo.properties.Property; -import org.apache.fop.fo.properties.PropertyMaker; /** - * Superclass for table-related FOs + * Common base class for table-related FOs */ public abstract class TableFObj extends FObj { @@ -77,7 +76,7 @@ public abstract class TableFObj extends FObj { } /** - * @see FObj#bind(PropertyList) + * {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { super.bind(pList); @@ -105,7 +104,7 @@ public abstract class TableFObj extends FObj { } /** - * @see org.apache.fop.fo.FONode#addChildNode(FONode) + * {@inheritDoc} */ protected void addChildNode(FONode child) throws FOPException { if (!inMarker() @@ -305,7 +304,7 @@ public abstract class TableFObj extends FObj { } /** - * @see PropertyMaker#make(PropertyList) + * {@inheritDoc} */ public Property make(PropertyList propertyList) throws PropertyException { @@ -333,10 +332,7 @@ public abstract class TableFObj extends FObj { * Return the parent's column index (initial value) in case * of a negative or zero value * - * @see org.apache.fop.fo.properties.PropertyMaker#make( - * org.apache.fop.fo.PropertyList, - * java.lang.String, - * org.apache.fop.fo.FObj) + * @see org.apache.fop.fo.properties.PropertyMaker#make(PropertyList, String, FObj) */ public Property make(PropertyList propertyList, String value, FObj fo) throws PropertyException { diff --git a/src/java/org/apache/fop/fo/flow/TableFooter.java b/src/java/org/apache/fop/fo/flow/TableFooter.java index 82c698c0f..a543ca11f 100644 --- a/src/java/org/apache/fop/fo/flow/TableFooter.java +++ b/src/java/org/apache/fop/fo/flow/TableFooter.java @@ -37,14 +37,14 @@ public class TableFooter extends TableBody { } /** - * @see org.apache.fop.fo.FONode#startOfNode + * {@inheritDoc} */ protected void startOfNode() throws FOPException { //getFOEventHandler().startBody(this); } /** - * @see org.apache.fop.fo.FONode#endOfNode + * {@inheritDoc} */ protected void endOfNode() throws FOPException { // getFOEventHandler().endFooter(this); @@ -54,12 +54,12 @@ public class TableFooter extends TableBody { // convertCellsToRows(); } - /** @see org.apache.fop.fo.FObj#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "table-footer"; } - /** @see org.apache.fop.fo.FObj#getNameId() */ + /** {@inheritDoc} */ public int getNameId() { return FO_TABLE_FOOTER; } diff --git a/src/java/org/apache/fop/fo/flow/TableHeader.java b/src/java/org/apache/fop/fo/flow/TableHeader.java index a487dd072..568303c0d 100644 --- a/src/java/org/apache/fop/fo/flow/TableHeader.java +++ b/src/java/org/apache/fop/fo/flow/TableHeader.java @@ -37,14 +37,14 @@ public class TableHeader extends TableBody { } /** - * @see org.apache.fop.fo.FONode#startOfNode + * {@inheritDoc} */ protected void startOfNode() throws FOPException { //getFOEventHandler().startHeader(this); } /** - * @see org.apache.fop.fo.FONode#endOfNode + * {@inheritDoc} */ protected void endOfNode() throws FOPException { // getFOEventHandler().endHeader(this); @@ -54,12 +54,12 @@ public class TableHeader extends TableBody { // convertCellsToRows(); } - /** @see org.apache.fop.fo.FObj#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "table-header"; } - /** @see org.apache.fop.fo.FObj#getNameId() */ + /** {@inheritDoc} */ public int getNameId() { return FO_TABLE_HEADER; } diff --git a/src/java/org/apache/fop/fo/flow/TableRow.java b/src/java/org/apache/fop/fo/flow/TableRow.java index 74661e304..47ce543db 100644 --- a/src/java/org/apache/fop/fo/flow/TableRow.java +++ b/src/java/org/apache/fop/fo/flow/TableRow.java @@ -30,10 +30,7 @@ import org.apache.fop.datatypes.Length; import org.apache.fop.fo.FONode; import org.apache.fop.fo.PropertyList; import org.apache.fop.fo.ValidationException; -import org.apache.fop.fo.properties.CommonAccessibility; -import org.apache.fop.fo.properties.CommonAural; import org.apache.fop.fo.properties.CommonBorderPaddingBackground; -import org.apache.fop.fo.properties.CommonRelativePosition; import org.apache.fop.fo.properties.KeepProperty; import org.apache.fop.fo.properties.LengthRangeProperty; @@ -56,8 +53,6 @@ public class TableRow extends TableFObj { // private CommonRelativePosition commonRelativePosition; // private int visibility; // End of property values - - private boolean setup = false; protected List pendingSpans; protected BitSet usedColumnIndices; @@ -70,9 +65,7 @@ public class TableRow extends TableFObj { super(parent); } - /** - * @see org.apache.fop.fo.FObj#bind(PropertyList) - */ + /** {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { blockProgressionDimension = pList.get(PR_BLOCK_PROGRESSION_DIMENSION).getLengthRange(); @@ -86,10 +79,7 @@ public class TableRow extends TableFObj { super.bind(pList); } - /** - * @see org.apache.fop.fo.FONode#processNode(String, Locator, - * Attributes, PropertyList) - */ + /** {@inheritDoc} */ public void processNode(String elementName, Locator locator, Attributes attlist, PropertyList pList) throws FOPException { if (!inMarker()) { @@ -105,7 +95,7 @@ public class TableRow extends TableFObj { } /** - * @see org.apache.fop.fo.FONode#addChildNode(FONode) + * {@inheritDoc} */ protected void addChildNode(FONode child) throws FOPException { if (!inMarker()) { @@ -143,7 +133,7 @@ public class TableRow extends TableFObj { } /** - * @see org.apache.fop.fo.FONode#startOfNode + * {@inheritDoc} */ protected void startOfNode() throws FOPException { super.startOfNode(); @@ -151,7 +141,7 @@ public class TableRow extends TableFObj { } /** - * @see org.apache.fop.fo.FONode#endOfNode + * {@inheritDoc} */ protected void endOfNode() throws FOPException { if (firstChild == null) { @@ -165,7 +155,7 @@ public class TableRow extends TableFObj { } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} String, String) * XSL Content Model: (table-cell+) */ protected void validateChildNode(Locator loc, String nsURI, @@ -252,12 +242,12 @@ public class TableRow extends TableFObj { return commonBorderPaddingBackground; } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "table-row"; } - /** @see org.apache.fop.fo.FObj#getNameId() */ + /** {@inheritDoc} */ public int getNameId() { return FO_TABLE_ROW; } @@ -294,7 +284,7 @@ public class TableRow extends TableFObj { } /** - * @see org.apache.fop.fo.flow.TableFObj#flagColumnIndices(int, int) + * {@inheritDoc} */ protected void flagColumnIndices(int start, int end) { for (int i = start; i < end; i++) { diff --git a/src/java/org/apache/fop/fo/flow/Wrapper.java b/src/java/org/apache/fop/fo/flow/Wrapper.java index b75ff42cb..c7ca33a10 100644 --- a/src/java/org/apache/fop/fo/flow/Wrapper.java +++ b/src/java/org/apache/fop/fo/flow/Wrapper.java @@ -19,18 +19,15 @@ package org.apache.fop.fo.flow; -// Java -import org.apache.fop.apps.FOPException; import org.apache.fop.fo.FONode; import org.apache.fop.fo.FObjMixed; -import org.apache.fop.fo.PropertyList; import org.apache.fop.fo.ValidationException; import org.xml.sax.Locator; /** - * Implementation for fo:wrapper formatting object. - * The wrapper object serves as - * a property holder for its child node objects. + * Class modelling the fo:wrapper object. + * The wrapper object serves as a property holder for + * its child node objects. */ public class Wrapper extends FObjMixed { // The value of properties relevant for fo:wrapper. @@ -47,7 +44,7 @@ public class Wrapper extends FObjMixed { } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} * XSL Content Model: marker* (#PCDATA|%inline;|%block;)* * Additionally (unimplemented): "An fo:wrapper that is a child of an * fo:multi-properties is only permitted to have children that would @@ -67,14 +64,12 @@ public class Wrapper extends FObjMixed { } } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "wrapper"; } - /** - * @see org.apache.fop.fo.FObj#getNameId() - */ + /** {@inheritDoc} */ public int getNameId() { return FO_WRAPPER; } diff --git a/src/java/org/apache/fop/fo/pagination/ColorProfile.java b/src/java/org/apache/fop/fo/pagination/ColorProfile.java index fe379c6af..9318a8896 100644 --- a/src/java/org/apache/fop/fo/pagination/ColorProfile.java +++ b/src/java/org/apache/fop/fo/pagination/ColorProfile.java @@ -46,7 +46,7 @@ public class ColorProfile extends FObj { } /** - * @see org.apache.fop.fo.FObj#bind(PropertyList) + * {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { src = pList.get(PR_SRC).getString(); @@ -55,7 +55,7 @@ public class ColorProfile extends FObj { } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} XSL 1.0/FOP: EMPTY (no child nodes permitted) */ protected void validateChildNode(Locator loc, String nsURI, String localName) @@ -70,13 +70,13 @@ public class ColorProfile extends FObj { return colorProfileName; } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "color-profile"; } /** - * @see org.apache.fop.fo.FObj#getNameId() + * {@inheritDoc} */ public int getNameId() { return FO_COLOR_PROFILE; diff --git a/src/java/org/apache/fop/fo/pagination/ConditionalPageMasterReference.java b/src/java/org/apache/fop/fo/pagination/ConditionalPageMasterReference.java index 4076140aa..c3d705de2 100644 --- a/src/java/org/apache/fop/fo/pagination/ConditionalPageMasterReference.java +++ b/src/java/org/apache/fop/fo/pagination/ConditionalPageMasterReference.java @@ -52,7 +52,7 @@ public class ConditionalPageMasterReference extends FObj { } /** - * @see org.apache.fop.fo.FObj#bind(PropertyList) + * {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { masterReference = pList.get(PR_MASTER_REFERENCE).getString(); @@ -66,7 +66,7 @@ public class ConditionalPageMasterReference extends FObj { } /** - * @see org.apache.fop.fo.FONode#startOfNode + * {@inheritDoc} */ protected void startOfNode() throws FOPException { getConcreteParent().addConditionalPageMasterReference(this); @@ -77,7 +77,7 @@ public class ConditionalPageMasterReference extends FObj { } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} * XSL Content Model: empty */ protected void validateChildNode(Locator loc, String nsURI, String localName) @@ -154,12 +154,12 @@ public class ConditionalPageMasterReference extends FObj { return this.pagePosition; } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "conditional-page-master-reference"; } - /** @see org.apache.fop.fo.FObj#getNameId() */ + /** {@inheritDoc} */ public int getNameId() { return FO_CONDITIONAL_PAGE_MASTER_REFERENCE; } diff --git a/src/java/org/apache/fop/fo/pagination/Declarations.java b/src/java/org/apache/fop/fo/pagination/Declarations.java index 7232af1ae..9dc282d07 100644 --- a/src/java/org/apache/fop/fo/pagination/Declarations.java +++ b/src/java/org/apache/fop/fo/pagination/Declarations.java @@ -26,7 +26,6 @@ import org.xml.sax.Locator; import org.apache.fop.apps.FOPException; import org.apache.fop.fo.FONode; -import org.apache.fop.fo.FONode.FONodeIterator; import org.apache.fop.fo.FObj; import org.apache.fop.fo.PropertyList; import org.apache.fop.fo.ValidationException; @@ -51,14 +50,14 @@ public class Declarations extends FObj { } /** - * @see org.apache.fop.fo.FObj#bind(PropertyList) + * {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { // No properties defined for fo:declarations } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} * XSL 1.0: (color-profile)+ (and non-XSL NS nodes) * FOP/XSL 1.1: (color-profile)* (and non-XSL NS nodes) */ @@ -74,7 +73,6 @@ public class Declarations extends FObj { /** * At the end of this element sort out the children into * a hashmap of color profiles and a list of extension attachments. - * @see org.apache.fop.fo.FONode#endOfNode() */ protected void endOfNode() throws FOPException { if (firstChild != null) { @@ -109,14 +107,14 @@ public class Declarations extends FObj { } /** - * @see org.apache.fop.fo.FObj#getName() + * {@inheritDoc} */ public String getLocalName() { return "declarations"; } /** - * @see org.apache.fop.fo.FObj#getNameId() + * {@inheritDoc} */ public int getNameId() { return FO_DECLARATIONS; diff --git a/src/java/org/apache/fop/fo/pagination/Flow.java b/src/java/org/apache/fop/fo/pagination/Flow.java index 0962df5d7..fc5d605cc 100644 --- a/src/java/org/apache/fop/fo/pagination/Flow.java +++ b/src/java/org/apache/fop/fo/pagination/Flow.java @@ -46,14 +46,14 @@ public class Flow extends FObj { } /** - * @see org.apache.fop.fo.FObj#bind(PropertyList) + * {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { flowName = pList.get(PR_FLOW_NAME).getString(); } /** - * @see org.apache.fop.fo.FONode#startOfNode + * {@inheritDoc} */ protected void startOfNode() throws FOPException { if (flowName == null || flowName.equals("")) { @@ -83,7 +83,6 @@ public class Flow extends FObj { /** * Make sure content model satisfied, if so then tell the * FOEventHandler that we are at the end of the flow. - * @see org.apache.fop.fo.FONode#endOfNode */ protected void endOfNode() throws FOPException { if (!blockItemFound) { @@ -93,7 +92,7 @@ public class Flow extends FObj { } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} * XSL Content Model: marker* (%block;)+ */ protected void validateChildNode(Locator loc, String nsURI, String localName) @@ -121,13 +120,13 @@ public class Flow extends FObj { return flowName; } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "flow"; } /** - * @see org.apache.fop.fo.FObj#getNameId() + * {@inheritDoc} */ public int getNameId() { return FO_FLOW; diff --git a/src/java/org/apache/fop/fo/pagination/LayoutMasterSet.java b/src/java/org/apache/fop/fo/pagination/LayoutMasterSet.java index e749044bb..54eb29744 100644 --- a/src/java/org/apache/fop/fo/pagination/LayoutMasterSet.java +++ b/src/java/org/apache/fop/fo/pagination/LayoutMasterSet.java @@ -53,14 +53,14 @@ public class LayoutMasterSet extends FObj { } /** - * @see org.apache.fop.fo.FObj#bind(PropertyList) + * {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { // No properties in layout-master-set. } /** - * @see org.apache.fop.fo.FONode#startOfNode + * {@inheritDoc} */ protected void startOfNode() throws FOPException { getRoot().setLayoutMasterSet(this); @@ -69,7 +69,7 @@ public class LayoutMasterSet extends FObj { } /** - * @see org.apache.fop.fo.FONode#endOfNode + * {@inheritDoc} */ protected void endOfNode() throws FOPException { if (firstChild == null) { @@ -79,7 +79,7 @@ public class LayoutMasterSet extends FObj { } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} XSL/FOP: (simple-page-master|page-sequence-master)+ */ protected void validateChildNode(Locator loc, String nsURI, String localName) @@ -215,13 +215,13 @@ public class LayoutMasterSet extends FObj { return false; } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "layout-master-set"; } /** - * @see org.apache.fop.fo.FObj#getNameId() + * {@inheritDoc} */ public int getNameId() { return FO_LAYOUT_MASTER_SET; diff --git a/src/java/org/apache/fop/fo/pagination/PageSequence.java b/src/java/org/apache/fop/fo/pagination/PageSequence.java index 135382800..f8f9f9277 100644 --- a/src/java/org/apache/fop/fo/pagination/PageSequence.java +++ b/src/java/org/apache/fop/fo/pagination/PageSequence.java @@ -92,7 +92,7 @@ public class PageSequence extends FObj { } /** - * @see org.apache.fop.fo.FObj#bind(PropertyList) + * {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { super.bind(pList); @@ -112,7 +112,7 @@ public class PageSequence extends FObj { } /** - * @see org.apache.fop.fo.FONode#startOfNode() + * {@inheritDoc} */ protected void startOfNode() throws FOPException { super.startOfNode(); @@ -136,7 +136,7 @@ public class PageSequence extends FObj { getFOEventHandler().startPageSequence(this); } - /** @see org.apache.fop.fo.FONode#endOfNode() */ + /** {@inheritDoc} */ protected void endOfNode() throws FOPException { if (mainFlow == null) { missingChildElementError("(title?,static-content*,flow)"); @@ -146,7 +146,7 @@ public class PageSequence extends FObj { } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} XSL Content Model: (title?,static-content*,flow) */ protected void validateChildNode(Locator loc, String nsURI, String localName) @@ -177,7 +177,7 @@ public class PageSequence extends FObj { } /** - * @see org.apache.fop.fo.FONode#addChildNode(FONode) + * {@inheritDoc} * @todo see if addChildNode() should also be called for fo's other than * fo:flow. */ @@ -501,12 +501,12 @@ public class PageSequence extends FObj { return masterReference; } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "page-sequence"; } - /** @see org.apache.fop.fo.FObj#getNameId() */ + /** {@inheritDoc} */ public int getNameId() { return FO_PAGE_SEQUENCE; } diff --git a/src/java/org/apache/fop/fo/pagination/PageSequenceMaster.java b/src/java/org/apache/fop/fo/pagination/PageSequenceMaster.java index efca3f740..fd3484ee6 100644 --- a/src/java/org/apache/fop/fo/pagination/PageSequenceMaster.java +++ b/src/java/org/apache/fop/fo/pagination/PageSequenceMaster.java @@ -60,7 +60,7 @@ public class PageSequenceMaster extends FObj { } /** - * @see org.apache.fop.fo.FObj#bind(PropertyList) + * {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { masterName = pList.get(PR_MASTER_NAME).getString(); @@ -71,7 +71,7 @@ public class PageSequenceMaster extends FObj { } /** - * @see org.apache.fop.fo.FONode#startOfNode() + * {@inheritDoc} */ protected void startOfNode() throws FOPException { subSequenceSpecifiers = new java.util.ArrayList(); @@ -80,7 +80,7 @@ public class PageSequenceMaster extends FObj { } /** - * @see org.apache.fop.fo.FONode#endOfNode() + * {@inheritDoc} */ protected void endOfNode() throws FOPException { if (firstChild == null) { @@ -90,7 +90,7 @@ public class PageSequenceMaster extends FObj { } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} * XSL/FOP: (single-page-master-reference|repeatable-page-master-reference| * repeatable-page-master-alternatives)+ */ @@ -224,13 +224,13 @@ public class PageSequenceMaster extends FObj { return pageMaster; } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "page-sequence-master"; } /** - * @see org.apache.fop.fo.FObj#getNameId() + * {@inheritDoc} */ public int getNameId() { return FO_PAGE_SEQUENCE_MASTER; diff --git a/src/java/org/apache/fop/fo/pagination/PageSequenceWrapper.java b/src/java/org/apache/fop/fo/pagination/PageSequenceWrapper.java index b57befaba..94c0314a3 100644 --- a/src/java/org/apache/fop/fo/pagination/PageSequenceWrapper.java +++ b/src/java/org/apache/fop/fo/pagination/PageSequenceWrapper.java @@ -46,7 +46,7 @@ public class PageSequenceWrapper extends FObj { } /** - * @see org.apache.fop.fo.FObj#bind(PropertyList) + * {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { super.bind(pList); @@ -55,7 +55,7 @@ public class PageSequenceWrapper extends FObj { } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} XSL/FOP: (bookmark+) */ protected void validateChildNode(Locator loc, String nsURI, String localName) @@ -76,13 +76,13 @@ public class PageSequenceWrapper extends FObj { return indexKey; } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "page-sequence-wrapper"; } /** - * @see org.apache.fop.fo.FObj#getNameId() + * {@inheritDoc} */ public int getNameId() { return FO_PAGE_SEQUENCE_WRAPPER; diff --git a/src/java/org/apache/fop/fo/pagination/Region.java b/src/java/org/apache/fop/fo/pagination/Region.java index 642a2e490..2516f90d8 100644 --- a/src/java/org/apache/fop/fo/pagination/Region.java +++ b/src/java/org/apache/fop/fo/pagination/Region.java @@ -58,7 +58,7 @@ public abstract class Region extends FObj { } /** - * @see org.apache.fop.fo.FObj#bind(PropertyList) + * {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { commonBorderPaddingBackground = pList.getBorderPaddingBackgroundProps(); @@ -92,7 +92,7 @@ public abstract class Region extends FObj { } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} String, String) * XSL Content Model: empty */ protected void validateChildNode(Locator loc, String nsURI, String localName) @@ -131,7 +131,7 @@ public abstract class Region extends FObj { } /** - * @see org.apache.fop.fo.FObj#generatesReferenceAreas() + * {@inheritDoc} */ public boolean generatesReferenceAreas() { return true; diff --git a/src/java/org/apache/fop/fo/pagination/RegionAfter.java b/src/java/org/apache/fop/fo/pagination/RegionAfter.java index 455f994ed..9459a6637 100644 --- a/src/java/org/apache/fop/fo/pagination/RegionAfter.java +++ b/src/java/org/apache/fop/fo/pagination/RegionAfter.java @@ -41,7 +41,7 @@ public class RegionAfter extends RegionBA { } /** - * @see org.apache.fop.fo.pagination.Region#getViewportRectangle(FODimension, SimplePageMaster) + * {@inheritDoc} */ public Rectangle getViewportRectangle (FODimension reldims, SimplePageMaster spm) { /* Special rules apply to resolving extent as values are resolved relative @@ -83,19 +83,19 @@ public class RegionAfter extends RegionBA { } /** - * @see org.apache.fop.fo.pagination.Region#getDefaultRegionName() + * {@inheritDoc} */ protected String getDefaultRegionName() { return "xsl-region-after"; } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "region-after"; } /** - * @see org.apache.fop.fo.FObj#getNameId() + * {@inheritDoc} */ public int getNameId() { return FO_REGION_AFTER; diff --git a/src/java/org/apache/fop/fo/pagination/RegionBA.java b/src/java/org/apache/fop/fo/pagination/RegionBA.java index fff3fb26f..768af2489 100644 --- a/src/java/org/apache/fop/fo/pagination/RegionBA.java +++ b/src/java/org/apache/fop/fo/pagination/RegionBA.java @@ -43,7 +43,7 @@ public abstract class RegionBA extends SideRegion { } /** - * @see org.apache.fop.fo.FObj#bind(PropertyList) + * {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { super.bind(pList); diff --git a/src/java/org/apache/fop/fo/pagination/RegionBefore.java b/src/java/org/apache/fop/fo/pagination/RegionBefore.java index adb85681b..6115d8dd8 100644 --- a/src/java/org/apache/fop/fo/pagination/RegionBefore.java +++ b/src/java/org/apache/fop/fo/pagination/RegionBefore.java @@ -40,14 +40,14 @@ public class RegionBefore extends RegionBA { } /** - * @see org.apache.fop.fo.pagination.Region#getDefaultRegionName() + * {@inheritDoc} */ protected String getDefaultRegionName() { return "xsl-region-before"; } /** - * @see org.apache.fop.fo.pagination.Region#getViewportRectangle(FODimension, SimplePageMaster) + * {@inheritDoc} */ public Rectangle getViewportRectangle (FODimension reldims, SimplePageMaster spm) { /* Special rules apply to resolving extent as values are resolved relative @@ -86,13 +86,13 @@ public class RegionBefore extends RegionBA { return vpRect; } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "region-before"; } /** - * @see org.apache.fop.fo.FObj#getNameId() + * {@inheritDoc} */ public int getNameId() { return FO_REGION_BEFORE; diff --git a/src/java/org/apache/fop/fo/pagination/RegionBody.java b/src/java/org/apache/fop/fo/pagination/RegionBody.java index d6fbb8d96..4de2dd1b4 100644 --- a/src/java/org/apache/fop/fo/pagination/RegionBody.java +++ b/src/java/org/apache/fop/fo/pagination/RegionBody.java @@ -50,7 +50,7 @@ public class RegionBody extends Region { } /** - * @see org.apache.fop.fo.FObj#bind(PropertyList) + * {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { super.bind(pList); @@ -94,7 +94,7 @@ public class RegionBody extends Region { } /** - * @see org.apache.fop.fo.pagination.Region#getViewportRectangle(FODimension, SimplePageMaster) + * {@inheritDoc} */ public Rectangle getViewportRectangle (FODimension reldims, SimplePageMaster spm) { /* Special rules apply to resolving margins in the page context. @@ -144,19 +144,19 @@ public class RegionBody extends Region { } /** - * @see org.apache.fop.fo.pagination.Region#getDefaultRegionName() + * {@inheritDoc} */ protected String getDefaultRegionName() { return "xsl-region-body"; } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "region-body"; } /** - * @see org.apache.fop.fo.FObj#getNameId() + * {@inheritDoc} */ public int getNameId() { return FO_REGION_BODY; diff --git a/src/java/org/apache/fop/fo/pagination/RegionEnd.java b/src/java/org/apache/fop/fo/pagination/RegionEnd.java index 5420b756b..912be9097 100644 --- a/src/java/org/apache/fop/fo/pagination/RegionEnd.java +++ b/src/java/org/apache/fop/fo/pagination/RegionEnd.java @@ -40,7 +40,7 @@ public class RegionEnd extends RegionSE { } /** - * @see org.apache.fop.fo.pagination.Region#getViewportRectangle(FODimension, SimplePageMaster) + * {@inheritDoc} */ public Rectangle getViewportRectangle (FODimension reldims, SimplePageMaster spm) { /* Special rules apply to resolving extent as values are resolved relative @@ -81,19 +81,19 @@ public class RegionEnd extends RegionSE { } /** - * @see org.apache.fop.fo.pagination.Region#getDefaultRegionName() + * {@inheritDoc} */ protected String getDefaultRegionName() { return "xsl-region-end"; } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "region-end"; } /** - * @see org.apache.fop.fo.FObj#getNameId() + * {@inheritDoc} */ public int getNameId() { return FO_REGION_END; diff --git a/src/java/org/apache/fop/fo/pagination/RegionSE.java b/src/java/org/apache/fop/fo/pagination/RegionSE.java index ac56d6e10..735623352 100644 --- a/src/java/org/apache/fop/fo/pagination/RegionSE.java +++ b/src/java/org/apache/fop/fo/pagination/RegionSE.java @@ -42,7 +42,7 @@ public abstract class RegionSE extends SideRegion { } /** - * @see org.apache.fop.fo.FObj#bind(PropertyList) + * {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { super.bind(pList); diff --git a/src/java/org/apache/fop/fo/pagination/RegionStart.java b/src/java/org/apache/fop/fo/pagination/RegionStart.java index f702c3b78..d78b19c3d 100644 --- a/src/java/org/apache/fop/fo/pagination/RegionStart.java +++ b/src/java/org/apache/fop/fo/pagination/RegionStart.java @@ -40,7 +40,7 @@ public class RegionStart extends RegionSE { } /** - * @see org.apache.fop.fo.pagination.Region#getViewportRectangle(FODimension, SimplePageMaster) + * {@inheritDoc} */ public Rectangle getViewportRectangle (FODimension reldims, SimplePageMaster spm) { /* Special rules apply to resolving extent as values are resolved relative @@ -78,19 +78,19 @@ public class RegionStart extends RegionSE { } /** - * @see org.apache.fop.fo.pagination.Region#getDefaultRegionName() + * {@inheritDoc} */ protected String getDefaultRegionName() { return "xsl-region-start"; } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "region-start"; } /** - * @see org.apache.fop.fo.FObj#getNameId() + * {@inheritDoc} */ public int getNameId() { return FO_REGION_START; diff --git a/src/java/org/apache/fop/fo/pagination/RepeatablePageMasterAlternatives.java b/src/java/org/apache/fop/fo/pagination/RepeatablePageMasterAlternatives.java index 521a70787..012abd11a 100644 --- a/src/java/org/apache/fop/fo/pagination/RepeatablePageMasterAlternatives.java +++ b/src/java/org/apache/fop/fo/pagination/RepeatablePageMasterAlternatives.java @@ -58,14 +58,14 @@ public class RepeatablePageMasterAlternatives extends FObj } /** - * @see org.apache.fop.fo.FObj#bind(PropertyList) + * {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { maximumRepeats = pList.get(PR_MAXIMUM_REPEATS); } /** - * @see org.apache.fop.fo.FONode#startOfNode + * {@inheritDoc} */ protected void startOfNode() throws FOPException { conditionalPageMasterRefs = new java.util.ArrayList(); @@ -81,7 +81,7 @@ public class RepeatablePageMasterAlternatives extends FObj } /** - * @see org.apache.fop.fo.FONode#endOfNode + * {@inheritDoc} */ protected void endOfNode() throws FOPException { if (firstChild == null) { @@ -90,7 +90,7 @@ public class RepeatablePageMasterAlternatives extends FObj } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} XSL/FOP: (conditional-page-master-reference+) */ protected void validateChildNode(Locator loc, String nsURI, String localName) @@ -157,12 +157,12 @@ public class RepeatablePageMasterAlternatives extends FObj } } - /** @see org.apache.fop.fo.pagination.SubSequenceSpecifier#reset() */ + /** {@inheritDoc} */ public void reset() { this.numberConsumed = 0; } - /** @see org.apache.fop.fo.pagination.SubSequenceSpecifier#goToPrevious() */ + /** {@inheritDoc} */ public boolean goToPrevious() { if (numberConsumed == 0) { return false; @@ -172,17 +172,17 @@ public class RepeatablePageMasterAlternatives extends FObj } } - /** @see org.apache.fop.fo.pagination.SubSequenceSpecifier#hasPagePositionLast() */ + /** {@inheritDoc} */ public boolean hasPagePositionLast() { return this.hasPagePositionLast; } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "repeatable-page-master-alternatives"; } - /** @see org.apache.fop.fo.FObj#getNameId() */ + /** {@inheritDoc} */ public int getNameId() { return FO_REPEATABLE_PAGE_MASTER_ALTERNATIVES; } diff --git a/src/java/org/apache/fop/fo/pagination/RepeatablePageMasterReference.java b/src/java/org/apache/fop/fo/pagination/RepeatablePageMasterReference.java index 1f79d317b..dfd6ff6a9 100644 --- a/src/java/org/apache/fop/fo/pagination/RepeatablePageMasterReference.java +++ b/src/java/org/apache/fop/fo/pagination/RepeatablePageMasterReference.java @@ -54,7 +54,7 @@ public class RepeatablePageMasterReference extends FObj } /** - * @see org.apache.fop.fo.FObj#bind(PropertyList) + * {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { masterReference = pList.get(PR_MASTER_REFERENCE).getString(); @@ -66,7 +66,7 @@ public class RepeatablePageMasterReference extends FObj } /** - * @see org.apache.fop.fo.FONode#startOfNode + * {@inheritDoc} */ protected void startOfNode() throws FOPException { PageSequenceMaster pageSequenceMaster = (PageSequenceMaster) parent; @@ -79,7 +79,7 @@ public class RepeatablePageMasterReference extends FObj } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} * XSL Content Model: empty */ protected void validateChildNode(Locator loc, String nsURI, String localName) @@ -88,7 +88,7 @@ public class RepeatablePageMasterReference extends FObj } /** - * @see org.apache.fop.fo.pagination.SubSequenceSpecifier + * {@inheritDoc} */ public String getNextPageMasterName(boolean isOddPage, boolean isFirstPage, @@ -119,13 +119,13 @@ public class RepeatablePageMasterReference extends FObj } } - /** @see org.apache.fop.fo.pagination.SubSequenceSpecifier#reset() */ + /** {@inheritDoc} */ public void reset() { this.numberConsumed = 0; } - /** @see org.apache.fop.fo.pagination.SubSequenceSpecifier#goToPrevious() */ + /** {@inheritDoc} */ public boolean goToPrevious() { if (numberConsumed == 0) { return false; @@ -135,17 +135,17 @@ public class RepeatablePageMasterReference extends FObj } } - /** @see org.apache.fop.fo.pagination.SubSequenceSpecifier#hasPagePositionLast() */ + /** {@inheritDoc} */ public boolean hasPagePositionLast() { return false; } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "repeatable-page-master-reference"; } - /** @see org.apache.fop.fo.FObj#getNameId() */ + /** {@inheritDoc} */ public int getNameId() { return FO_REPEATABLE_PAGE_MASTER_REFERENCE; } diff --git a/src/java/org/apache/fop/fo/pagination/Root.java b/src/java/org/apache/fop/fo/pagination/Root.java index 929c721ec..2e2c38b82 100644 --- a/src/java/org/apache/fop/fo/pagination/Root.java +++ b/src/java/org/apache/fop/fo/pagination/Root.java @@ -73,7 +73,7 @@ public class Root extends FObj { } /** - * @see org.apache.fop.fo.FObj#bind(PropertyList) + * {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { mediaUsage = pList.get(PR_MEDIA_USAGE).getEnum(); @@ -90,7 +90,7 @@ public class Root extends FObj { } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} XSL 1.0 Spec: (layout-master-set,declarations?,page-sequence+) FOP: (layout-master-set, declarations?, fox:bookmarks?, page-sequence+) */ @@ -281,19 +281,19 @@ public class Root extends FObj { } /** - * @see org.apache.fop.fo.FONode#getRoot() + * {@inheritDoc} */ public Root getRoot() { return this; } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "root"; } /** - * @see org.apache.fop.fo.FObj#getNameId() + * {@inheritDoc} */ public int getNameId() { return FO_ROOT; diff --git a/src/java/org/apache/fop/fo/pagination/SideRegion.java b/src/java/org/apache/fop/fo/pagination/SideRegion.java index 41786c83d..14328aa9b 100644 --- a/src/java/org/apache/fop/fo/pagination/SideRegion.java +++ b/src/java/org/apache/fop/fo/pagination/SideRegion.java @@ -36,7 +36,7 @@ public abstract class SideRegion extends Region { super(parent); } - /** @see org.apache.fop.fo.FObj#bind(PropertyList) */ + /** {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { super.bind(pList); extent = pList.get(PR_EXTENT).getLength(); diff --git a/src/java/org/apache/fop/fo/pagination/SimplePageMaster.java b/src/java/org/apache/fop/fo/pagination/SimplePageMaster.java index e26d27d63..ba1c0a6af 100644 --- a/src/java/org/apache/fop/fo/pagination/SimplePageMaster.java +++ b/src/java/org/apache/fop/fo/pagination/SimplePageMaster.java @@ -70,7 +70,7 @@ public class SimplePageMaster extends FObj { } /** - * @see org.apache.fop.fo.FObj#bind + * {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { commonMarginBlock = pList.getMarginBlockProps(); @@ -86,7 +86,7 @@ public class SimplePageMaster extends FObj { } /** - * @see org.apache.fop.fo.FONode#startOfNode + * {@inheritDoc} */ protected void startOfNode() throws FOPException { LayoutMasterSet layoutMasterSet = (LayoutMasterSet) parent; @@ -103,7 +103,6 @@ public class SimplePageMaster extends FObj { /** * Make sure content model satisfied. - * @see org.apache.fop.fo.FONode#endOfNode */ protected void endOfNode() throws FOPException { if (!hasRegionBody) { @@ -113,7 +112,7 @@ public class SimplePageMaster extends FObj { } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} * XSL Content Model: (region-body,region-before?,region-after?,region-start?,region-end?) */ protected void validateChildNode(Locator loc, String nsURI, String localName) @@ -174,14 +173,14 @@ public class SimplePageMaster extends FObj { } /** - * @see org.apache.fop.fo.FObj#generatesReferenceAreas() + * {@inheritDoc} */ public boolean generatesReferenceAreas() { return true; } /** - * @see org.apache.fop.fo.FONode#addChildNode(FONode) + * {@inheritDoc} */ protected void addChildNode(FONode child) throws FOPException { if (child instanceof Region) { @@ -264,13 +263,13 @@ public class SimplePageMaster extends FObj { return referenceOrientation.getValue(); } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "simple-page-master"; } /** - * @see org.apache.fop.fo.FObj#getNameId() + * {@inheritDoc} */ public int getNameId() { return FO_SIMPLE_PAGE_MASTER; diff --git a/src/java/org/apache/fop/fo/pagination/SinglePageMasterReference.java b/src/java/org/apache/fop/fo/pagination/SinglePageMasterReference.java index 623b50de7..68be2b82e 100644 --- a/src/java/org/apache/fop/fo/pagination/SinglePageMasterReference.java +++ b/src/java/org/apache/fop/fo/pagination/SinglePageMasterReference.java @@ -54,7 +54,7 @@ public class SinglePageMasterReference extends FObj } /** - * @see org.apache.fop.fo.FObj#bind(PropertyList) + * {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { masterReference = pList.get(PR_MASTER_REFERENCE).getString(); @@ -65,7 +65,7 @@ public class SinglePageMasterReference extends FObj } /** - * @see org.apache.fop.fo.FONode#startOfNode + * {@inheritDoc} */ protected void startOfNode() throws FOPException { PageSequenceMaster pageSequenceMaster = (PageSequenceMaster) parent; @@ -73,7 +73,7 @@ public class SinglePageMasterReference extends FObj } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} * XSL Content Model: empty */ protected void validateChildNode(Locator loc, String nsURI, String localName) @@ -81,7 +81,7 @@ public class SinglePageMasterReference extends FObj invalidChildError(loc, nsURI, localName); } - /** @see org.apache.fop.fo.pagination.SubSequenceSpecifier */ + /** {@inheritDoc} */ public String getNextPageMasterName(boolean isOddPage, boolean isFirstPage, boolean isLastPage, @@ -94,14 +94,14 @@ public class SinglePageMasterReference extends FObj } } - /** @see org.apache.fop.fo.pagination.SubSequenceSpecifier#reset() */ + /** {@inheritDoc} */ public void reset() { this.state = FIRST; } - /** @see org.apache.fop.fo.pagination.SubSequenceSpecifier#goToPrevious() */ + /** {@inheritDoc} */ public boolean goToPrevious() { if (state == FIRST) { return false; @@ -111,17 +111,17 @@ public class SinglePageMasterReference extends FObj } } - /** @see org.apache.fop.fo.pagination.SubSequenceSpecifier#hasPagePositionLast() */ + /** {@inheritDoc} */ public boolean hasPagePositionLast() { return false; } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "single-page-master-reference"; } - /** @see org.apache.fop.fo.FObj#getNameId() */ + /** {@inheritDoc} */ public int getNameId() { return FO_SINGLE_PAGE_MASTER_REFERENCE; } diff --git a/src/java/org/apache/fop/fo/pagination/StaticContent.java b/src/java/org/apache/fop/fo/pagination/StaticContent.java index cd55609cd..62d73e56d 100644 --- a/src/java/org/apache/fop/fo/pagination/StaticContent.java +++ b/src/java/org/apache/fop/fo/pagination/StaticContent.java @@ -39,7 +39,7 @@ public class StaticContent extends Flow { } /** - * @see org.apache.fop.fo.FONode#startOfNode() + * {@inheritDoc} */ protected void startOfNode() throws FOPException { if (getFlowName() == null || getFlowName().equals("")) { @@ -52,7 +52,7 @@ public class StaticContent extends Flow { /** * Make sure content model satisfied, if so then tell the * FOEventHandler that we are at the end of the flow. - * @see org.apache.fop.fo.FONode#endOfNode + * {@inheritDoc} */ protected void endOfNode() throws FOPException { if (firstChild == null && getUserAgent().validateStrictly()) { @@ -62,7 +62,7 @@ public class StaticContent extends Flow { } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} * XSL Content Model: (%block;)+ */ protected void validateChildNode(Locator loc, String nsURI, String localName) @@ -72,12 +72,12 @@ public class StaticContent extends Flow { } } - /** @see org.apache.fop.fo.FObj#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "static-content"; } - /** @see org.apache.fop.fo.FObj#getNameId() */ + /** {@inheritDoc} */ public int getNameId() { return FO_STATIC_CONTENT; } diff --git a/src/java/org/apache/fop/fo/pagination/Title.java b/src/java/org/apache/fop/fo/pagination/Title.java index 92c6e8f24..398424152 100644 --- a/src/java/org/apache/fop/fo/pagination/Title.java +++ b/src/java/org/apache/fop/fo/pagination/Title.java @@ -42,7 +42,7 @@ public class Title extends InlineLevel { } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} String, String) XSL/FOP: (#PCDATA|%inline;)* */ protected void validateChildNode(Locator loc, String nsURI, String localName) @@ -53,14 +53,14 @@ public class Title extends InlineLevel { } /** - * @see org.apache.fop.fo.FObj#getName() + * {@inheritDoc} */ public String getLocalName() { return "title"; } /** - * @see org.apache.fop.fo.FObj#getNameId() + * {@inheritDoc} */ public int getNameId() { return FO_TITLE; diff --git a/src/java/org/apache/fop/fo/pagination/bookmarks/Bookmark.java b/src/java/org/apache/fop/fo/pagination/bookmarks/Bookmark.java index 9786a3db9..e588bb3f8 100644 --- a/src/java/org/apache/fop/fo/pagination/bookmarks/Bookmark.java +++ b/src/java/org/apache/fop/fo/pagination/bookmarks/Bookmark.java @@ -26,7 +26,6 @@ import org.apache.fop.fo.FObj; import org.apache.fop.fo.FONode; import org.apache.fop.fo.PropertyList; import org.apache.fop.fo.ValidationException; -import org.apache.fop.fo.properties.CommonAccessibility; /** @@ -39,10 +38,13 @@ public class Bookmark extends FObj { private ArrayList childBookmarks = new ArrayList(); // The value of properties relevant for this FO - private CommonAccessibility commonAccessibility; private String internalDestination; private String externalDestination; private boolean bShow = true; // from starting-state property + + // Valid, but unused properties. Commented out for performance + // private CommonAccessibility commonAccessibility; + /** * Create a new bookmark object. @@ -54,10 +56,9 @@ public class Bookmark extends FObj { } /** - * @see org.apache.fop.fo.FObj#bind(PropertyList) + * {@inheritDoc} */ public void bind(PropertyList pList) throws FOPException { - commonAccessibility = pList.getAccessibilityProps(); externalDestination = pList.get(PR_EXTERNAL_DESTINATION).getString(); internalDestination = pList.get(PR_INTERNAL_DESTINATION).getString(); bShow = (pList.get(PR_STARTING_STATE).getEnum() == EN_SHOW); @@ -75,7 +76,7 @@ public class Bookmark extends FObj { } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} XSL/FOP: (bookmark-title, bookmark*) */ protected void validateChildNode(Locator loc, String nsURI, String localName) @@ -94,7 +95,7 @@ public class Bookmark extends FObj { } /** - * @see org.apache.fop.fo.FONode#endOfNode + * {@inheritDoc} */ protected void endOfNode() throws FOPException { if (bookmarkTitle == null) { @@ -103,7 +104,7 @@ public class Bookmark extends FObj { } /** - * @see org.apache.fop.fo.FONode#addChildNode(FONode) + * {@inheritDoc} */ protected void addChildNode(FONode obj) { if (obj instanceof BookmarkTitle) { @@ -144,13 +145,13 @@ public class Bookmark extends FObj { return childBookmarks; } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "bookmark"; } /** - * @see org.apache.fop.fo.FObj#getNameId() + * {@inheritDoc} */ public int getNameId() { return FO_BOOKMARK; diff --git a/src/java/org/apache/fop/fo/pagination/bookmarks/BookmarkTitle.java b/src/java/org/apache/fop/fo/pagination/bookmarks/BookmarkTitle.java index b7c5fc8c5..f31aad1cb 100644 --- a/src/java/org/apache/fop/fo/pagination/bookmarks/BookmarkTitle.java +++ b/src/java/org/apache/fop/fo/pagination/bookmarks/BookmarkTitle.java @@ -60,7 +60,7 @@ public class BookmarkTitle extends FObj { } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} XSL/FOP: empty */ protected void validateChildNode(Locator loc, String nsURI, String localName) @@ -77,13 +77,13 @@ public class BookmarkTitle extends FObj { return title; } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "bookmark-title"; } /** - * @see org.apache.fop.fo.FObj#getNameId() + * {@inheritDoc} */ public int getNameId() { return FO_BOOKMARK_TITLE; diff --git a/src/java/org/apache/fop/fo/pagination/bookmarks/BookmarkTree.java b/src/java/org/apache/fop/fo/pagination/bookmarks/BookmarkTree.java index 1b743d763..6190fa22a 100644 --- a/src/java/org/apache/fop/fo/pagination/bookmarks/BookmarkTree.java +++ b/src/java/org/apache/fop/fo/pagination/bookmarks/BookmarkTree.java @@ -46,7 +46,7 @@ public class BookmarkTree extends FObj { } /** - * @see org.apache.fop.fo.FONode#addChildNode(FONode) + * {@inheritDoc} */ protected void addChildNode(FONode obj) { if (obj instanceof Bookmark) { @@ -55,7 +55,7 @@ public class BookmarkTree extends FObj { } /** - * @see org.apache.fop.fo.FONode#endOfNode + * {@inheritDoc} */ protected void endOfNode() throws FOPException { if (bookmarks == null) { @@ -65,7 +65,7 @@ public class BookmarkTree extends FObj { } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} XSL/FOP: (bookmark+) */ protected void validateChildNode(Locator loc, String nsURI, String localName) @@ -80,13 +80,13 @@ public class BookmarkTree extends FObj { return bookmarks; } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "bookmark-tree"; } /** - * @see org.apache.fop.fo.FObj#getNameId() + * {@inheritDoc} */ public int getNameId() { return FO_BOOKMARK_TREE; diff --git a/src/java/org/apache/fop/fo/properties/BackgroundPositionShorthandParser.java b/src/java/org/apache/fop/fo/properties/BackgroundPositionShorthandParser.java index 8bf79a242..76c934234 100644 --- a/src/java/org/apache/fop/fo/properties/BackgroundPositionShorthandParser.java +++ b/src/java/org/apache/fop/fo/properties/BackgroundPositionShorthandParser.java @@ -31,7 +31,7 @@ import org.apache.fop.fo.expr.PropertyException; public class BackgroundPositionShorthandParser extends GenericShorthandParser { /** - * @see org.apache.fop.fo.properties.ShorthandParser#getValueForProperty(int, Property, PropertyMaker, PropertyList) + * {@inheritDoc} */ public Property getValueForProperty(int propId, Property property, diff --git a/src/java/org/apache/fop/fo/properties/BorderWidthPropertyMaker.java b/src/java/org/apache/fop/fo/properties/BorderWidthPropertyMaker.java index 819cae5d0..b828de285 100644 --- a/src/java/org/apache/fop/fo/properties/BorderWidthPropertyMaker.java +++ b/src/java/org/apache/fop/fo/properties/BorderWidthPropertyMaker.java @@ -50,7 +50,7 @@ public class BorderWidthPropertyMaker extends LengthProperty.Maker { /** * Check the value of the style property and return a length of 0 when * the style is NONE. - * @see org.apache.fop.fo.properties.PropertyMaker#get(int, PropertyList, boolean, boolean) + * {@inheritDoc} */ public Property get(int subpropId, PropertyList propertyList, diff --git a/src/java/org/apache/fop/fo/properties/BoxPropShorthandParser.java b/src/java/org/apache/fop/fo/properties/BoxPropShorthandParser.java index f568e5123..c71bc830f 100644 --- a/src/java/org/apache/fop/fo/properties/BoxPropShorthandParser.java +++ b/src/java/org/apache/fop/fo/properties/BoxPropShorthandParser.java @@ -38,7 +38,7 @@ public class BoxPropShorthandParser extends GenericShorthandParser { * Stores 1 to 4 values of same type. * Set the given property based on the number of values set. * Example: padding, border-width, border-color, border-style, margin - * @see org.apache.fop.fo.properties.GenericShorthandParser#convertValueForProperty( + * {@inheritDoc} * int, Property, PropertyMaker, PropertyList) */ protected Property convertValueForProperty(int propId, diff --git a/src/java/org/apache/fop/fo/properties/ColorProperty.java b/src/java/org/apache/fop/fo/properties/ColorProperty.java index c49546862..5eb399d3d 100644 --- a/src/java/org/apache/fop/fo/properties/ColorProperty.java +++ b/src/java/org/apache/fop/fo/properties/ColorProperty.java @@ -65,9 +65,6 @@ public class ColorProperty extends Property { * can't be converted to the correct type. * @throws PropertyException * for invalid or inconsistent FO input - * @see org.apache.fop.fo.properties.PropertyMaker#convertProperty( - * org.apache.fop.fo.properties.Property, - * org.apache.fop.fo.PropertyList, org.apache.fop.fo.FObj) */ public Property convertProperty(Property p, PropertyList propertyList, FObj fo) @@ -93,7 +90,7 @@ public class ColorProperty extends Property { * @param foUserAgent FOP user agent * @param value RGB value as String to be parsed * @throws PropertyException if the value can't be parsed - * @see ColorUtil#parseColorString(String) + * @see ColorUtil#parseColorString(FOUserAgent, String) */ public ColorProperty(FOUserAgent foUserAgent, String value) throws PropertyException { this.color = ColorUtil.parseColorString(foUserAgent, value); @@ -118,7 +115,7 @@ public class ColorProperty extends Property { } /** - * @see java.lang.Object#toString() + * {@inheritDoc} */ public String toString() { return ColorUtil.colorToString(color); diff --git a/src/java/org/apache/fop/fo/properties/CommonBorderPaddingBackground.java b/src/java/org/apache/fop/fo/properties/CommonBorderPaddingBackground.java index 8697cc978..712ae9703 100755 --- a/src/java/org/apache/fop/fo/properties/CommonBorderPaddingBackground.java +++ b/src/java/org/apache/fop/fo/properties/CommonBorderPaddingBackground.java @@ -111,7 +111,7 @@ public class CommonBorderPaddingBackground { } } - /** @see java.lang.Object#toString() */ + /** {@inheritDoc} */ public String toString() { StringBuffer sb = new StringBuffer("BorderInfo"); sb.append(" {"); @@ -367,7 +367,7 @@ public class CommonBorderPaddingBackground { + getBorderBeforeWidth(bDiscard) + getBorderAfterWidth(bDiscard); } - /** @see java.lang.Object#toString() */ + /** {@inheritDoc} */ public String toString() { return "CommonBordersAndPadding (Before, After, Start, End):\n" + "Borders: (" + getBorderBeforeWidth(false) + ", " + getBorderAfterWidth(false) + ", " diff --git a/src/java/org/apache/fop/fo/properties/CommonFont.java b/src/java/org/apache/fop/fo/properties/CommonFont.java index 8c157e45e..d0d38223f 100755 --- a/src/java/org/apache/fop/fo/properties/CommonFont.java +++ b/src/java/org/apache/fop/fo/properties/CommonFont.java @@ -30,7 +30,6 @@ import org.apache.fop.fo.PropertyList; import org.apache.fop.fo.expr.PropertyException; import org.apache.fop.fonts.Font; import org.apache.fop.fonts.FontInfo; -import org.apache.fop.fonts.FontMetrics; import org.apache.fop.fonts.FontTriplet; /** diff --git a/src/java/org/apache/fop/fo/properties/CommonMarginBlock.java b/src/java/org/apache/fop/fo/properties/CommonMarginBlock.java index 93d0868e0..6ca9e5817 100644 --- a/src/java/org/apache/fop/fo/properties/CommonMarginBlock.java +++ b/src/java/org/apache/fop/fo/properties/CommonMarginBlock.java @@ -87,7 +87,7 @@ public class CommonMarginBlock { endIndent = pList.get(Constants.PR_END_INDENT).getLength(); } - /** @see java.lang.Object#toString() */ + /** {@inheritDoc} */ public String toString() { return "CommonMarginBlock:\n" + "Margins (top, bottom, left, right): (" diff --git a/src/java/org/apache/fop/fo/properties/CompoundPropertyMaker.java b/src/java/org/apache/fop/fo/properties/CompoundPropertyMaker.java index 39b2289a9..9852d5fdf 100644 --- a/src/java/org/apache/fop/fo/properties/CompoundPropertyMaker.java +++ b/src/java/org/apache/fop/fo/properties/CompoundPropertyMaker.java @@ -55,7 +55,7 @@ public class CompoundPropertyMaker extends PropertyMaker { } /** - * @see org.apache.fop.fo.properties.PropertyMaker#useGeneric(PropertyMaker) + * {@inheritDoc} */ public void useGeneric(PropertyMaker generic) { super.useGeneric(generic); diff --git a/src/java/org/apache/fop/fo/properties/CondLengthProperty.java b/src/java/org/apache/fop/fo/properties/CondLengthProperty.java index 638f525b1..34e72b09d 100644 --- a/src/java/org/apache/fop/fo/properties/CondLengthProperty.java +++ b/src/java/org/apache/fop/fo/properties/CondLengthProperty.java @@ -32,7 +32,7 @@ import org.apache.fop.fo.expr.PropertyException; */ public class CondLengthProperty extends Property implements CompoundDatatype { private Property length; - private Property conditionality; + private EnumProperty conditionality; /** * Inner class for creating instances of CondLengthProperty @@ -55,7 +55,7 @@ public class CondLengthProperty extends Property implements CompoundDatatype { } /** - * @see CompoundPropertyMaker#convertProperty + * {@inheritDoc} */ public Property convertProperty(Property p, PropertyList propertyList, FObj fo) throws PropertyException { @@ -67,19 +67,19 @@ public class CondLengthProperty extends Property implements CompoundDatatype { } /** - * @see org.apache.fop.datatypes.CompoundDatatype#setComponent(int, Property, boolean) + * {@inheritDoc} */ public void setComponent(int cmpId, Property cmpnValue, boolean bIsDefault) { if (cmpId == CP_LENGTH) { length = cmpnValue; } else if (cmpId == CP_CONDITIONALITY) { - conditionality = cmpnValue; + conditionality = (EnumProperty)cmpnValue; } } /** - * @see org.apache.fop.datatypes.CompoundDatatype#getComponent(int) + * {@inheritDoc} */ public Property getComponent(int cmpId) { if (cmpId == CP_LENGTH) { @@ -132,7 +132,7 @@ public class CondLengthProperty extends Property implements CompoundDatatype { return this.length.getLength().getValue(context); } - /** @see java.lang.Object#toString() */ + /** {@inheritDoc} */ public String toString() { return "CondLength[" + length.getObject().toString() + ", " + (isDiscard() diff --git a/src/java/org/apache/fop/fo/properties/EnumLength.java b/src/java/org/apache/fop/fo/properties/EnumLength.java index efa1475ab..95b759356 100755 --- a/src/java/org/apache/fop/fo/properties/EnumLength.java +++ b/src/java/org/apache/fop/fo/properties/EnumLength.java @@ -32,7 +32,7 @@ public class EnumLength extends LengthProperty { } /** - * @see org.apache.fop.datatypes.Numeric#getEnum() + * {@inheritDoc} */ public int getEnum() { return enumProperty.getEnum(); @@ -43,7 +43,7 @@ public class EnumLength extends LengthProperty { } /** - * @see org.apache.fop.datatypes.Numeric#getValue() + * {@inheritDoc} */ public int getValue() { log.error("getValue() called on " + enumProperty + " length"); @@ -51,7 +51,7 @@ public class EnumLength extends LengthProperty { } /** - * @see org.apache.fop.datatypes.Numeric#getValue(PercentBaseContext) + * {@inheritDoc} */ public int getValue(PercentBaseContext context) { log.error("getValue() called on " + enumProperty + " length"); @@ -59,7 +59,7 @@ public class EnumLength extends LengthProperty { } /** - * @see org.apache.fop.datatypes.Numeric#getNumericValue() + * {@inheritDoc} */ public double getNumericValue() { log.error("getNumericValue() called on " + enumProperty + " number"); @@ -67,7 +67,7 @@ public class EnumLength extends LengthProperty { } /** - * @see org.apache.fop.datatypes.Numeric#getNumericValue() + * {@inheritDoc} */ public double getNumericValue(PercentBaseContext context) { log.error("getNumericValue() called on " + enumProperty + " number"); @@ -75,14 +75,14 @@ public class EnumLength extends LengthProperty { } /** - * @see org.apache.fop.fo.properties.Property#getString() + * {@inheritDoc} */ public String getString() { return enumProperty.toString(); } /** - * @see org.apache.fop.fo.properties.Property#getString() + * {@inheritDoc} */ public Object getObject() { return enumProperty.getObject(); diff --git a/src/java/org/apache/fop/fo/properties/EnumNumber.java b/src/java/org/apache/fop/fo/properties/EnumNumber.java index f8e940b01..fcd596d7e 100755 --- a/src/java/org/apache/fop/fo/properties/EnumNumber.java +++ b/src/java/org/apache/fop/fo/properties/EnumNumber.java @@ -72,21 +72,21 @@ public class EnumNumber extends NumberProperty { } /** - * @see org.apache.fop.fo.properties.Property#getString() + * {@inheritDoc} */ public String getString() { return enumProperty.toString(); } /** - * @see org.apache.fop.fo.properties.Property#getString() + * {@inheritDoc} */ public Object getObject() { return enumProperty.getObject(); } /** - * @see java.lang.Object#equals(Object) + * {@inheritDoc} */ public boolean equals(Object obj) { if (obj instanceof EnumNumber) { @@ -97,7 +97,7 @@ public class EnumNumber extends NumberProperty { } /** - * @see java.lang.Object#hashCode() + * {@inheritDoc} */ public int hashCode() { return enumProperty.hashCode(); diff --git a/src/java/org/apache/fop/fo/properties/EnumProperty.java b/src/java/org/apache/fop/fo/properties/EnumProperty.java index f9801e222..b5435b0f1 100644 --- a/src/java/org/apache/fop/fo/properties/EnumProperty.java +++ b/src/java/org/apache/fop/fo/properties/EnumProperty.java @@ -97,7 +97,7 @@ public class EnumProperty extends Property { } /** - * @see java.lang.Object#equals(Object) + * {@inheritDoc} */ public boolean equals(Object obj) { if (obj instanceof EnumProperty) { @@ -112,7 +112,7 @@ public class EnumProperty extends Property { } /** - * @see java.lang.Object#hashCode() + * {@inheritDoc} */ public int hashCode() { return value + text.hashCode(); diff --git a/src/java/org/apache/fop/fo/properties/FixedLength.java b/src/java/org/apache/fop/fo/properties/FixedLength.java index 80016ba2e..7acc899bf 100644 --- a/src/java/org/apache/fop/fo/properties/FixedLength.java +++ b/src/java/org/apache/fop/fo/properties/FixedLength.java @@ -45,7 +45,8 @@ public class FixedLength extends LengthProperty { * to the computed value * @param numUnits input units * @param units unit specifier - * @return + * @return the canonical FixedLength instance corresponding + * to the given number of units and unit specifier */ public static FixedLength getInstance(double numUnits, String units) { return (FixedLength) cache.fetch( @@ -105,28 +106,28 @@ public class FixedLength extends LengthProperty { } /** - * @see org.apache.fop.datatypes.Numeric#getValue() + * {@inheritDoc} */ public int getValue() { return millipoints; } /** - * @see org.apache.fop.datatypes.Numeric#getValue(PercentBaseContext) + * {@inheritDoc} */ public int getValue(PercentBaseContext context) { return millipoints; } /** - * @see org.apache.fop.datatypes.Numeric#getNumericValue() + * {@inheritDoc} */ public double getNumericValue() { return millipoints; } /** - * @see org.apache.fop.datatypes.Numeric#getNumericValue(PercentBaseContext) + * {@inheritDoc} */ public double getNumericValue(PercentBaseContext context) { return millipoints; @@ -134,21 +135,21 @@ public class FixedLength extends LengthProperty { /** * Return true since FixedLength are always absolute. - * @see org.apache.fop.datatypes.Numeric#isAbsolute() + * {@inheritDoc} */ public boolean isAbsolute() { return true; } /** - * @see java.lang.Object#toString() + * {@inheritDoc} */ public String toString() { return millipoints + "mpt"; } /** - * @see java.lang.Object#equals(Object) + * {@inheritDoc} */ public boolean equals(Object obj) { if (obj instanceof EnumProperty) { @@ -159,7 +160,7 @@ public class FixedLength extends LengthProperty { } /** - * @see java.lang.Object#hashCode() + * {@inheritDoc} */ public int hashCode() { return millipoints; diff --git a/src/java/org/apache/fop/fo/properties/FontFamilyProperty.java b/src/java/org/apache/fop/fo/properties/FontFamilyProperty.java index 58cbc6402..1b31351b8 100644 --- a/src/java/org/apache/fop/fo/properties/FontFamilyProperty.java +++ b/src/java/org/apache/fop/fo/properties/FontFamilyProperty.java @@ -41,7 +41,7 @@ public class FontFamilyProperty extends ListProperty { } /** - * @see org.apache.fop.fo.properties.PropertyMaker#make( + * {@inheritDoc} * org.apache.fop.fo.PropertyList, * java.lang.String, * org.apache.fop.fo.FObj) @@ -94,7 +94,7 @@ public class FontFamilyProperty extends ListProperty { } /** - * @see PropertyMaker#convertProperty + * {@inheritDoc} */ public Property convertProperty(Property p, PropertyList propertyList, FObj fo) { @@ -127,7 +127,7 @@ public class FontFamilyProperty extends ListProperty { } } - /** @see org.apache.fop.fo.properties.Property#getString() */ + /** {@inheritDoc} */ public String getString() { if (list.size() > 0) { Property first = (Property)list.get(0); diff --git a/src/java/org/apache/fop/fo/properties/FontShorthandParser.java b/src/java/org/apache/fop/fo/properties/FontShorthandParser.java index b07bd0629..89e029c5e 100644 --- a/src/java/org/apache/fop/fo/properties/FontShorthandParser.java +++ b/src/java/org/apache/fop/fo/properties/FontShorthandParser.java @@ -20,8 +20,6 @@ package org.apache.fop.fo.properties; import org.apache.fop.fo.Constants; -import org.apache.fop.fo.FObj; -import org.apache.fop.fo.FOPropertyMapping; import org.apache.fop.fo.PropertyList; import org.apache.fop.fo.expr.PropertyException; @@ -31,7 +29,7 @@ import org.apache.fop.fo.expr.PropertyException; public class FontShorthandParser extends GenericShorthandParser { /** - * @see org.apache.fop.fo.properties.ShorthandParser#getValueForProperty(int, Property, PropertyMaker, PropertyList) + * {@inheritDoc} */ public Property getValueForProperty(int propId, Property property, diff --git a/src/java/org/apache/fop/fo/properties/FontShorthandProperty.java b/src/java/org/apache/fop/fo/properties/FontShorthandProperty.java index 69177ad29..638f77338 100644 --- a/src/java/org/apache/fop/fo/properties/FontShorthandProperty.java +++ b/src/java/org/apache/fop/fo/properties/FontShorthandProperty.java @@ -48,7 +48,7 @@ public class FontShorthandProperty extends ListProperty { } /** - * @see PropertyMaker#make(PropertyList, String, FObj) + * {@inheritDoc} */ public Property make(PropertyList propertyList, String value, FObj fo) throws PropertyException { diff --git a/src/java/org/apache/fop/fo/properties/FontSizePropertyMaker.java b/src/java/org/apache/fop/fo/properties/FontSizePropertyMaker.java index cc39359c9..012a80b1a 100644 --- a/src/java/org/apache/fop/fo/properties/FontSizePropertyMaker.java +++ b/src/java/org/apache/fop/fo/properties/FontSizePropertyMaker.java @@ -44,7 +44,7 @@ public class FontSizePropertyMaker } /** - * @see PropertyMaker#convertProperty + * {@inheritDoc} * Implements the parts of 7.8.4 relevant to relative font sizes */ public Property convertProperty(Property p, diff --git a/src/java/org/apache/fop/fo/properties/FontStretchPropertyMaker.java b/src/java/org/apache/fop/fo/properties/FontStretchPropertyMaker.java index 719ed43e8..82f152ff5 100644 --- a/src/java/org/apache/fop/fo/properties/FontStretchPropertyMaker.java +++ b/src/java/org/apache/fop/fo/properties/FontStretchPropertyMaker.java @@ -43,7 +43,7 @@ public class FontStretchPropertyMaker } /** - * @see PropertyMaker#convertProperty + * {@inheritDoc} * Implements the parts of 7.8.5 relevant to relative font stretches */ public Property convertProperty(Property p, diff --git a/src/java/org/apache/fop/fo/properties/FontWeightPropertyMaker.java b/src/java/org/apache/fop/fo/properties/FontWeightPropertyMaker.java index 64155e14c..173b28f7c 100644 --- a/src/java/org/apache/fop/fo/properties/FontWeightPropertyMaker.java +++ b/src/java/org/apache/fop/fo/properties/FontWeightPropertyMaker.java @@ -14,7 +14,7 @@ * See the License for the specific language governing permissions and * limitations under the License. * -/* $Id:$ */ +/* $Id$ */ package org.apache.fop.fo.properties; @@ -36,7 +36,7 @@ public class FontWeightPropertyMaker extends EnumProperty.Maker { } /** - * @see org.apache.fop.fo.properties.PropertyMaker#make(PropertyList, String, FObj) + * {@inheritDoc} */ public Property make(PropertyList pList, String value, FObj fo) throws PropertyException { diff --git a/src/java/org/apache/fop/fo/properties/GenericShorthandParser.java b/src/java/org/apache/fop/fo/properties/GenericShorthandParser.java index 766c9e896..5802112bc 100644 --- a/src/java/org/apache/fop/fo/properties/GenericShorthandParser.java +++ b/src/java/org/apache/fop/fo/properties/GenericShorthandParser.java @@ -49,7 +49,7 @@ public class GenericShorthandParser implements ShorthandParser { } /** - * @see org.apache.fop.fo.properties.ShorthandParser#getValueForProperty(int, Property, PropertyMaker, PropertyList) + * {@inheritDoc} */ public Property getValueForProperty(int propId, Property property, diff --git a/src/java/org/apache/fop/fo/properties/KeepProperty.java b/src/java/org/apache/fop/fo/properties/KeepProperty.java index fe3566d41..9ac33fad3 100644 --- a/src/java/org/apache/fop/fo/properties/KeepProperty.java +++ b/src/java/org/apache/fop/fo/properties/KeepProperty.java @@ -53,7 +53,7 @@ public class KeepProperty extends Property implements CompoundDatatype { } /** - * @see CompoundPropertyMaker#convertProperty + * {@inheritDoc} */ public Property convertProperty(Property p, PropertyList propertyList, FObj fo) throws PropertyException @@ -66,7 +66,7 @@ public class KeepProperty extends Property implements CompoundDatatype { } /** - * @see org.apache.fop.datatypes.CompoundDatatype#setComponent(int, Property, boolean) + * {@inheritDoc} */ public void setComponent(int cmpId, Property cmpnValue, boolean bIsDefault) { @@ -80,7 +80,7 @@ public class KeepProperty extends Property implements CompoundDatatype { } /** - * @see org.apache.fop.datatypes.CompoundDatatype#getComponent(int) + * {@inheritDoc} */ public Property getComponent(int cmpId) { if (cmpId == CP_WITHIN_LINE) { diff --git a/src/java/org/apache/fop/fo/properties/LengthPairProperty.java b/src/java/org/apache/fop/fo/properties/LengthPairProperty.java index b5e8722e9..f89b7d8b7 100644 --- a/src/java/org/apache/fop/fo/properties/LengthPairProperty.java +++ b/src/java/org/apache/fop/fo/properties/LengthPairProperty.java @@ -52,7 +52,7 @@ public class LengthPairProperty extends Property implements CompoundDatatype { } /** - * @see CompoundPropertyMaker#convertProperty + * {@inheritDoc} */ public Property convertProperty(Property p, PropertyList propertyList, FObj fo) throws PropertyException { @@ -91,7 +91,7 @@ public class LengthPairProperty extends Property implements CompoundDatatype { } /** - * @see org.apache.fop.datatypes.CompoundDatatype#setComponent(int, Property, boolean) + * {@inheritDoc} */ public void setComponent(int cmpId, Property cmpnValue, boolean bIsDefault) { @@ -103,7 +103,7 @@ public class LengthPairProperty extends Property implements CompoundDatatype { } /** - * @see org.apache.fop.datatypes.CompoundDatatype#getComponent(int) + * {@inheritDoc} */ public Property getComponent(int cmpId) { if (cmpId == CP_BLOCK_PROGRESSION_DIRECTION) { @@ -129,7 +129,7 @@ public class LengthPairProperty extends Property implements CompoundDatatype { return this.bpd; } - /** @see java.lang.Object#toString() */ + /** {@inheritDoc} */ public String toString() { return "LengthPair[" + "ipd:" + getIPD().getObject() diff --git a/src/java/org/apache/fop/fo/properties/LengthProperty.java b/src/java/org/apache/fop/fo/properties/LengthProperty.java index 8b5565e68..7e7b37e06 100644 --- a/src/java/org/apache/fop/fo/properties/LengthProperty.java +++ b/src/java/org/apache/fop/fo/properties/LengthProperty.java @@ -37,6 +37,8 @@ public abstract class LengthProperty extends Property public static class Maker extends PropertyMaker { /** + * Constructor + * * @param propId the id of the property for which a Maker should be created */ public Maker(int propId) { @@ -44,9 +46,7 @@ public abstract class LengthProperty extends Property } /** - * @see org.apache.fop.fo.properties.PropertyMaker#convertProperty( - * org.apache.fop.fo.properties.Property, org.apache.fop.fo.PropertyList, - * org.apache.fop.fo.FObj) + * {@inheritDoc} */ public Property convertProperty(Property p, PropertyList propertyList, diff --git a/src/java/org/apache/fop/fo/properties/LengthRangeProperty.java b/src/java/org/apache/fop/fo/properties/LengthRangeProperty.java index 68f85056e..acce6f564 100644 --- a/src/java/org/apache/fop/fo/properties/LengthRangeProperty.java +++ b/src/java/org/apache/fop/fo/properties/LengthRangeProperty.java @@ -66,7 +66,7 @@ public class LengthRangeProperty extends Property implements CompoundDatatype { } /** - * @see CompoundPropertyMaker#convertProperty + * {@inheritDoc} */ public Property convertProperty(Property p, PropertyList propertyList, FObj fo) @@ -94,7 +94,7 @@ public class LengthRangeProperty extends Property implements CompoundDatatype { /** - * @see org.apache.fop.fo.properties.PropertyMaker#getSubprop(Property, int, Property) + * {@inheritDoc} */ protected Property setSubprop(Property baseProperty, int subpropertyId, Property subproperty) { @@ -121,7 +121,7 @@ public class LengthRangeProperty extends Property implements CompoundDatatype { /** - * @see org.apache.fop.datatypes.CompoundDatatype#setComponent(int, Property, boolean) + * {@inheritDoc} */ public void setComponent(int cmpId, Property cmpnValue, boolean bIsDefault) { @@ -135,7 +135,7 @@ public class LengthRangeProperty extends Property implements CompoundDatatype { } /** - * @see org.apache.fop.datatypes.CompoundDatatype#getComponent(int) + * {@inheritDoc} */ public Property getComponent(int cmpId) { if (cmpId == CP_MINIMUM) { @@ -277,7 +277,7 @@ public class LengthRangeProperty extends Property implements CompoundDatatype { return this.optimum; } - /** @see java.lang.Object#toString() */ + /** {@inheritDoc} */ public String toString() { return "LengthRange[" + "min:" + getMinimum(null).getObject() diff --git a/src/java/org/apache/fop/fo/properties/LineHeightPropertyMaker.java b/src/java/org/apache/fop/fo/properties/LineHeightPropertyMaker.java index c2eaeedc4..dcb8fd176 100644 --- a/src/java/org/apache/fop/fo/properties/LineHeightPropertyMaker.java +++ b/src/java/org/apache/fop/fo/properties/LineHeightPropertyMaker.java @@ -44,8 +44,7 @@ public class LineHeightPropertyMaker extends SpaceProperty.Maker { } /** - * @see PropertyMaker#make(PropertyList, String, FObj) - * @throws PropertyException + * {@inheritDoc} */ public Property make(PropertyList propertyList, String value, FObj fo) throws PropertyException { @@ -63,7 +62,6 @@ public class LineHeightPropertyMaker extends SpaceProperty.Maker { /** * Recalculate the line-height value based on the nearest specified * value. - * @see PropertyMaker#compute(PropertyList) */ protected Property compute(PropertyList propertyList) throws PropertyException { // recalculate based on last specified value @@ -80,7 +78,7 @@ public class LineHeightPropertyMaker extends SpaceProperty.Maker { } /** - * @see SpaceProperty.Maker#convertProperty(Property, PropertyList, FObj) + * {@inheritDoc} */ public Property convertProperty(Property p, PropertyList propertyList, diff --git a/src/java/org/apache/fop/fo/properties/ListProperty.java b/src/java/org/apache/fop/fo/properties/ListProperty.java index 530ef5723..46d8c9496 100644 --- a/src/java/org/apache/fop/fo/properties/ListProperty.java +++ b/src/java/org/apache/fop/fo/properties/ListProperty.java @@ -42,7 +42,7 @@ public class ListProperty extends Property { } /** - * @see PropertyMaker#convertProperty + * {@inheritDoc} */ public Property convertProperty(Property p, PropertyList propertyList, FObj fo) { diff --git a/src/java/org/apache/fop/fo/properties/NumberProperty.java b/src/java/org/apache/fop/fo/properties/NumberProperty.java index 55206cff7..c4ecd4a69 100644 --- a/src/java/org/apache/fop/fo/properties/NumberProperty.java +++ b/src/java/org/apache/fop/fo/properties/NumberProperty.java @@ -48,8 +48,7 @@ public class NumberProperty extends Property implements Numeric { } /** - * @throws PropertyException - * @see PropertyMaker#convertProperty + * {@inheritDoc} */ public Property convertProperty(Property p, PropertyList propertyList, FObj fo) @@ -134,7 +133,6 @@ public class NumberProperty extends Property implements Numeric { /** * Plain number always has a dimension of 0. * @return a dimension of 0. - * @see Numeric#getDimension() */ public int getDimension() { return 0; @@ -143,7 +141,6 @@ public class NumberProperty extends Property implements Numeric { /** * Return the value of this Numeric. * @return The value as a double. - * @see Numeric#getNumericValue() */ public double getNumericValue() { return number.doubleValue(); @@ -153,13 +150,12 @@ public class NumberProperty extends Property implements Numeric { * Return the value of this Numeric. * @param context Evaluation context * @return The value as a double. - * @see Numeric#getNumericValue(PercentBaseContext) */ public double getNumericValue(PercentBaseContext context) { return getNumericValue(); } - /** @see org.apache.fop.datatypes.Numeric#getValue() */ + /** {@inheritDoc} */ public int getValue() { return number.intValue(); } @@ -168,7 +164,6 @@ public class NumberProperty extends Property implements Numeric { * Return the value * @param context Evaluation context * @return The value as an int. - * @see Numeric#getValue(PercentBaseContext) */ public int getValue(PercentBaseContext context) { return getValue(); @@ -177,7 +172,6 @@ public class NumberProperty extends Property implements Numeric { /** * Return true because all numbers are absolute. * @return true. - * @see Numeric#isAbsolute() */ public boolean isAbsolute() { return true; @@ -205,7 +199,7 @@ public class NumberProperty extends Property implements Numeric { return this; } - /** @see org.apache.fop.fo.properties.Property#getLength() */ + /** {@inheritDoc} */ public Length getLength() { //Assume pixels (like in HTML) when there's no unit return FixedLength.getInstance(getNumericValue(), "px"); diff --git a/src/java/org/apache/fop/fo/properties/PageBreakShorthandParser.java b/src/java/org/apache/fop/fo/properties/PageBreakShorthandParser.java index c2bf559a2..f04cdd3cc 100644 --- a/src/java/org/apache/fop/fo/properties/PageBreakShorthandParser.java +++ b/src/java/org/apache/fop/fo/properties/PageBreakShorthandParser.java @@ -30,7 +30,7 @@ import org.apache.fop.fo.expr.PropertyException; public class PageBreakShorthandParser implements ShorthandParser { /** - * @see org.apache.fop.fo.properties.ShorthandParser#getValueForProperty(int, Property, PropertyMaker, PropertyList) + * {@inheritDoc} */ public Property getValueForProperty(int propId, Property property, diff --git a/src/java/org/apache/fop/fo/properties/PageDimensionMaker.java b/src/java/org/apache/fop/fo/properties/PageDimensionMaker.java index b41c3e87b..839ac7022 100644 --- a/src/java/org/apache/fop/fo/properties/PageDimensionMaker.java +++ b/src/java/org/apache/fop/fo/properties/PageDimensionMaker.java @@ -45,7 +45,7 @@ public class PageDimensionMaker extends LengthProperty.Maker { * Return the default or user-defined fallback in case the value * was specified as "auto" * - * @see org.apache.fop.fo.properties.PropertyMaker#get(int, PropertyList, boolean, boolean) + * @see PropertyMaker#get(int, PropertyList, boolean, boolean) */ public Property get(int subpropId, PropertyList propertyList, boolean tryInherit, boolean tryDefault) diff --git a/src/java/org/apache/fop/fo/properties/PercentLength.java b/src/java/org/apache/fop/fo/properties/PercentLength.java index a1865d7cd..e63d527a7 100644 --- a/src/java/org/apache/fop/fo/properties/PercentLength.java +++ b/src/java/org/apache/fop/fo/properties/PercentLength.java @@ -74,21 +74,21 @@ public class PercentLength extends LengthProperty { /** * Return false because percent-length are always relative. - * @see org.apache.fop.datatypes.Numeric#isAbsolute() + * {@inheritDoc} */ public boolean isAbsolute() { return false; } /** - * @see org.apache.fop.datatypes.Numeric#getNumericValue() + * {@inheritDoc} */ public double getNumericValue() { return getNumericValue(null); } /** - * @see org.apache.fop.datatypes.Numeric#getNumericValue(PercentBaseContext) + * {@inheritDoc} */ public double getNumericValue(PercentBaseContext context) { try { @@ -102,14 +102,14 @@ public class PercentLength extends LengthProperty { /** * Return the length of this PercentLength. - * @see org.apache.fop.datatypes.Length#getValue() + * {@inheritDoc} */ public int getValue() { return (int) getNumericValue(); } /** - * @see org.apache.fop.datatypes.Numeric#getValue(PercentBaseContext) + * {@inheritDoc} */ public int getValue(PercentBaseContext context) { return (int) getNumericValue(context); diff --git a/src/java/org/apache/fop/fo/properties/PositionShorthandParser.java b/src/java/org/apache/fop/fo/properties/PositionShorthandParser.java index a6a9671da..5f2468ed6 100755 --- a/src/java/org/apache/fop/fo/properties/PositionShorthandParser.java +++ b/src/java/org/apache/fop/fo/properties/PositionShorthandParser.java @@ -29,7 +29,7 @@ import org.apache.fop.fo.PropertyList; public class PositionShorthandParser implements ShorthandParser { /** - * @see org.apache.fop.fo.properties.ShorthandParser#getValueForProperty(int, Property, PropertyMaker, PropertyList) + * {@inheritDoc} */ public Property getValueForProperty(int propId, Property property, diff --git a/src/java/org/apache/fop/fo/properties/Property.java b/src/java/org/apache/fop/fo/properties/Property.java index 0cab9da01..5aef1b881 100644 --- a/src/java/org/apache/fop/fo/properties/Property.java +++ b/src/java/org/apache/fop/fo/properties/Property.java @@ -191,7 +191,7 @@ public class Property { return null; } - /** @see java.lang.Object#toString() */ + /** {@inheritDoc} */ public String toString() { Object obj = getObject(); if (obj != this) { diff --git a/src/java/org/apache/fop/fo/properties/PropertyCache.java b/src/java/org/apache/fop/fo/properties/PropertyCache.java index 176cdd4aa..0685ff514 100644 --- a/src/java/org/apache/fop/fo/properties/PropertyCache.java +++ b/src/java/org/apache/fop/fo/properties/PropertyCache.java @@ -39,7 +39,7 @@ public class PropertyCache { * Checks if the given property is present in the cache - if so, returns * a reference to the cached value. Otherwise the given object is added * to the cache and returned. - * @param obj + * @param prop the Property instance to check for * @return the cached instance */ public Property fetch(Property prop) { diff --git a/src/java/org/apache/fop/fo/properties/PropertyMaker.java b/src/java/org/apache/fop/fo/properties/PropertyMaker.java index a5373ef50..3faf1971e 100644 --- a/src/java/org/apache/fop/fo/properties/PropertyMaker.java +++ b/src/java/org/apache/fop/fo/properties/PropertyMaker.java @@ -283,7 +283,7 @@ public class PropertyMaker implements Cloneable { * inheritable, to return the inherited value. If all else fails, it returns * the default value. * @param subpropertyId The subproperty id of the property being retrieved. - * Is 0 when retriving a base property. + * Is 0 when retrieving a base property. * @param propertyList The PropertyList object being built for this FO. * @param tryInherit true if inherited properties should be examined. * @param tryDefault true if the default value should be returned. @@ -315,7 +315,6 @@ public class PropertyMaker implements Cloneable { * box. * Overridden by subclasses which allow percent specifications. See * the documentation on properties.xsl for details. - * @param fo the FObj containing the PercentBase * @param pl the PropertyList containing the property. (TODO: explain * what this is used for, or remove it from the signature.) * @return an object implementing the PercentBase interface. @@ -525,7 +524,8 @@ public class PropertyMaker implements Cloneable { */ protected Property checkEnumValues(String value) { if (enums != null) { - return (Property) enums.get(value); + Property p = (Property) enums.get(value); + return p; } return null; } @@ -651,7 +651,7 @@ public class PropertyMaker implements Cloneable { /** * Return a clone of the makers. Used by useGeneric() to clone the * subproperty makers of the generic compound makers. - * @see java.lang.Object#clone() + * {@inheritDoc} */ public Object clone() { try { diff --git a/src/java/org/apache/fop/fo/properties/ReferenceOrientationMaker.java b/src/java/org/apache/fop/fo/properties/ReferenceOrientationMaker.java index 124b2e559..505afccd5 100644 --- a/src/java/org/apache/fop/fo/properties/ReferenceOrientationMaker.java +++ b/src/java/org/apache/fop/fo/properties/ReferenceOrientationMaker.java @@ -31,7 +31,6 @@ public class ReferenceOrientationMaker extends Maker { /** * Constructor * @param propId the Constant Id for the property to be made - * @see org.apache.fop.fo.properties.NumberProperty.Maker#PropertyMaker(propId) */ public ReferenceOrientationMaker(int propId) { super(propId); @@ -40,7 +39,7 @@ public class ReferenceOrientationMaker extends Maker { /** * Check the value of the reference-orientation property. * - * @see org.apache.fop.fo.properties.PropertyMaker#get(int, PropertyList, boolean, boolean) + * {@inheritDoc} */ public Property get(int subpropId, PropertyList propertyList, boolean tryInherit, boolean tryDefault) diff --git a/src/java/org/apache/fop/fo/properties/SpaceProperty.java b/src/java/org/apache/fop/fo/properties/SpaceProperty.java index 9ad809cbd..98caa04ff 100644 --- a/src/java/org/apache/fop/fo/properties/SpaceProperty.java +++ b/src/java/org/apache/fop/fo/properties/SpaceProperty.java @@ -54,7 +54,7 @@ public class SpaceProperty extends LengthRangeProperty { } /** - * @see CompoundPropertyMaker#convertProperty + * {@inheritDoc} */ public Property convertProperty(Property p, PropertyList propertyList, @@ -69,7 +69,7 @@ public class SpaceProperty extends LengthRangeProperty { /** - * @see org.apache.fop.datatypes.CompoundDatatype#setComponent(int, Property, boolean) + * {@inheritDoc} */ public void setComponent(int cmpId, Property cmpnValue, boolean bIsDefault) { @@ -83,7 +83,7 @@ public class SpaceProperty extends LengthRangeProperty { } /** - * @see org.apache.fop.datatypes.CompoundDatatype#getComponent(int) + * {@inheritDoc} */ public Property getComponent(int cmpId) { if (cmpId == CP_PRECEDENCE) { diff --git a/src/java/org/apache/fop/fo/properties/SpacePropertyMaker.java b/src/java/org/apache/fop/fo/properties/SpacePropertyMaker.java index e5c572952..a4f0c412e 100644 --- a/src/java/org/apache/fop/fo/properties/SpacePropertyMaker.java +++ b/src/java/org/apache/fop/fo/properties/SpacePropertyMaker.java @@ -37,7 +37,7 @@ public class SpacePropertyMaker extends CorrespondingPropertyMaker { } /** - * @see org.apache.fop.fo.properties.CorrespondingPropertyMaker#compute(PropertyList) + * {@inheritDoc} */ public Property compute(PropertyList propertyList) throws PropertyException { Property prop = super.compute(propertyList); diff --git a/src/java/org/apache/fop/fo/properties/StringProperty.java b/src/java/org/apache/fop/fo/properties/StringProperty.java index 691942d78..a38840352 100644 --- a/src/java/org/apache/fop/fo/properties/StringProperty.java +++ b/src/java/org/apache/fop/fo/properties/StringProperty.java @@ -116,7 +116,7 @@ public class StringProperty extends Property { } /** - * @see java.lang.Object#hashCode() + * {@inheritDoc} */ public boolean equals(Object obj) { if (obj instanceof StringProperty) { @@ -129,7 +129,7 @@ public class StringProperty extends Property { } /** - * @see java.lang.Object#hashCode() + * {@inheritDoc} */ public int hashCode() { return str.hashCode(); diff --git a/src/java/org/apache/fop/fo/properties/TableBorderPrecedence.java b/src/java/org/apache/fop/fo/properties/TableBorderPrecedence.java index dff9626a1..181dd00d5 100644 --- a/src/java/org/apache/fop/fo/properties/TableBorderPrecedence.java +++ b/src/java/org/apache/fop/fo/properties/TableBorderPrecedence.java @@ -40,7 +40,7 @@ public class TableBorderPrecedence extends NumberProperty.Maker{ /** * Set default precedence according to the parent FObj * - * @see PropertyMaker#compute(PropertyList) + * {@inheritDoc} */ public Property make(PropertyList propertyList) throws PropertyException { FObj fo = propertyList.getFObj(); diff --git a/src/java/org/apache/fop/fo/properties/TableColLength.java b/src/java/org/apache/fop/fo/properties/TableColLength.java index d85c89aba..251007093 100644 --- a/src/java/org/apache/fop/fo/properties/TableColLength.java +++ b/src/java/org/apache/fop/fo/properties/TableColLength.java @@ -65,7 +65,7 @@ public class TableColLength extends LengthProperty { /** * Return false because table-col-units are a relative numeric. - * @see org.apache.fop.datatypes.Numeric#isAbsolute() + * {@inheritDoc} */ public boolean isAbsolute() { return false; @@ -73,7 +73,7 @@ public class TableColLength extends LengthProperty { /** * Return the value as a numeric value. - * @see org.apache.fop.datatypes.Numeric#getNumericValue() + * {@inheritDoc} */ public double getNumericValue() { throw new UnsupportedOperationException( @@ -81,7 +81,7 @@ public class TableColLength extends LengthProperty { } /** - * @see org.apache.fop.datatypes.Numeric#getNumericValue(PercentBaseContext) + * {@inheritDoc} */ public double getNumericValue(PercentBaseContext context) { return tcolUnits * context.getBaseLength(LengthBase.TABLE_UNITS, column); @@ -89,7 +89,7 @@ public class TableColLength extends LengthProperty { /** * Return the value as a length. - * @see org.apache.fop.datatypes.Length#getValue() + * {@inheritDoc} */ public int getValue() { throw new UnsupportedOperationException( @@ -97,7 +97,7 @@ public class TableColLength extends LengthProperty { } /** - * @see org.apache.fop.datatypes.Numeric#getValue(PercentBaseContext) + * {@inheritDoc} */ public int getValue(PercentBaseContext context) { return (int) (tcolUnits * context.getBaseLength(LengthBase.TABLE_UNITS, column)); diff --git a/src/java/org/apache/fop/fo/properties/TextDecorationProperty.java b/src/java/org/apache/fop/fo/properties/TextDecorationProperty.java index 516537fb4..4cb1b2f4a 100644 --- a/src/java/org/apache/fop/fo/properties/TextDecorationProperty.java +++ b/src/java/org/apache/fop/fo/properties/TextDecorationProperty.java @@ -43,7 +43,7 @@ public class TextDecorationProperty extends ListProperty { } /** - * @see PropertyMaker#convertProperty + * {@inheritDoc} */ public Property convertProperty(Property p, PropertyList propertyList, FObj fo) diff --git a/src/java/org/apache/fop/fo/properties/VerticalAlignShorthandParser.java b/src/java/org/apache/fop/fo/properties/VerticalAlignShorthandParser.java index 92d6095ca..d71dc4db1 100644 --- a/src/java/org/apache/fop/fo/properties/VerticalAlignShorthandParser.java +++ b/src/java/org/apache/fop/fo/properties/VerticalAlignShorthandParser.java @@ -29,7 +29,7 @@ import org.apache.fop.fo.PropertyList; public class VerticalAlignShorthandParser implements ShorthandParser, Constants { /** - * @see ShorthandParser#getValueForProperty(int, Property, PropertyMaker, PropertyList) + * {@inheritDoc} */ public Property getValueForProperty(int propId, Property property, diff --git a/src/java/org/apache/fop/fo/properties/WhiteSpaceShorthandParser.java b/src/java/org/apache/fop/fo/properties/WhiteSpaceShorthandParser.java index d7b13b540..2feb5e9c8 100644 --- a/src/java/org/apache/fop/fo/properties/WhiteSpaceShorthandParser.java +++ b/src/java/org/apache/fop/fo/properties/WhiteSpaceShorthandParser.java @@ -32,7 +32,7 @@ import org.apache.fop.fo.expr.PropertyException; public class WhiteSpaceShorthandParser implements ShorthandParser { /** - * @see org.apache.fop.fo.properties.ShorthandParser#getValueForProperty(int, Property, PropertyMaker, PropertyList) + * {@inheritDoc} */ public Property getValueForProperty(int propId, Property property, PropertyMaker maker, PropertyList propertyList) diff --git a/src/java/org/apache/fop/fonts/CIDFont.java b/src/java/org/apache/fop/fonts/CIDFont.java index dd12991c1..f31d00bb9 100644 --- a/src/java/org/apache/fop/fonts/CIDFont.java +++ b/src/java/org/apache/fop/fonts/CIDFont.java @@ -90,7 +90,7 @@ public abstract class CIDFont extends CustomFont { } /** - * @see org.apache.fop.fonts.Typeface#isMultiByte() + * {@inheritDoc} */ public boolean isMultiByte() { return true; diff --git a/src/java/org/apache/fop/fonts/CachedFontInfo.java b/src/java/org/apache/fop/fonts/CachedFontInfo.java index 281289193..fc7afd3da 100644 --- a/src/java/org/apache/fop/fonts/CachedFontInfo.java +++ b/src/java/org/apache/fop/fonts/CachedFontInfo.java @@ -109,7 +109,7 @@ public class CachedFontInfo extends EmbedFontInfo { /** * @return string representation of this object - * @see java.lang.Object#toString() + * {@inheritDoc} */ public String toString() { return super.toString() + ", lastModified=" + lastModified; diff --git a/src/java/org/apache/fop/fonts/CustomFont.java b/src/java/org/apache/fop/fonts/CustomFont.java index 1455319e6..4ad24b08b 100644 --- a/src/java/org/apache/fop/fonts/CustomFont.java +++ b/src/java/org/apache/fop/fonts/CustomFont.java @@ -53,14 +53,14 @@ public abstract class CustomFont extends Typeface private boolean useKerning = true; /** - * @see org.apache.fop.fonts.FontMetrics#getFontName() + * {@inheritDoc} */ public String getFontName() { return fontName; } /** - * @see org.apache.fop.fonts.FontMetrics#getStrippedFontName() + * @see FontUtil#stripWhiteSpace(String) */ public String getStrippedFontName() { return FontUtil.stripWhiteSpace(fontName); @@ -108,77 +108,77 @@ public abstract class CustomFont extends Typeface } /** - * @see org.apache.fop.fonts.FontDescriptor#getAscender() + * {@inheritDoc} */ public int getAscender() { return ascender; } /** - * @see org.apache.fop.fonts.FontDescriptor#getDescender() + * {@inheritDoc} */ public int getDescender() { return descender; } /** - * @see org.apache.fop.fonts.FontDescriptor#getCapHeight() + * {@inheritDoc} */ public int getCapHeight() { return capHeight; } /** - * @see org.apache.fop.fonts.FontMetrics#getAscender(int) + * {@inheritDoc} */ public int getAscender(int size) { return size * ascender; } /** - * @see org.apache.fop.fonts.FontMetrics#getDescender(int) + * {@inheritDoc} */ public int getDescender(int size) { return size * descender; } /** - * @see org.apache.fop.fonts.FontMetrics#getCapHeight(int) + * {@inheritDoc} */ public int getCapHeight(int size) { return size * capHeight; } /** - * @see org.apache.fop.fonts.FontMetrics#getXHeight(int) + * {@inheritDoc} */ public int getXHeight(int size) { return size * xHeight; } /** - * @see org.apache.fop.fonts.FontDescriptor#getFontBBox() + * {@inheritDoc} */ public int[] getFontBBox() { return fontBBox; } /** - * @see org.apache.fop.fonts.FontDescriptor#getFlags() + * {@inheritDoc} */ public int getFlags() { return flags; } /** - * @see org.apache.fop.fonts.FontDescriptor#getStemV() + * {@inheritDoc} */ public int getStemV() { return stemV; } /** - * @see org.apache.fop.fonts.FontDescriptor#getItalicAngle() + * {@inheritDoc} */ public int getItalicAngle() { return italicAngle; @@ -193,7 +193,7 @@ public abstract class CustomFont extends Typeface } /** - * @see org.apache.fop.fonts.FontDescriptor#getFontType() + * {@inheritDoc} */ public FontType getFontType() { return fontType; @@ -226,14 +226,14 @@ public abstract class CustomFont extends Typeface } /** - * @see org.apache.fop.fonts.FontMetrics#hasKerningInfo() + * {@inheritDoc} */ public final boolean hasKerningInfo() { return (isKerningEnabled() && (kerning != null) && !kerning.isEmpty()); } /** - * @see org.apache.fop.fonts.FontMetrics#getKerningInfo() + * {@inheritDoc} */ public final Map getKerningInfo() { if (hasKerningInfo()) { @@ -247,7 +247,7 @@ public abstract class CustomFont extends Typeface /* ---- MutableFont interface ---- */ /** - * @see org.apache.fop.fonts.MutableFont#setFontName(String) + * {@inheritDoc} */ public void setFontName(String name) { this.fontName = name; @@ -262,21 +262,21 @@ public abstract class CustomFont extends Typeface } /** - * @see org.apache.fop.fonts.MutableFont#setEmbedFileName(String) + * {@inheritDoc} */ public void setEmbedFileName(String path) { this.embedFileName = path; } /** - * @see org.apache.fop.fonts.MutableFont#setEmbedResourceName(String) + * {@inheritDoc} */ public void setEmbedResourceName(String name) { this.embedResourceName = name; } /** - * @see org.apache.fop.fonts.MutableFont#setCapHeight(int) + * {@inheritDoc} */ public void setCapHeight(int capHeight) { this.capHeight = capHeight; @@ -291,77 +291,77 @@ public abstract class CustomFont extends Typeface } /** - * @see org.apache.fop.fonts.MutableFont#setAscender(int) + * {@inheritDoc} */ public void setAscender(int ascender) { this.ascender = ascender; } /** - * @see org.apache.fop.fonts.MutableFont#setDescender(int) + * {@inheritDoc} */ public void setDescender(int descender) { this.descender = descender; } /** - * @see org.apache.fop.fonts.MutableFont#setFontBBox(int[]) + * {@inheritDoc} */ public void setFontBBox(int[] bbox) { this.fontBBox = bbox; } /** - * @see org.apache.fop.fonts.MutableFont#setFlags(int) + * {@inheritDoc} */ public void setFlags(int flags) { this.flags = flags; } /** - * @see org.apache.fop.fonts.MutableFont#setStemV(int) + * {@inheritDoc} */ public void setStemV(int stemV) { this.stemV = stemV; } /** - * @see org.apache.fop.fonts.MutableFont#setItalicAngle(int) + * {@inheritDoc} */ public void setItalicAngle(int italicAngle) { this.italicAngle = italicAngle; } /** - * @see org.apache.fop.fonts.MutableFont#setMissingWidth(int) + * {@inheritDoc} */ public void setMissingWidth(int width) { this.missingWidth = width; } /** - * @see org.apache.fop.fonts.MutableFont#setFontType(FontType) + * {@inheritDoc} */ public void setFontType(FontType fontType) { this.fontType = fontType; } /** - * @see org.apache.fop.fonts.MutableFont#setFirstChar(int) + * {@inheritDoc} */ public void setFirstChar(int index) { this.firstChar = index; } /** - * @see org.apache.fop.fonts.MutableFont#setLastChar(int) + * {@inheritDoc} */ public void setLastChar(int index) { this.lastChar = index; } /** - * @see org.apache.fop.fonts.MutableFont#setKerningEnabled(boolean) + * {@inheritDoc} */ public void setKerningEnabled(boolean enabled) { this.useKerning = enabled; @@ -376,7 +376,7 @@ public abstract class CustomFont extends Typeface } /** - * @see org.apache.fop.fonts.MutableFont#putKerningEntry(Integer, Map) + * {@inheritDoc} */ public void putKerningEntry(Integer key, Map value) { if (kerning == null) { diff --git a/src/java/org/apache/fop/fonts/EmbedFontInfo.java b/src/java/org/apache/fop/fonts/EmbedFontInfo.java index ad8915d9d..58dcbf142 100644 --- a/src/java/org/apache/fop/fonts/EmbedFontInfo.java +++ b/src/java/org/apache/fop/fonts/EmbedFontInfo.java @@ -86,7 +86,7 @@ public class EmbedFontInfo implements Serializable { return fontTriplets; } - /** @see java.lang.Object#toString() */ + /** {@inheritDoc} */ public String toString() { return "metrics-url=" + metricsFile + ",embed-url=" + embedFile + ", kerning=" + kerning + ", font-triplet=" + fontTriplets; diff --git a/src/java/org/apache/fop/fonts/Font.java b/src/java/org/apache/fop/fonts/Font.java index 7f4a6d6e8..e8a81a0ea 100644 --- a/src/java/org/apache/fop/fonts/Font.java +++ b/src/java/org/apache/fop/fonts/Font.java @@ -211,7 +211,7 @@ public class Font { } /** - * @see java.lang.Object#toString() + * {@inheritDoc} */ public String toString() { StringBuffer sbuf = new StringBuffer(); diff --git a/src/java/org/apache/fop/fonts/FontLoader.java b/src/java/org/apache/fop/fonts/FontLoader.java index c48e36453..5dcb91089 100644 --- a/src/java/org/apache/fop/fonts/FontLoader.java +++ b/src/java/org/apache/fop/fonts/FontLoader.java @@ -176,7 +176,7 @@ public abstract class FontLoader { */
protected abstract void read() throws IOException;
- /** @see org.apache.fop.fonts.FontLoader#getFont() */
+ /** @see FontLoader#getFont() */
public CustomFont getFont() throws IOException {
if (!loaded) {
read();
diff --git a/src/java/org/apache/fop/fonts/FontReader.java b/src/java/org/apache/fop/fonts/FontReader.java index 7918398ca..ccc0c80ba 100644 --- a/src/java/org/apache/fop/fonts/FontReader.java +++ b/src/java/org/apache/fop/fonts/FontReader.java @@ -142,20 +142,20 @@ public class FontReader extends DefaultHandler { } /** - * @see org.xml.sax.ContentHandler#startDocument() + * {@inheritDoc} */ public void startDocument() { } /** - * @see org.xml.sax.ContentHandler#setDocumentLocator(Locator) + * {@inheritDoc} */ public void setDocumentLocator(Locator locator) { this.locator = locator; } /** - * @see org.xml.sax.ContentHandler#startElement(String, String, String, Attributes) + * {@inheritDoc} */ public void startElement(String uri, String localName, String qName, Attributes attributes) throws SAXException { @@ -223,7 +223,7 @@ public class FontReader extends DefaultHandler { } /** - * @see org.xml.sax.ContentHandler#endElement(String, String, String) + * {@inheritDoc} */ public void endElement(String uri, String localName, String qName) throws SAXException { String content = text.toString().trim(); @@ -293,7 +293,7 @@ public class FontReader extends DefaultHandler { } /** - * @see org.xml.sax.ContentHandler#characters(char[], int, int) + * {@inheritDoc} */ public void characters(char[] ch, int start, int length) { text.append(ch, start, length); diff --git a/src/java/org/apache/fop/fonts/FontSetup.java b/src/java/org/apache/fop/fonts/FontSetup.java index 0028f3281..4a87f6efe 100644 --- a/src/java/org/apache/fop/fonts/FontSetup.java +++ b/src/java/org/apache/fop/fonts/FontSetup.java @@ -232,7 +232,7 @@ public class FontSetup { public static FontResolver createMinimalFontResolver() { return new FontResolver() { - /** @see org.apache.fop.fonts.FontResolver#resolve(java.lang.String) */ + /** {@inheritDoc} */ public Source resolve(String href) { //Minimal functionality here return new StreamSource(href); diff --git a/src/java/org/apache/fop/fonts/FontTriplet.java b/src/java/org/apache/fop/fonts/FontTriplet.java index 841b69990..66be36bc7 100644 --- a/src/java/org/apache/fop/fonts/FontTriplet.java +++ b/src/java/org/apache/fop/fonts/FontTriplet.java @@ -71,17 +71,17 @@ public class FontTriplet implements Comparable, Serializable { return this.key; } - /** @see java.lang.Comparable#compareTo(java.lang.Object) */ + /** {@inheritDoc} */ public int compareTo(Object o) { return getKey().compareTo(((FontTriplet)o).getKey()); } - /** @see java.lang.Object#hashCode() */ + /** {@inheritDoc} */ public int hashCode() { return toString().hashCode(); } - /** @see java.lang.Object#equals(java.lang.Object) */ + /** {@inheritDoc} */ public boolean equals(Object obj) { if (obj == null) { return false; @@ -98,7 +98,7 @@ public class FontTriplet implements Comparable, Serializable { return false; } - /** @see java.lang.Object#toString() */ + /** {@inheritDoc} */ public String toString() { return getKey(); } diff --git a/src/java/org/apache/fop/fonts/LazyFont.java b/src/java/org/apache/fop/fonts/LazyFont.java index 9fff44e10..c629f14fe 100644 --- a/src/java/org/apache/fop/fonts/LazyFont.java +++ b/src/java/org/apache/fop/fonts/LazyFont.java @@ -49,9 +49,7 @@ public class LazyFont extends Typeface implements FontDescriptor { /** * Main constructor - * @param fontEmbedPath path to embeddable file (may be null) - * @param metricsFileName path to the metrics XML file - * @param useKerning True, if kerning should be enabled + * @param fontInfo the font info to embed * @param resolver the font resolver to handle font URIs */ public LazyFont(EmbedFontInfo fontInfo, FontResolver resolver) { @@ -150,7 +148,7 @@ public class LazyFont extends Typeface implements FontDescriptor { // ---- Font ---- /** - * @see org.apache.fop.fonts.Typeface#getEncoding() + * {@inheritDoc} */ public String getEncoding() { load(true); @@ -158,7 +156,7 @@ public class LazyFont extends Typeface implements FontDescriptor { } /** - * @see org.apache.fop.fonts.Typeface#mapChar(char) + * {@inheritDoc} */ public char mapChar(char c) { load(true); @@ -166,7 +164,7 @@ public class LazyFont extends Typeface implements FontDescriptor { } /** - * @see org.apache.fop.fonts.Typeface#hasChar(char) + * {@inheritDoc} */ public boolean hasChar(char c) { load(true); @@ -174,7 +172,7 @@ public class LazyFont extends Typeface implements FontDescriptor { } /** - * @see org.apache.fop.fonts.Typeface#isMultiByte() + * {@inheritDoc} */ public boolean isMultiByte() { load(true); @@ -183,7 +181,7 @@ public class LazyFont extends Typeface implements FontDescriptor { // ---- FontMetrics interface ---- /** - * @see org.apache.fop.fonts.FontMetrics#getFontName() + * {@inheritDoc} */ public String getFontName() { load(true); @@ -191,7 +189,7 @@ public class LazyFont extends Typeface implements FontDescriptor { } /** - * @see org.apache.fop.fonts.FontMetrics#getMaxAscent(int) + * {@inheritDoc} */ public int getMaxAscent(int size) { load(true); @@ -199,7 +197,7 @@ public class LazyFont extends Typeface implements FontDescriptor { } /** - * @see org.apache.fop.fonts.FontMetrics#getAscender(int) + * {@inheritDoc} */ public int getAscender(int size) { load(true); @@ -207,7 +205,7 @@ public class LazyFont extends Typeface implements FontDescriptor { } /** - * @see org.apache.fop.fonts.FontMetrics#getCapHeight(int) + * {@inheritDoc} */ public int getCapHeight(int size) { load(true); @@ -215,7 +213,7 @@ public class LazyFont extends Typeface implements FontDescriptor { } /** - * @see org.apache.fop.fonts.FontMetrics#getDescender(int) + * {@inheritDoc} */ public int getDescender(int size) { load(true); @@ -223,7 +221,7 @@ public class LazyFont extends Typeface implements FontDescriptor { } /** - * @see org.apache.fop.fonts.FontMetrics#getXHeight(int) + * {@inheritDoc} */ public int getXHeight(int size) { load(true); @@ -231,7 +229,7 @@ public class LazyFont extends Typeface implements FontDescriptor { } /** - * @see org.apache.fop.fonts.FontMetrics#getWidth(int, int) + * {@inheritDoc} */ public int getWidth(int i, int size) { load(true); @@ -239,7 +237,7 @@ public class LazyFont extends Typeface implements FontDescriptor { } /** - * @see org.apache.fop.fonts.FontMetrics#getWidths() + * {@inheritDoc} */ public int[] getWidths() { load(true); @@ -247,7 +245,7 @@ public class LazyFont extends Typeface implements FontDescriptor { } /** - * @see org.apache.fop.fonts.FontMetrics#hasKerningInfo() + * {@inheritDoc} */ public boolean hasKerningInfo() { load(true); @@ -255,7 +253,7 @@ public class LazyFont extends Typeface implements FontDescriptor { } /** - * @see org.apache.fop.fonts.FontMetrics#getKerningInfo() + * {@inheritDoc} */ public Map getKerningInfo() { load(true); @@ -264,7 +262,7 @@ public class LazyFont extends Typeface implements FontDescriptor { // ---- FontDescriptor interface ---- /** - * @see org.apache.fop.fonts.FontDescriptor#getCapHeight() + * {@inheritDoc} */ public int getCapHeight() { load(true); @@ -272,7 +270,7 @@ public class LazyFont extends Typeface implements FontDescriptor { } /** - * @see org.apache.fop.fonts.FontDescriptor#getDescender() + * {@inheritDoc} */ public int getDescender() { load(true); @@ -280,7 +278,7 @@ public class LazyFont extends Typeface implements FontDescriptor { } /** - * @see org.apache.fop.fonts.FontDescriptor#getAscender() + * {@inheritDoc} */ public int getAscender() { load(true); @@ -288,7 +286,7 @@ public class LazyFont extends Typeface implements FontDescriptor { } /** - * @see org.apache.fop.fonts.FontDescriptor#getFlags() + * {@inheritDoc} */ public int getFlags() { load(true); @@ -296,7 +294,7 @@ public class LazyFont extends Typeface implements FontDescriptor { } /** - * @see org.apache.fop.fonts.FontDescriptor#getFontBBox() + * {@inheritDoc} */ public int[] getFontBBox() { load(true); @@ -304,7 +302,7 @@ public class LazyFont extends Typeface implements FontDescriptor { } /** - * @see org.apache.fop.fonts.FontDescriptor#getItalicAngle() + * {@inheritDoc} */ public int getItalicAngle() { load(true); @@ -312,7 +310,7 @@ public class LazyFont extends Typeface implements FontDescriptor { } /** - * @see org.apache.fop.fonts.FontDescriptor#getStemV() + * {@inheritDoc} */ public int getStemV() { load(true); @@ -320,7 +318,7 @@ public class LazyFont extends Typeface implements FontDescriptor { } /** - * @see org.apache.fop.fonts.FontDescriptor#getFontType() + * {@inheritDoc} */ public FontType getFontType() { load(true); @@ -328,7 +326,7 @@ public class LazyFont extends Typeface implements FontDescriptor { } /** - * @see org.apache.fop.fonts.FontDescriptor#isEmbeddable() + * {@inheritDoc} */ public boolean isEmbeddable() { load(true); diff --git a/src/java/org/apache/fop/fonts/MultiByteFont.java b/src/java/org/apache/fop/fonts/MultiByteFont.java index e326140b5..e00300324 100644 --- a/src/java/org/apache/fop/fonts/MultiByteFont.java +++ b/src/java/org/apache/fop/fonts/MultiByteFont.java @@ -67,35 +67,35 @@ public class MultiByteFont extends CIDFont { } /** - * @see org.apache.fop.fonts.CIDFont#getDefaultWidth() + * {@inheritDoc} */ public int getDefaultWidth() { return defaultWidth; } /** - * @see org.apache.fop.fonts.CIDFont#getRegistry() + * {@inheritDoc} */ public String getRegistry() { return "Adobe"; } /** - * @see org.apache.fop.fonts.CIDFont#getOrdering() + * {@inheritDoc} */ public String getOrdering() { return "UCS"; } /** - * @see org.apache.fop.fonts.CIDFont#getSupplement() + * {@inheritDoc} */ public int getSupplement() { return 0; } /** - * @see org.apache.fop.fonts.CIDFont#getCIDType() + * {@inheritDoc} */ public CIDFontType getCIDType() { return cidType; @@ -114,7 +114,7 @@ public class MultiByteFont extends CIDFont { } /** - * @see org.apache.fop.fonts.CIDFont#getCidBaseFont() + * {@inheritDoc} */ public String getCidBaseFont() { if (isEmbeddable()) { @@ -125,21 +125,21 @@ public class MultiByteFont extends CIDFont { } /** - * @see org.apache.fop.fonts.FontDescriptor#isEmbeddable() + * {@inheritDoc} */ public boolean isEmbeddable() { return !(getEmbedFileName() == null && getEmbedResourceName() == null); } /** - * @see org.apache.fop.fonts.Typeface#getEncoding() + * {@inheritDoc} */ public String getEncoding() { return encoding; } /** - * @see org.apache.fop.fonts.FontMetrics#getFontName() + * {@inheritDoc} */ public String getFontName() { if (isEmbeddable()) { @@ -150,7 +150,7 @@ public class MultiByteFont extends CIDFont { } /** - * @see org.apache.fop.fonts.FontMetrics#getWidth(int, int) + * {@inheritDoc} */ public int getWidth(int i, int size) { if (isEmbeddable()) { @@ -162,7 +162,7 @@ public class MultiByteFont extends CIDFont { } /** - * @see org.apache.fop.fonts.FontMetrics#getWidths() + * {@inheritDoc} */ public int[] getWidths() { int[] arr = new int[width.length]; @@ -211,7 +211,7 @@ public class MultiByteFont extends CIDFont { } /** - * @see org.apache.fop.fonts.Typeface#mapChar(char) + * {@inheritDoc} */ public char mapChar(char c) { int retIdx = findGlyphIndex(c); @@ -238,7 +238,7 @@ public class MultiByteFont extends CIDFont { } /** - * @see org.apache.fop.fonts.Typeface#hasChar(char) + * {@inheritDoc} */ public boolean hasChar(char c) { return (findGlyphIndex(c) > 0); @@ -308,7 +308,7 @@ public class MultiByteFont extends CIDFont { * that need to return an invalid character. */ public static final char INVALID_UNICODE_CHAR = 0xFFFF; - /** @see org.apache.fop.fonts.CIDFont#getCharsUsed() */ + /** {@inheritDoc} */ public char[] getCharsUsed() { if (!isEmbeddable()) { return null; diff --git a/src/java/org/apache/fop/fonts/SingleByteFont.java b/src/java/org/apache/fop/fonts/SingleByteFont.java index ac1efc2a9..248526c82 100644 --- a/src/java/org/apache/fop/fonts/SingleByteFont.java +++ b/src/java/org/apache/fop/fonts/SingleByteFont.java @@ -51,7 +51,7 @@ public class SingleByteFont extends CustomFont { } /** - * @see org.apache.fop.fonts.FontDescriptor#isEmbeddable() + * {@inheritDoc} */ public boolean isEmbeddable() { return (getEmbedFileName() == null && getEmbedResourceName() == null) ? false @@ -59,7 +59,7 @@ public class SingleByteFont extends CustomFont { } /** - * @see org.apache.fop.fonts.Typeface#getEncoding() + * {@inheritDoc} */ public String getEncoding() { return encoding; @@ -75,14 +75,14 @@ public class SingleByteFont extends CustomFont { } /** - * @see org.apache.fop.fonts.FontMetrics#getWidth(int, int) + * {@inheritDoc} */ public int getWidth(int i, int size) { return size * width[i]; } /** - * @see org.apache.fop.fonts.FontMetrics#getWidths() + * {@inheritDoc} */ public int[] getWidths() { int[] arr = new int[width.length]; @@ -91,7 +91,7 @@ public class SingleByteFont extends CustomFont { } /** - * @see org.apache.fop.fonts.Typeface#mapChar(char) + * {@inheritDoc} */ public char mapChar(char c) { char d = mapping.mapChar(c); @@ -105,7 +105,7 @@ public class SingleByteFont extends CustomFont { } /** - * @see org.apache.fop.fonts.Typeface#hasChar(char) + * {@inheritDoc} */ public boolean hasChar(char c) { return (mapping.mapChar(c) > 0); diff --git a/src/java/org/apache/fop/fonts/Typeface.java b/src/java/org/apache/fop/fonts/Typeface.java index 80bbb1ef2..c165b4068 100644 --- a/src/java/org/apache/fop/fonts/Typeface.java +++ b/src/java/org/apache/fop/fonts/Typeface.java @@ -55,7 +55,7 @@ public abstract class Typeface implements FontMetrics { return false; } - /** @see org.apache.fop.fonts.FontMetrics#getMaxAscent(int) */ + /** {@inheritDoc} */ public int getMaxAscent(int size) { return getAscender(size); } diff --git a/src/java/org/apache/fop/fonts/autodetect/FontFileFinder.java b/src/java/org/apache/fop/fonts/autodetect/FontFileFinder.java index 246fd2aed..099093dd6 100644 --- a/src/java/org/apache/fop/fonts/autodetect/FontFileFinder.java +++ b/src/java/org/apache/fop/fonts/autodetect/FontFileFinder.java @@ -86,7 +86,7 @@ public class FontFileFinder extends DirectoryWalker implements FontFinder { * @param depth recursion depth * @param results collection * @return whether directory should be handled - * @see org.apache.commons.io.DirectoryWalker#handleDirectory(File, int, Collection) + * {@inheritDoc} */ protected boolean handleDirectory(File directory, int depth, Collection results) { return true; @@ -96,7 +96,7 @@ public class FontFileFinder extends DirectoryWalker implements FontFinder { * @param file file to handle * @param depth recursion depth * @param results collection - * @see org.apache.commons.io.DirectoryWalker#handleFile(File, int, Collection) + * {@inheritDoc} */ protected void handleFile(File file, int depth, Collection results) { results.add(file); @@ -106,7 +106,7 @@ public class FontFileFinder extends DirectoryWalker implements FontFinder { * @param directory the directory being processed * @param depth the current directory level * @param results the colleciton of results objects - * @see org.apache.commons.io.DirectoryWalker.handleDirectoryEnd + * {@inheritDoc} */ protected void handleDirectoryEnd(File directory, int depth, Collection results) { if (log.isDebugEnabled()) { @@ -120,7 +120,7 @@ public class FontFileFinder extends DirectoryWalker implements FontFinder { * * @return list of font files * @throws IOException io exception - * @see org.apache.fop.fonts.autodetect.FontFinder#find() + * {@inheritDoc} */ public List find() throws IOException { final FontFinder fontDirFinder; diff --git a/src/java/org/apache/fop/fonts/autodetect/NativeFontDirFinder.java b/src/java/org/apache/fop/fonts/autodetect/NativeFontDirFinder.java index e9bfe9447..0c885ce7d 100644 --- a/src/java/org/apache/fop/fonts/autodetect/NativeFontDirFinder.java +++ b/src/java/org/apache/fop/fonts/autodetect/NativeFontDirFinder.java @@ -30,7 +30,7 @@ public abstract class NativeFontDirFinder implements FontFinder { /** * Generic method used by Mac and Unix font finders. * @return list of natively existing font directories - * @see FontFinder#find() + * {@inheritDoc} */ public List find() { List fontDirList = new java.util.ArrayList(); diff --git a/src/java/org/apache/fop/fonts/autodetect/WindowsFontDirFinder.java b/src/java/org/apache/fop/fonts/autodetect/WindowsFontDirFinder.java index 19901dc0a..bcb4ebb99 100644 --- a/src/java/org/apache/fop/fonts/autodetect/WindowsFontDirFinder.java +++ b/src/java/org/apache/fop/fonts/autodetect/WindowsFontDirFinder.java @@ -48,7 +48,7 @@ public class WindowsFontDirFinder implements FontFinder { } /** - * @see FontFinder#find() + * {@inheritDoc} * @return a list of detected font files */ public List find() { diff --git a/src/java/org/apache/fop/fonts/truetype/TTFCmapEntry.java b/src/java/org/apache/fop/fonts/truetype/TTFCmapEntry.java index 77d9f5427..ce3f3efe9 100644 --- a/src/java/org/apache/fop/fonts/truetype/TTFCmapEntry.java +++ b/src/java/org/apache/fop/fonts/truetype/TTFCmapEntry.java @@ -42,7 +42,7 @@ public class TTFCmapEntry { } /** - * @see java.lang.Object#equals(Object) + * {@inheritDoc} */ public boolean equals(Object o) { if (o instanceof TTFCmapEntry) { diff --git a/src/java/org/apache/fop/fonts/truetype/TTFFontLoader.java b/src/java/org/apache/fop/fonts/truetype/TTFFontLoader.java index f5a0447b4..a7de26b75 100644 --- a/src/java/org/apache/fop/fonts/truetype/TTFFontLoader.java +++ b/src/java/org/apache/fop/fonts/truetype/TTFFontLoader.java @@ -49,7 +49,7 @@ public class TTFFontLoader extends FontLoader { }
/**
- * @see FontLoader#read()
+ * {@inheritDoc}
*/
protected void read() throws IOException {
TTFFile ttf = new TTFFile();
diff --git a/src/java/org/apache/fop/fonts/type1/PFBData.java b/src/java/org/apache/fop/fonts/type1/PFBData.java index cfd2d1e27..4575fe200 100644 --- a/src/java/org/apache/fop/fonts/type1/PFBData.java +++ b/src/java/org/apache/fop/fonts/type1/PFBData.java @@ -149,7 +149,7 @@ public class PFBData { /** - * @see java.lang.Object#toString() + * {@inheritDoc} */ public String toString() { return "PFB: format=" + getPFBFormat() diff --git a/src/java/org/apache/fop/fonts/type1/Type1FontLoader.java b/src/java/org/apache/fop/fonts/type1/Type1FontLoader.java index 3db4a6d2d..56d1b4cfb 100644 --- a/src/java/org/apache/fop/fonts/type1/Type1FontLoader.java +++ b/src/java/org/apache/fop/fonts/type1/Type1FontLoader.java @@ -48,7 +48,7 @@ public class Type1FontLoader extends FontLoader { }
/**
- * @see FontLoader#read()
+ * {@inheritDoc}
*/
protected void read() throws IOException {
pfm = new PFMFile();
diff --git a/src/java/org/apache/fop/hyphenation/PatternParser.java b/src/java/org/apache/fop/hyphenation/PatternParser.java index 5dbe1f5ee..b0378a40b 100644 --- a/src/java/org/apache/fop/hyphenation/PatternParser.java +++ b/src/java/org/apache/fop/hyphenation/PatternParser.java @@ -254,7 +254,7 @@ public class PatternParser extends DefaultHandler implements PatternConsumer { // /** - * @see org.xml.sax.ContentHandler#startElement(java.lang.String, java.lang.String, java.lang.String, org.xml.sax.Attributes) + * {@inheritDoc} */ public void startElement(String uri, String local, String raw, Attributes attrs) { @@ -283,7 +283,7 @@ public class PatternParser extends DefaultHandler implements PatternConsumer { } /** - * @see org.xml.sax.ContentHandler#endElement(java.lang.String, java.lang.String, java.lang.String) + * {@inheritDoc} */ public void endElement(String uri, String local, String raw) { @@ -320,7 +320,7 @@ public class PatternParser extends DefaultHandler implements PatternConsumer { } /** - * @see org.xml.sax.ContentHandler#characters(char[], int, int) + * {@inheritDoc} */ public void characters(char ch[], int start, int length) { StringBuffer chars = new StringBuffer(length); @@ -354,7 +354,7 @@ public class PatternParser extends DefaultHandler implements PatternConsumer { // /** - * @see org.xml.sax.ErrorHandler#warning(org.xml.sax.SAXParseException) + * {@inheritDoc} */ public void warning(SAXParseException ex) { errMsg = "[Warning] " + getLocationString(ex) + ": " @@ -362,14 +362,14 @@ public class PatternParser extends DefaultHandler implements PatternConsumer { } /** - * @see org.xml.sax.ErrorHandler#error(org.xml.sax.SAXParseException) + * {@inheritDoc} */ public void error(SAXParseException ex) { errMsg = "[Error] " + getLocationString(ex) + ": " + ex.getMessage(); } /** - * @see org.xml.sax.ErrorHandler#fatalError(org.xml.sax.SAXParseException) + * {@inheritDoc} */ public void fatalError(SAXParseException ex) throws SAXException { errMsg = "[Fatal Error] " + getLocationString(ex) + ": " diff --git a/src/java/org/apache/fop/image/AbstractFopImage.java b/src/java/org/apache/fop/image/AbstractFopImage.java index 97f176712..8d5180149 100644 --- a/src/java/org/apache/fop/image/AbstractFopImage.java +++ b/src/java/org/apache/fop/image/AbstractFopImage.java @@ -33,8 +33,7 @@ import org.apache.fop.datatypes.Length; /** * Base class to implement the FopImage interface. - * @author Eric SCHAEFFER - * @author Modified by Eric Dalquist - 9/14/2001 - ebdalqui@mtu.edu + * * @see FopImage */ public abstract class AbstractFopImage implements FopImage { @@ -141,7 +140,7 @@ public abstract class AbstractFopImage implements FopImage { return imageInfo.mimeType; } - /** @see org.apache.fop.image.FopImage#getOriginalURI() */ + /** {@inheritDoc} */ public String getOriginalURI() { return this.imageInfo.originalURI; } @@ -249,27 +248,27 @@ public abstract class AbstractFopImage implements FopImage { return this.height; } - /** @see org.apache.fop.image.FopImage#getIntrinsicWidth() */ + /** {@inheritDoc} */ public int getIntrinsicWidth() { return (int)(getWidth() * 72000 / getHorizontalResolution()); } - /** @see org.apache.fop.image.FopImage#getIntrinsicHeight() */ + /** {@inheritDoc} */ public int getIntrinsicHeight() { return (int)(getHeight() * 72000 / getVerticalResolution()); } - /** @see org.apache.fop.image.FopImage#getIntrinsicAlignmentAdjust() */ + /** {@inheritDoc} */ public Length getIntrinsicAlignmentAdjust() { return this.imageInfo.alignmentAdjust; } - /** @see org.apache.fop.image.FopImage#getHorizontalResolution() */ + /** {@inheritDoc} */ public double getHorizontalResolution() { return this.dpiHorizontal; } - /** @see org.apache.fop.image.FopImage#getVerticalResolution() */ + /** {@inheritDoc} */ public double getVerticalResolution() { return this.dpiVertical; } diff --git a/src/java/org/apache/fop/image/BmpImage.java b/src/java/org/apache/fop/image/BmpImage.java index 506137bbb..5ebf522e9 100644 --- a/src/java/org/apache/fop/image/BmpImage.java +++ b/src/java/org/apache/fop/image/BmpImage.java @@ -29,7 +29,6 @@ import org.apache.commons.io.IOUtils; * Bitmap image. * This supports loading a bitmap image into bitmap data. * - * @author Art WELCH * @see AbstractFopImage * @see FopImage */ diff --git a/src/java/org/apache/fop/image/EmfImage.java b/src/java/org/apache/fop/image/EmfImage.java index 4e19b326d..1221b9b2b 100644 --- a/src/java/org/apache/fop/image/EmfImage.java +++ b/src/java/org/apache/fop/image/EmfImage.java @@ -19,13 +19,10 @@ package org.apache.fop.image;
-import org.apache.commons.io.IOUtils;
-
/**
* Enhanced metafile image.
* This supports loading a EMF image.
*
- * @author Peter Herweg
* @see AbstractFopImage
* @see FopImage
*/
diff --git a/src/java/org/apache/fop/image/FopImage.java b/src/java/org/apache/fop/image/FopImage.java index 30f3c8258..0f780ad57 100644 --- a/src/java/org/apache/fop/image/FopImage.java +++ b/src/java/org/apache/fop/image/FopImage.java @@ -28,8 +28,6 @@ import org.apache.fop.datatypes.Length; /** * Fop image interface for loading images. - * - * @author Eric SCHAEFFER */ public interface FopImage { /** diff --git a/src/java/org/apache/fop/image/FopImageConsumer.java b/src/java/org/apache/fop/image/FopImageConsumer.java index 37f2a29a2..4e4d7be48 100644 --- a/src/java/org/apache/fop/image/FopImageConsumer.java +++ b/src/java/org/apache/fop/image/FopImageConsumer.java @@ -28,7 +28,6 @@ import java.awt.image.PixelGrabber; /** * ImageConsumer implementation for FopImage classes. - * @author Eric SCHAEFFER */ public class FopImageConsumer implements ImageConsumer { @@ -56,7 +55,7 @@ public class FopImageConsumer implements ImageConsumer { } /** - * @see java.awt.image.ImageConsumer#imageComplete(int) + * {@inheritDoc} */ public void imageComplete(int status) { /* @@ -91,7 +90,7 @@ public class FopImageConsumer implements ImageConsumer { } /** - * @see java.awt.image.ImageConsumer#setColorModel(ColorModel) + * {@inheritDoc} */ public void setColorModel(ColorModel model) { // log.error("setColorModel: " + model); @@ -99,7 +98,7 @@ public class FopImageConsumer implements ImageConsumer { } /** - * @see java.awt.image.ImageConsumer#setDimensions(int, int) + * {@inheritDoc} */ public void setDimensions(int width, int height) { // log.error("setDimension: w=" + width + " h=" + height); @@ -108,7 +107,7 @@ public class FopImageConsumer implements ImageConsumer { } /** - * @see java.awt.image.ImageConsumer#setHints(int) + * {@inheritDoc} */ public void setHints(int hintflags) { // log.error("setHints: " + hintflags); @@ -116,7 +115,7 @@ public class FopImageConsumer implements ImageConsumer { } /** - * @see java.awt.image.ImageConsumer#setProperties(Hashtable) + * {@inheritDoc} */ public void setProperties(Hashtable props) { // log.error("setProperties: " + props); @@ -124,14 +123,14 @@ public class FopImageConsumer implements ImageConsumer { } /** - * @see java.awt.image.ImageConsumer#setPixels(int, int, int, int, ColorModel, byte[], int, int) + * {@inheritDoc} */ public void setPixels(int x, int y, int w, int h, ColorModel model, byte[] pixels, int off, int scansize) { } /** - * @see java.awt.image.ImageConsumer#setPixels(int, int, int, int, ColorModel, int[], int, int) + * {@inheritDoc} */ public void setPixels(int x, int y, int w, int h, ColorModel model, int[] pixels, int off, int scansize) { diff --git a/src/java/org/apache/fop/image/GifImage.java b/src/java/org/apache/fop/image/GifImage.java index 40c5ab330..27e81c4fc 100644 --- a/src/java/org/apache/fop/image/GifImage.java +++ b/src/java/org/apache/fop/image/GifImage.java @@ -33,8 +33,7 @@ import org.apache.commons.io.IOUtils; /** * FopImage object for GIF images, using Java native classes. - * @author Eric SCHAEFFER - * @author Modified by Eric Dalquist - 9/14/2001 - ebdalqui@mtu.edu + * * @see AbstractFopImage * @see FopImage */ @@ -166,7 +165,7 @@ public class GifImage extends AbstractFopImage { return true; } - /** @see org.apache.fop.image.AbstractFopImage#loadOriginalData() */ + /** {@inheritDoc} */ protected boolean loadOriginalData() { return loadDefaultOriginalData(); } @@ -183,28 +182,28 @@ public class GifImage extends AbstractFopImage { } /** - * @see java.net.URLConnection#getInputStream() + * {@inheritDoc} */ public InputStream getInputStream() throws IOException { return inputStream; } /** - * @see java.net.URLConnection#connect() + * {@inheritDoc} */ public void connect() throws IOException { // do nothing } /** - * @see java.net.URLConnection#getContentType() + * {@inheritDoc} */ public String getContentType() { return "image/gif"; } /** - * @see java.net.URLConnection#getContentLength() + * {@inheritDoc} */ public int getContentLength() { try { diff --git a/src/java/org/apache/fop/image/ImageFactory.java b/src/java/org/apache/fop/image/ImageFactory.java index 7d7a92120..ee5b1ae75 100644 --- a/src/java/org/apache/fop/image/ImageFactory.java +++ b/src/java/org/apache/fop/image/ImageFactory.java @@ -339,7 +339,7 @@ class BasicImageCache implements ImageCache { // do nothing } - /** @see org.apache.fop.image.ImageCache#clearAll() */ + /** {@inheritDoc} */ public void clearAll() { invalid.clear(); } @@ -549,7 +549,7 @@ class ContextImageCache implements ImageCache { } - /** @see org.apache.fop.image.ImageCache#clearAll() */ + /** {@inheritDoc} */ public void clearAll() { this.refStore.clear(); this.invalid.clear(); diff --git a/src/java/org/apache/fop/image/JAIImage.java b/src/java/org/apache/fop/image/JAIImage.java index d63642dbe..8b3074052 100644 --- a/src/java/org/apache/fop/image/JAIImage.java +++ b/src/java/org/apache/fop/image/JAIImage.java @@ -35,7 +35,7 @@ import com.sun.media.jai.codec.FileCacheSeekableStream; /** * FopImage object using JAI. - * @author Eric SCHAEFFER + * * @see AbstractFopImage * @see FopImage */ @@ -51,7 +51,7 @@ public class JAIImage extends AbstractFopImage { } /** - * @see org.apache.fop.image.AbstractFopImage#loadDimensions() + * {@inheritDoc} */ protected boolean loadDimensions() { if (this.bitmaps == null) { @@ -61,7 +61,7 @@ public class JAIImage extends AbstractFopImage { } /** - * @see org.apache.fop.image.AbstractFopImage#loadBitmap() + * {@inheritDoc} */ protected boolean loadBitmap() { if (this.bitmaps == null) { @@ -185,7 +185,7 @@ public class JAIImage extends AbstractFopImage { } } - /** @see org.apache.fop.image.AbstractFopImage#loadOriginalData() */ + /** {@inheritDoc} */ protected boolean loadOriginalData() { return loadDefaultOriginalData(); } diff --git a/src/java/org/apache/fop/image/JimiImage.java b/src/java/org/apache/fop/image/JimiImage.java index cef32dce0..49fb0b2e0 100644 --- a/src/java/org/apache/fop/image/JimiImage.java +++ b/src/java/org/apache/fop/image/JimiImage.java @@ -34,7 +34,7 @@ import com.sun.jimi.core.Jimi; /** * FopImage object for several images types, using Jimi. * See Jimi documentation for supported image types. - * @author Eric SCHAEFFER + * * @see AbstractFopImage * @see FopImage */ @@ -50,7 +50,7 @@ public class JimiImage extends AbstractFopImage { } /** - * @see org.apache.fop.image.AbstractFopImage#loadDimensions() + * {@inheritDoc} */ protected boolean loadDimensions() { if (this.bitmaps == null) { @@ -61,7 +61,7 @@ public class JimiImage extends AbstractFopImage { } /** - * @see org.apache.fop.image.AbstractFopImage#loadBitmap() + * {@inheritDoc} */ protected boolean loadBitmap() { if (this.bitmaps == null) { @@ -177,7 +177,7 @@ public class JimiImage extends AbstractFopImage { } } - /** @see org.apache.fop.image.AbstractFopImage#loadOriginalData() */ + /** {@inheritDoc} */ protected boolean loadOriginalData() { return loadDefaultOriginalData(); } diff --git a/src/java/org/apache/fop/image/JpegImage.java b/src/java/org/apache/fop/image/JpegImage.java index 3ad745281..658d48286 100644 --- a/src/java/org/apache/fop/image/JpegImage.java +++ b/src/java/org/apache/fop/image/JpegImage.java @@ -30,7 +30,7 @@ import org.apache.fop.util.CMYKColorSpace; /** * FopImage object for JPEG images, Using Java native classes. - * @author Eric Dalquist + * * @see AbstractFopImage * @see FopImage */ diff --git a/src/java/org/apache/fop/image/PNGImage.java b/src/java/org/apache/fop/image/PNGImage.java index 451cf6abf..c83d491f0 100644 --- a/src/java/org/apache/fop/image/PNGImage.java +++ b/src/java/org/apache/fop/image/PNGImage.java @@ -29,7 +29,7 @@ import org.apache.commons.io.IOUtils; /** * FopImage object using PNG - * @author Eric SCHAEFFER + * * @see AbstractFopImage * @see FopImage */ @@ -45,8 +45,7 @@ public class PNGImage extends XmlGraphicsCommonsImage { } /** - * @see org.apache.fop.image.XmlGraphicsCommonsImage#decodeImage( - * org.apache.xmlgraphics.image.codec.util.SeekableStream) + * {@inheritDoc} */ protected CachableRed decodeImage(SeekableStream stream) throws IOException { PNGDecodeParam param = new PNGDecodeParam(); diff --git a/src/java/org/apache/fop/image/TIFFImage.java b/src/java/org/apache/fop/image/TIFFImage.java index 841bd2304..d9a9fc022 100644 --- a/src/java/org/apache/fop/image/TIFFImage.java +++ b/src/java/org/apache/fop/image/TIFFImage.java @@ -65,7 +65,7 @@ public class TIFFImage extends XmlGraphicsCommonsImage { } /** - * @see org.apache.fop.image.XmlGraphicsCommonsImage#decodeImage( + * {@inheritDoc} * org.apache.xmlgraphics.image.codec.util.SeekableStream) */ protected CachableRed decodeImage(SeekableStream stream) throws IOException { @@ -128,7 +128,7 @@ public class TIFFImage extends XmlGraphicsCommonsImage { * This loads only strip 1 of the original TIFF data. * * @return true if loaded false for any error - * @see org.apache.fop.image.AbstractFopImage#loadOriginalData() + * {@inheritDoc} */ protected boolean loadOriginalData() { if (loadDimensions()) { diff --git a/src/java/org/apache/fop/image/XmlGraphicsCommonsImage.java b/src/java/org/apache/fop/image/XmlGraphicsCommonsImage.java index 7bcd2a997..662673726 100644 --- a/src/java/org/apache/fop/image/XmlGraphicsCommonsImage.java +++ b/src/java/org/apache/fop/image/XmlGraphicsCommonsImage.java @@ -38,6 +38,7 @@ import org.apache.commons.io.IOUtils; /** * Abstract FopImage implementation which uses the internal codecs from XML Graphics Commons. + * * @see AbstractFopImage * @see FopImage */ @@ -64,7 +65,7 @@ public abstract class XmlGraphicsCommonsImage extends AbstractFopImage { } /** - * @see org.apache.fop.image.AbstractFopImage#loadDimensions() + * {@inheritDoc} */ protected boolean loadDimensions() { if (seekableInput == null && inputStream != null) { @@ -128,7 +129,7 @@ public abstract class XmlGraphicsCommonsImage extends AbstractFopImage { } /** - * @see org.apache.fop.image.AbstractFopImage#loadBitmap() + * {@inheritDoc} */ protected boolean loadBitmap() { if (this.bitmaps == null) { @@ -139,7 +140,7 @@ public abstract class XmlGraphicsCommonsImage extends AbstractFopImage { } /** - * @see org.apache.fop.image.FopImage#hasSoftMask() + * {@inheritDoc} */ public boolean hasSoftMask() { if (this.bitmaps == null && this.raw == null) { @@ -150,7 +151,7 @@ public abstract class XmlGraphicsCommonsImage extends AbstractFopImage { } /** - * @see org.apache.fop.image.FopImage#getSoftMask() + * {@inheritDoc} */ public byte[] getSoftMask() { if (this.bitmaps == null) { diff --git a/src/java/org/apache/fop/image/analyser/BMPReader.java b/src/java/org/apache/fop/image/analyser/BMPReader.java index a4f401462..caca6f3dd 100644 --- a/src/java/org/apache/fop/image/analyser/BMPReader.java +++ b/src/java/org/apache/fop/image/analyser/BMPReader.java @@ -47,7 +47,7 @@ public class BMPReader implements ImageReader { /** offset to vertical res */ private static final int VRES_OFFSET = 42; - /** @see org.apache.fop.image.analyser.ImageReader */ + /** {@inheritDoc} */ public FopImage.ImageInfo verifySignature(String uri, InputStream bis, FOUserAgent ua) throws IOException { byte[] header = getDefaultHeader(bis); diff --git a/src/java/org/apache/fop/image/analyser/EMFReader.java b/src/java/org/apache/fop/image/analyser/EMFReader.java index b61cff441..bdc4e97ff 100644 --- a/src/java/org/apache/fop/image/analyser/EMFReader.java +++ b/src/java/org/apache/fop/image/analyser/EMFReader.java @@ -52,7 +52,7 @@ public class EMFReader implements ImageReader { /** offset to vertical resolution in mm */
private static final int VRES_MM_OFFSET = 84;
- /** @see org.apache.fop.image.analyser.ImageReader */
+ /** {@inheritDoc} */
public FopImage.ImageInfo verifySignature(String uri, InputStream bis,
FOUserAgent ua) throws IOException {
byte[] header = getDefaultHeader(bis);
diff --git a/src/java/org/apache/fop/image/analyser/EPSReader.java b/src/java/org/apache/fop/image/analyser/EPSReader.java index eba620fee..92260d1ab 100644 --- a/src/java/org/apache/fop/image/analyser/EPSReader.java +++ b/src/java/org/apache/fop/image/analyser/EPSReader.java @@ -42,7 +42,7 @@ public class EPSReader implements ImageReader { //private static final byte[] HIRESBOUNDINGBOX = "%%HiResBoundingBox: ".getBytes(); //TODO Implement HiResBoundingBox, ImageInfo probably needs some changes for that - /** @see org.apache.fop.image.analyser.ImageReader */ + /** {@inheritDoc} */ public FopImage.ImageInfo verifySignature(String uri, InputStream bis, FOUserAgent ua) throws IOException { diff --git a/src/java/org/apache/fop/image/analyser/GIFReader.java b/src/java/org/apache/fop/image/analyser/GIFReader.java index 206947f88..d8da89607 100644 --- a/src/java/org/apache/fop/image/analyser/GIFReader.java +++ b/src/java/org/apache/fop/image/analyser/GIFReader.java @@ -37,7 +37,7 @@ public class GIFReader implements ImageReader { private static final int GIF_SIG_LENGTH = 10; - /** @see org.apache.fop.image.analyser.ImageReader */ + /** {@inheritDoc} */ public FopImage.ImageInfo verifySignature(String uri, InputStream bis, FOUserAgent ua) throws IOException { byte[] header = getDefaultHeader(bis); diff --git a/src/java/org/apache/fop/image/analyser/JPEGReader.java b/src/java/org/apache/fop/image/analyser/JPEGReader.java index bfa7d78d8..c90f6b000 100644 --- a/src/java/org/apache/fop/image/analyser/JPEGReader.java +++ b/src/java/org/apache/fop/image/analyser/JPEGReader.java @@ -54,7 +54,7 @@ public class JPEGReader implements ImageReader { private static final int SOI = 0xd8; // start of Image private static final int JPG_SIG_LENGTH = 2; - /** @see org.apache.fop.image.analyser.ImageReader */ + /** {@inheritDoc} */ public FopImage.ImageInfo verifySignature(String uri, InputStream fis, FOUserAgent ua) throws IOException { byte[] header = getDefaultHeader(fis); diff --git a/src/java/org/apache/fop/image/analyser/PNGReader.java b/src/java/org/apache/fop/image/analyser/PNGReader.java index 1c46f8d6e..ab6c64775 100644 --- a/src/java/org/apache/fop/image/analyser/PNGReader.java +++ b/src/java/org/apache/fop/image/analyser/PNGReader.java @@ -37,7 +37,7 @@ public class PNGReader implements ImageReader { private static final int PNG_SIG_LENGTH = 24; - /** @see org.apache.fop.image.analyser.ImageReader */ + /** {@inheritDoc} */ public FopImage.ImageInfo verifySignature(String uri, InputStream bis, FOUserAgent ua) throws IOException { byte[] header = getDefaultHeader(bis); diff --git a/src/java/org/apache/fop/image/analyser/SVGReader.java b/src/java/org/apache/fop/image/analyser/SVGReader.java index da702d0c1..cffaa365c 100644 --- a/src/java/org/apache/fop/image/analyser/SVGReader.java +++ b/src/java/org/apache/fop/image/analyser/SVGReader.java @@ -58,7 +58,7 @@ public class SVGReader implements ImageReader { private boolean batik = true; - /** @see org.apache.fop.image.analyser.ImageReader */ + /** {@inheritDoc} */ public FopImage.ImageInfo verifySignature(String uri, InputStream fis, FOUserAgent ua) throws IOException { FopImage.ImageInfo info = loadImage(uri, fis, ua); diff --git a/src/java/org/apache/fop/image/analyser/TIFFReader.java b/src/java/org/apache/fop/image/analyser/TIFFReader.java index a70a105d7..08d702780 100644 --- a/src/java/org/apache/fop/image/analyser/TIFFReader.java +++ b/src/java/org/apache/fop/image/analyser/TIFFReader.java @@ -37,7 +37,7 @@ public class TIFFReader implements ImageReader { private static final int TIFF_SIG_LENGTH = 8; - /** @see org.apache.fop.image.analyser.ImageReader */ + /** {@inheritDoc} */ public FopImage.ImageInfo verifySignature(String uri, InputStream bis, FOUserAgent ua) throws IOException { byte[] header = getDefaultHeader(bis); diff --git a/src/java/org/apache/fop/image/analyser/XMLReader.java b/src/java/org/apache/fop/image/analyser/XMLReader.java index aa558c1e7..4d0145eed 100644 --- a/src/java/org/apache/fop/image/analyser/XMLReader.java +++ b/src/java/org/apache/fop/image/analyser/XMLReader.java @@ -59,7 +59,7 @@ public class XMLReader implements ImageReader { converters.put(ns, conv); } - /** @see org.apache.fop.image.analyser.ImageReader */ + /** {@inheritDoc} */ public FopImage.ImageInfo verifySignature(String uri, InputStream fis, FOUserAgent ua) throws IOException { diff --git a/src/java/org/apache/fop/layoutmgr/AbstractBaseLayoutManager.java b/src/java/org/apache/fop/layoutmgr/AbstractBaseLayoutManager.java index 9c0cb7684..c5e0ddfc9 100644 --- a/src/java/org/apache/fop/layoutmgr/AbstractBaseLayoutManager.java +++ b/src/java/org/apache/fop/layoutmgr/AbstractBaseLayoutManager.java @@ -68,7 +68,7 @@ public abstract class AbstractBaseLayoutManager // --------- Property Resolution related functions --------- // /** - * @see org.apache.fop.datatypes.PercentBaseContext#getBaseLength(int, FObj) + * {@inheritDoc} */ public int getBaseLength(int lengthBase, FObj fobj) { if (fobj == this.fobj) { @@ -202,9 +202,7 @@ public abstract class AbstractBaseLayoutManager } /** - * Returns the IPD of the content area - * @return the IPD of the content area - * @see LayoutManager#getContentAreaIPD + * {@inheritDoc} */ public int getContentAreaIPD() { log.error("getContentAreaIPD called when it should have been overwritten"); @@ -212,9 +210,7 @@ public abstract class AbstractBaseLayoutManager } /** - * Returns the BPD of the content area - * @return the BPD of the content area - * @see LayoutManager#getContentAreaBPD + * {@inheritDoc} */ public int getContentAreaBPD() { log.error("getContentAreaBPD called when it should have been overwritten"); @@ -222,7 +218,7 @@ public abstract class AbstractBaseLayoutManager } /** - * @see LayoutManager#getGeneratesReferenceArea + * {@inheritDoc} */ public boolean getGeneratesReferenceArea() { return generatesReferenceArea; @@ -239,7 +235,7 @@ public abstract class AbstractBaseLayoutManager } /** - * @see LayoutManager#getGeneratesBlockArea + * {@inheritDoc} */ public boolean getGeneratesBlockArea() { return generatesBlockArea; @@ -255,14 +251,14 @@ public abstract class AbstractBaseLayoutManager } /** - * @see org.apache.fop.layoutmgr.LayoutManager#getGeneratesLineArea + * {@inheritDoc} */ public boolean getGeneratesLineArea() { return false; } /** - * @see org.apache.fop.layoutmgr.LayoutManager#getFObj + * {@inheritDoc} */ public FObj getFObj() { return fobj; diff --git a/src/java/org/apache/fop/layoutmgr/AbstractLayoutManager.java b/src/java/org/apache/fop/layoutmgr/AbstractLayoutManager.java index 8c7ac1cad..3bff264ee 100644 --- a/src/java/org/apache/fop/layoutmgr/AbstractLayoutManager.java +++ b/src/java/org/apache/fop/layoutmgr/AbstractLayoutManager.java @@ -86,17 +86,17 @@ public abstract class AbstractLayoutManager extends AbstractBaseLayoutManager childLMiter = new LMiter(this); } - /** @see LayoutManager#setParent(LayoutManager) */ + /** {@inheritDoc} */ public void setParent(LayoutManager lm) { this.parentLM = lm; } - /** @see LayoutManager#getParent */ + /** {@inheritDoc} */ public LayoutManager getParent() { return this.parentLM; } - /** @see LayoutManager#initialize */ + /** {@inheritDoc} */ public void initialize() { // Empty } @@ -160,7 +160,7 @@ public abstract class AbstractLayoutManager extends AbstractBaseLayoutManager } } - /** @see LayoutManager#resetPosition(Position) */ + /** {@inheritDoc} */ public void resetPosition(Position resetPos) { // if (resetPos == null) { // reset(null); @@ -185,15 +185,13 @@ public abstract class AbstractLayoutManager extends AbstractBaseLayoutManager } /** - * @see org.apache.fop.layoutmgr.LayoutManager#addAreas( - * org.apache.fop.layoutmgr.PositionIterator - * , org.apache.fop.layoutmgr.LayoutContext) + * {@inheritDoc} */ public void addAreas(PositionIterator posIter, LayoutContext context) { } /** - * @see org.apache.fop.layoutmgr.LayoutManager#getNextKnuthElements(LayoutContext, int) + * {@inheritDoc} */ public LinkedList getNextKnuthElements(LayoutContext context, int alignment) { @@ -203,7 +201,7 @@ public abstract class AbstractLayoutManager extends AbstractBaseLayoutManager } /** - * @see org.apache.fop.layoutmgr.LayoutManager#getChangedKnuthElements(List, int) + * {@inheritDoc} */ public LinkedList getChangedKnuthElements(List oldList, int alignment) { @@ -265,14 +263,14 @@ public abstract class AbstractLayoutManager extends AbstractBaseLayoutManager } /** - * @see org.apache.fop.layoutmgr.PageSequenceLayoutManager#getPSLM + * {@inheritDoc} */ public PageSequenceLayoutManager getPSLM() { return parentLM.getPSLM(); } /** - * @see org.apache.fop.layoutmgr.PageSequenceLayoutManager#getCurrentPage + * @see PageSequenceLayoutManager#getCurrentPage() */ public Page getCurrentPage() { return getPSLM().getCurrentPage(); @@ -284,7 +282,7 @@ public abstract class AbstractLayoutManager extends AbstractBaseLayoutManager } /** - * @see org.apache.fop.layoutmgr.LayoutManager#createNextChildLMs + * {@inheritDoc} */ public boolean createNextChildLMs(int pos) { List newLMs = createChildLMs(pos + 1 - childLMs.size()); @@ -293,7 +291,7 @@ public abstract class AbstractLayoutManager extends AbstractBaseLayoutManager } /** - * @see org.apache.fop.layoutmgr.LayoutManager#getChildLMs + * {@inheritDoc} */ public List getChildLMs() { if (childLMs == null) { @@ -303,7 +301,7 @@ public abstract class AbstractLayoutManager extends AbstractBaseLayoutManager } /** - * @see org.apache.fop.layoutmgr.LayoutManager#addChildLM + * {@inheritDoc} */ public void addChildLM(LayoutManager lm) { if (lm == null) { @@ -319,7 +317,7 @@ public abstract class AbstractLayoutManager extends AbstractBaseLayoutManager } /** - * @see org.apache.fop.layoutmgr.LayoutManager#addChildLMs + * {@inheritDoc} */ public void addChildLMs(List newLMs) { if (newLMs == null || newLMs.size() == 0) { diff --git a/src/java/org/apache/fop/layoutmgr/BalancingColumnBreakingAlgorithm.java b/src/java/org/apache/fop/layoutmgr/BalancingColumnBreakingAlgorithm.java index 9f3207773..8d7375451 100644 --- a/src/java/org/apache/fop/layoutmgr/BalancingColumnBreakingAlgorithm.java +++ b/src/java/org/apache/fop/layoutmgr/BalancingColumnBreakingAlgorithm.java @@ -36,7 +36,7 @@ public class BalancingColumnBreakingAlgorithm extends PageBreakingAlgorithm { private int idealPartLen;
public BalancingColumnBreakingAlgorithm(LayoutManager topLevelLM,
- PageProvider pageProvider, + PageProvider pageProvider,
PageBreakingLayoutListener layoutListener,
int alignment, int alignmentLast,
MinOptMax footnoteSeparatorLength,
@@ -49,7 +49,7 @@ public class BalancingColumnBreakingAlgorithm extends PageBreakingAlgorithm { this.considerTooShort = true; //This is important!
}
- /** @see org.apache.fop.layoutmgr.BreakingAlgorithm */
+ /** {@inheritDoc} */
protected double computeDemerits(KnuthNode activeNode,
KnuthElement element, int fitnessClass, double r) {
double dem = super.computeDemerits(activeNode, element, fitnessClass, r);
diff --git a/src/java/org/apache/fop/layoutmgr/BlockContainerLayoutManager.java b/src/java/org/apache/fop/layoutmgr/BlockContainerLayoutManager.java index 117893304..9f2c7d8ac 100644 --- a/src/java/org/apache/fop/layoutmgr/BlockContainerLayoutManager.java +++ b/src/java/org/apache/fop/layoutmgr/BlockContainerLayoutManager.java @@ -94,7 +94,7 @@ public class BlockContainerLayoutManager extends BlockStackingLayoutManager super(node); } - /** @see org.apache.fop.layoutmgr.LayoutManager#initialize() */ + /** {@inheritDoc} */ public void initialize() { abProps = getBlockContainerFO().getCommonAbsolutePosition(); foBlockSpaceBefore = new SpaceVal(getBlockContainerFO().getCommonMarginBlock() @@ -179,7 +179,7 @@ public class BlockContainerLayoutManager extends BlockStackingLayoutManager return (abProps.absolutePosition == EN_FIXED); } - /** @see org.apache.fop.layoutmgr.LayoutManager#getContentAreaBPD() */ + /** {@inheritDoc} */ public int getContentAreaBPD() { if (autoHeight) { return -1; @@ -188,7 +188,7 @@ public class BlockContainerLayoutManager extends BlockStackingLayoutManager } } - /** @see org.apache.fop.layoutmgr.LayoutManager */ + /** {@inheritDoc} */ public LinkedList getNextKnuthElements(LayoutContext context, int alignment) { resetSpaces(); if (isAbsoluteOrFixed()) { @@ -556,19 +556,19 @@ public class BlockContainerLayoutManager extends BlockStackingLayoutManager this.ipd = ipd; } - /** @see org.apache.fop.layoutmgr.AbstractBreaker#observeElementList(java.util.List) */ + /** {@inheritDoc} */ protected void observeElementList(List elementList) { ElementListObserver.observe(elementList, "block-container", bclm.getBlockContainerFO().getId()); } - /** @see org.apache.fop.layoutmgr.AbstractBreaker#isPartOverflowRecoveryActivated() */ + /** {@inheritDoc} */ protected boolean isPartOverflowRecoveryActivated() { //For block-containers, this must be disabled because of wanted overflow. return false; } - /** @see org.apache.fop.layoutmgr.AbstractBreaker#isSinglePartFavored() */ + /** {@inheritDoc} */ protected boolean isSinglePartFavored() { return true; } @@ -674,7 +674,7 @@ public class BlockContainerLayoutManager extends BlockStackingLayoutManager return new Point(x, y); } - /** @see org.apache.fop.layoutmgr.LayoutManager */ + /** {@inheritDoc} */ public void addAreas(PositionIterator parentIter, LayoutContext layoutContext) { getParentArea(null); @@ -862,7 +862,7 @@ public class BlockContainerLayoutManager extends BlockStackingLayoutManager * This returns the current block container area * and creates it if required. * - * @see org.apache.fop.layoutmgr.LayoutManager#getParentArea(Area) + * {@inheritDoc} */ public Area getParentArea(Area childArea) { if (referenceArea == null) { @@ -933,7 +933,7 @@ public class BlockContainerLayoutManager extends BlockStackingLayoutManager /** * Add the child to the block container. * - * @see org.apache.fop.layoutmgr.LayoutManager#addChildArea(Area) + * {@inheritDoc} */ public void addChildArea(Area childArea) { if (referenceArea != null) { @@ -942,7 +942,7 @@ public class BlockContainerLayoutManager extends BlockStackingLayoutManager } /** - * @see org.apache.fop.layoutmgr.LayoutManager#resetPosition(org.apache.fop.layoutmgr.Position) + * {@inheritDoc} */ public void resetPosition(Position resetPos) { if (resetPos == null) { @@ -952,7 +952,7 @@ public class BlockContainerLayoutManager extends BlockStackingLayoutManager /** * Force current area to be added to parent area. - * @see org.apache.fop.layoutmgr.BlockStackingLayoutManager#flush() + * {@inheritDoc} */ protected void flush() { viewportBlockArea.addBlock(referenceArea, autoHeight); @@ -973,20 +973,20 @@ public class BlockContainerLayoutManager extends BlockStackingLayoutManager } } - /** @see org.apache.fop.layoutmgr.BlockLevelLayoutManager */ + /** {@inheritDoc} */ public int negotiateBPDAdjustment(int adj, KnuthElement lastElement) { // TODO Auto-generated method stub return 0; } - /** @see org.apache.fop.layoutmgr.BlockLevelLayoutManager */ + /** {@inheritDoc} */ public void discardSpace(KnuthGlue spaceGlue) { // TODO Auto-generated method stub } /** - * @see org.apache.fop.layoutmgr.BlockLevelLayoutManager#mustKeepTogether() + * {@inheritDoc} */ public boolean mustKeepTogether() { //TODO Keeps will have to be more sophisticated sooner or later @@ -999,7 +999,7 @@ public class BlockContainerLayoutManager extends BlockStackingLayoutManager } /** - * @see org.apache.fop.layoutmgr.BlockLevelLayoutManager#mustKeepWithPrevious() + * {@inheritDoc} */ public boolean mustKeepWithPrevious() { return !getBlockContainerFO().getKeepWithPrevious().getWithinPage().isAuto() @@ -1007,7 +1007,7 @@ public class BlockContainerLayoutManager extends BlockStackingLayoutManager } /** - * @see org.apache.fop.layoutmgr.BlockLevelLayoutManager#mustKeepWithNext() + * {@inheritDoc} */ public boolean mustKeepWithNext() { return !getBlockContainerFO().getKeepWithNext().getWithinPage().isAuto() @@ -1024,20 +1024,20 @@ public class BlockContainerLayoutManager extends BlockStackingLayoutManager // --------- Property Resolution related functions --------- // /** - * @see org.apache.fop.layoutmgr.LayoutManager#getGeneratesReferenceArea + * {@inheritDoc} */ public boolean getGeneratesReferenceArea() { return true; } /** - * @see org.apache.fop.layoutmgr.LayoutManager#getGeneratesBlockArea + * {@inheritDoc} */ public boolean getGeneratesBlockArea() { return true; } - /** @see org.apache.fop.layoutmgr.ConditionalElementListener */ + /** {@inheritDoc} */ public void notifySpace(RelSide side, MinOptMax effectiveLength) { if (RelSide.BEFORE == side) { if (log.isDebugEnabled()) { @@ -1054,7 +1054,7 @@ public class BlockContainerLayoutManager extends BlockStackingLayoutManager } } - /** @see org.apache.fop.layoutmgr.ConditionalElementListener */ + /** {@inheritDoc} */ public void notifyBorder(RelSide side, MinOptMax effectiveLength) { if (effectiveLength == null) { if (RelSide.BEFORE == side) { @@ -1068,7 +1068,7 @@ public class BlockContainerLayoutManager extends BlockStackingLayoutManager } } - /** @see org.apache.fop.layoutmgr.ConditionalElementListener */ + /** {@inheritDoc} */ public void notifyPadding(RelSide side, MinOptMax effectiveLength) { if (effectiveLength == null) { if (RelSide.BEFORE == side) { diff --git a/src/java/org/apache/fop/layoutmgr/BlockKnuthSequence.java b/src/java/org/apache/fop/layoutmgr/BlockKnuthSequence.java index ae03487e1..d3365b10f 100644 --- a/src/java/org/apache/fop/layoutmgr/BlockKnuthSequence.java +++ b/src/java/org/apache/fop/layoutmgr/BlockKnuthSequence.java @@ -44,31 +44,23 @@ public class BlockKnuthSequence extends KnuthSequence { super(list); } - /* (non-Javadoc) - * @see org.apache.fop.layoutmgr.KnuthList#isInlineSequence() - */ + /** {@inheritDoc} */ public boolean isInlineSequence() { return false; } - /* (non-Javadoc) - * @see org.apache.fop.layoutmgr.KnuthList#canAppendSequence(org.apache.fop.layoutmgr.KnuthSequence) - */ + /** {@inheritDoc} */ public boolean canAppendSequence(KnuthSequence sequence) { return !sequence.isInlineSequence() && !isClosed; } - /* (non-Javadoc) - * @see org.apache.fop.layoutmgr.KnuthList#appendSequence(org.apache.fop.layoutmgr.KnuthSequence,) - */ + /** {@inheritDoc} */ public boolean appendSequence(KnuthSequence sequence) { // log.debug("Cannot append a sequence without a BreakElement"); return false; } - /* (non-Javadoc) - * @see KnuthList#appendSequence(KnuthSequence, boolean, BreakElement) - */ + /** {@inheritDoc} */ public boolean appendSequence(KnuthSequence sequence, boolean keepTogether, BreakElement breakElement) { if (!canAppendSequence(sequence)) { @@ -85,9 +77,7 @@ public class BlockKnuthSequence extends KnuthSequence { return true; } - /* (non-Javadoc) - * @see org.apache.fop.layoutmgr.KnuthSequence#endSequence() - */ + /** {@inheritDoc} */ public KnuthSequence endSequence() { isClosed = true; return this; diff --git a/src/java/org/apache/fop/layoutmgr/BlockLayoutManager.java b/src/java/org/apache/fop/layoutmgr/BlockLayoutManager.java index cf1cd4e4d..0300a6cf2 100644 --- a/src/java/org/apache/fop/layoutmgr/BlockLayoutManager.java +++ b/src/java/org/apache/fop/layoutmgr/BlockLayoutManager.java @@ -55,7 +55,7 @@ public class BlockLayoutManager extends BlockStackingLayoutManager private int lead = 12000; private Length lineHeight; private int follow = 2000; - private int middleShift = 0; + //private int middleShift = 0; private boolean discardBorderBefore; private boolean discardBorderAfter; @@ -83,7 +83,7 @@ public class BlockLayoutManager extends BlockStackingLayoutManager lead = fs.getAscender(); follow = -fs.getDescender(); - middleShift = -fs.getXHeight() / 2; + //middleShift = -fs.getXHeight() / 2; lineHeight = getBlockFO().getLineHeight().getOptimum(this).getLength(); startIndent = getBlockFO().getCommonMarginBlock().startIndent.getValue(this); endIndent = getBlockFO().getCommonMarginBlock().endIndent.getValue(this); @@ -107,7 +107,7 @@ public class BlockLayoutManager extends BlockStackingLayoutManager } } - /** @see org.apache.fop.layoutmgr.BlockStackingLayoutManager */ + /** {@inheritDoc} */ public LinkedList getNextKnuthElements(LayoutContext context, int alignment) { resetSpaces(); return super.getNextKnuthElements(context, alignment); @@ -160,7 +160,7 @@ public class BlockLayoutManager extends BlockStackingLayoutManager } /** - * @see org.apache.fop.layoutmgr.LayoutManager#createNextChildLMs + * {@inheritDoc} */ public boolean createNextChildLMs(int pos) { @@ -204,7 +204,7 @@ public class BlockLayoutManager extends BlockStackingLayoutManager } /** - * @see org.apache.fop.layoutmgr.BlockLevelLayoutManager#mustKeepTogether() + * {@inheritDoc} */ public boolean mustKeepTogether() { // TODO Keeps will have to be more sophisticated sooner or later @@ -219,7 +219,7 @@ public class BlockLayoutManager extends BlockStackingLayoutManager } /** - * @see org.apache.fop.layoutmgr.BlockLevelLayoutManager#mustKeepWithPrevious() + * {@inheritDoc} */ public boolean mustKeepWithPrevious() { return !getBlockFO().getKeepWithPrevious().getWithinPage().isAuto() @@ -227,7 +227,7 @@ public class BlockLayoutManager extends BlockStackingLayoutManager } /** - * @see org.apache.fop.layoutmgr.BlockLevelLayoutManager#mustKeepWithNext() + * {@inheritDoc} */ public boolean mustKeepWithNext() { return !getBlockFO().getKeepWithNext().getWithinPage().isAuto() @@ -235,7 +235,7 @@ public class BlockLayoutManager extends BlockStackingLayoutManager } /** - * @see org.apache.fop.layoutmgr.LayoutManager#addAreas(org.apache.fop.layoutmgr.PositionIterator, org.apache.fop.layoutmgr.LayoutContext) + * {@inheritDoc} */ public void addAreas(PositionIterator parentIter, LayoutContext layoutContext) { @@ -452,7 +452,7 @@ public class BlockLayoutManager extends BlockStackingLayoutManager } /** - * @see org.apache.fop.layoutmgr.LayoutManager#addChildArea(Area) + * {@inheritDoc} */ public void addChildArea(Area childArea) { if (curBlockArea != null) { @@ -466,7 +466,7 @@ public class BlockLayoutManager extends BlockStackingLayoutManager /** * Force current area to be added to parent area. - * @see org.apache.fop.layoutmgr.BlockStackingLayoutManager#flush() + * {@inheritDoc} */ protected void flush() { if (curBlockArea != null) { @@ -478,7 +478,7 @@ public class BlockLayoutManager extends BlockStackingLayoutManager } /** - * @see org.apache.fop.layoutmgr.LayoutManager#resetPosition(org.apache.fop.layoutmgr.Position) + * {@inheritDoc} */ public void resetPosition(Position resetPos) { if (resetPos == null) { @@ -524,13 +524,13 @@ public class BlockLayoutManager extends BlockStackingLayoutManager } /** - * @see org.apache.fop.layoutmgr.LayoutManager#getGeneratesBlockArea + * {@inheritDoc} */ public boolean getGeneratesBlockArea() { return true; } - /** @see org.apache.fop.layoutmgr.ConditionalElementListener */ + /** {@inheritDoc} */ public void notifySpace(RelSide side, MinOptMax effectiveLength) { if (RelSide.BEFORE == side) { if (log.isDebugEnabled()) { @@ -547,7 +547,7 @@ public class BlockLayoutManager extends BlockStackingLayoutManager } } - /** @see org.apache.fop.layoutmgr.ConditionalElementListener */ + /** {@inheritDoc} */ public void notifyBorder(RelSide side, MinOptMax effectiveLength) { if (effectiveLength == null) { if (RelSide.BEFORE == side) { @@ -561,7 +561,7 @@ public class BlockLayoutManager extends BlockStackingLayoutManager } } - /** @see org.apache.fop.layoutmgr.ConditionalElementListener */ + /** {@inheritDoc} */ public void notifyPadding(RelSide side, MinOptMax effectiveLength) { if (effectiveLength == null) { if (RelSide.BEFORE == side) { diff --git a/src/java/org/apache/fop/layoutmgr/BlockStackingLayoutManager.java b/src/java/org/apache/fop/layoutmgr/BlockStackingLayoutManager.java index ca6939e56..d4b332a18 100644 --- a/src/java/org/apache/fop/layoutmgr/BlockStackingLayoutManager.java +++ b/src/java/org/apache/fop/layoutmgr/BlockStackingLayoutManager.java @@ -192,6 +192,7 @@ public abstract class BlockStackingLayoutManager extends AbstractLayoutManager * Determines and sets the content area IPD based on available reference area IPD, start- and * end-indent properties. * end-indent is adjusted based on overconstrained geometry rules, if necessary. + * * @return the resulting content area IPD */ protected int updateContentAreaIPDwithOverconstrainedAdjust() { @@ -210,6 +211,7 @@ public abstract class BlockStackingLayoutManager extends AbstractLayoutManager /** * Sets the content area IPD by directly supplying the value. * end-indent is adjusted based on overconstrained geometry rules, if necessary. + * * @return the resulting content area IPD */ protected int updateContentAreaIPDwithOverconstrainedAdjust(int contentIPD) { @@ -224,7 +226,7 @@ public abstract class BlockStackingLayoutManager extends AbstractLayoutManager } /** - * @see LayoutManager#getNextKnuthElements(LayoutContext, int) + * {@inheritDoc} */ public LinkedList getNextKnuthElements(LayoutContext context, int alignment) { //log.debug("BLM.getNextKnuthElements> keep-together = " @@ -400,7 +402,7 @@ public abstract class BlockStackingLayoutManager extends AbstractLayoutManager } /** - * @see org.apache.fop.layoutmgr.BlockLevelLayoutManager#negotiateBPDAdjustment(int, org.apache.fop.layoutmgr.KnuthElement) + * {@inheritDoc} */ public int negotiateBPDAdjustment(int adj, KnuthElement lastElement) { /*LF*/ //log.debug(" BLM.negotiateBPDAdjustment> " + adj); @@ -483,7 +485,7 @@ public abstract class BlockStackingLayoutManager extends AbstractLayoutManager } /** - * @see BlockLevelLayoutManager#discardSpace(KnuthGlue) + * {@inheritDoc} */ public void discardSpace(KnuthGlue spaceGlue) { //log.debug(" BLM.discardSpace> " + spaceGlue.getPosition().getClass().getName()); @@ -513,7 +515,7 @@ public abstract class BlockStackingLayoutManager extends AbstractLayoutManager } /** - * @see LayoutManager#getChangedKnuthElements(List, int) + * {@inheritDoc} */ public LinkedList getChangedKnuthElements(List oldList, int alignment) { /*LF*/ //log.debug(""); @@ -726,7 +728,7 @@ public abstract class BlockStackingLayoutManager extends AbstractLayoutManager } /** - * @see org.apache.fop.layoutmgr.BlockLevelLayoutManager#mustKeepTogether() + * {@inheritDoc} */ // default action: ask parentLM public boolean mustKeepTogether() { @@ -737,14 +739,14 @@ public abstract class BlockStackingLayoutManager extends AbstractLayoutManager } /** - * @see org.apache.fop.layoutmgr.BlockLevelLayoutManager#mustKeepWithPrevious() + * {@inheritDoc} */ public boolean mustKeepWithPrevious() { return false; } /** - * @see org.apache.fop.layoutmgr.BlockLevelLayoutManager#mustKeepWithNext() + * {@inheritDoc} */ public boolean mustKeepWithNext() { return false; diff --git a/src/java/org/apache/fop/layoutmgr/BorderElement.java b/src/java/org/apache/fop/layoutmgr/BorderElement.java index b1af89a99..410ba7ebb 100644 --- a/src/java/org/apache/fop/layoutmgr/BorderElement.java +++ b/src/java/org/apache/fop/layoutmgr/BorderElement.java @@ -43,7 +43,7 @@ public class BorderElement extends BorderOrPaddingElement { super(position, condLength, side, isFirst, isLast, context); } - /** @see org.apache.fop.layoutmgr.UnresolvedListElementWithLength */ + /** {@inheritDoc} */ public void notifyLayoutManager(MinOptMax effectiveLength) { LayoutManager lm = getOriginatingLayoutManager(); if (lm instanceof ConditionalElementListener) { @@ -55,7 +55,7 @@ public class BorderElement extends BorderOrPaddingElement { } } - /** @see java.lang.Object#toString() */ + /** {@inheritDoc} */ public String toString() { StringBuffer sb = new StringBuffer("Border["); sb.append(super.toString()); diff --git a/src/java/org/apache/fop/layoutmgr/BorderOrPaddingElement.java b/src/java/org/apache/fop/layoutmgr/BorderOrPaddingElement.java index 2af1418db..d78a92610 100644 --- a/src/java/org/apache/fop/layoutmgr/BorderOrPaddingElement.java +++ b/src/java/org/apache/fop/layoutmgr/BorderOrPaddingElement.java @@ -45,7 +45,7 @@ public abstract class BorderOrPaddingElement extends UnresolvedListElementWithLe condLength.isDiscard(), isFirst, isLast); } - /** @see org.apache.fop.layoutmgr.UnresolvedListElementWithLength */ + /** {@inheritDoc} */ public abstract void notifyLayoutManager(MinOptMax effectiveLength); } diff --git a/src/java/org/apache/fop/layoutmgr/BreakElement.java b/src/java/org/apache/fop/layoutmgr/BreakElement.java index d19247a1b..73f8eaf62 100644 --- a/src/java/org/apache/fop/layoutmgr/BreakElement.java +++ b/src/java/org/apache/fop/layoutmgr/BreakElement.java @@ -62,12 +62,12 @@ public class BreakElement extends UnresolvedListElement { this.pendingAfterMarks = context.getPendingAfterMarks(); } - /** @see org.apache.fop.layoutmgr.UnresolvedListElement#isConditional() */ + /** {@inheritDoc} */ public boolean isConditional() { return false; //Does not really apply here } - /** @see org.apache.fop.layoutmgr.ListElement#isPenalty() */ + /** {@inheritDoc} */ /* public boolean isPenalty() { return true; //not entirely true but a BreakElement will generate a penalty later @@ -91,7 +91,7 @@ public class BreakElement extends UnresolvedListElement { this.penaltyValue = p; } - /** @see org.apache.fop.layoutmgr.ListElement#isForcedBreak() */ + /** {@inheritDoc} */ public boolean isForcedBreak() { return penaltyValue == -KnuthElement.INFINITE; } @@ -119,7 +119,7 @@ public class BreakElement extends UnresolvedListElement { return this.pendingAfterMarks; } - /** @see java.lang.Object#toString() */ + /** {@inheritDoc} */ public String toString() { StringBuffer sb = new StringBuffer(); sb.append("BreakPossibility[p:"); diff --git a/src/java/org/apache/fop/layoutmgr/BreakingAlgorithm.java b/src/java/org/apache/fop/layoutmgr/BreakingAlgorithm.java index 8da241395..df4bb1d47 100644 --- a/src/java/org/apache/fop/layoutmgr/BreakingAlgorithm.java +++ b/src/java/org/apache/fop/layoutmgr/BreakingAlgorithm.java @@ -151,7 +151,7 @@ public abstract class BreakingAlgorithm { protected BestRecords best; - /** @see #isPartOverflowRecoveryActivated() */ + /** {@inheritDoc} */ private boolean partOverflowRecoveryActivated = true; private KnuthNode lastRecovered; @@ -397,9 +397,10 @@ public abstract class BreakingAlgorithm { } /** @see #findBreakingPoints(KnuthSequence, int, double, boolean, int) */ - public int findBreakingPoints(KnuthSequence par, /*int lineWidth,*/ - double threshold, boolean force, - int allowedBreaks) { + public int findBreakingPoints(KnuthSequence par, + double threshold, + boolean force, + int allowedBreaks) { return findBreakingPoints(par, 0, threshold, force, allowedBreaks); } @@ -412,7 +413,6 @@ public abstract class BreakingAlgorithm { * @param allowedBreaks one of ONLY_FORCED_BREAKS, NO_FLAGGED_PENALTIES, ALL_BREAKS */ public int findBreakingPoints(KnuthSequence par, int startIndex, - /*int lineWidth,*/ double threshold, boolean force, int allowedBreaks) { this.par = par; @@ -634,7 +634,7 @@ public abstract class BreakingAlgorithm { /** Creates a new active node for a break from the best active node of the given * fitness class to the element at the given position. - * @see #createNode(int, int, int, int, int, int, double, int, int, int, double, KnuthNode) + * @see #createNode(int, int, int, int, int, int, double, int, int, int, double, org.apache.fop.layoutmgr.BreakingAlgorithm.KnuthNode) * @see BreakingAlgorithm.BestRecords */ protected KnuthNode createNode(int position, int line, int fitness, diff --git a/src/java/org/apache/fop/layoutmgr/FlowLayoutManager.java b/src/java/org/apache/fop/layoutmgr/FlowLayoutManager.java index e8f635311..3e5c329fa 100644 --- a/src/java/org/apache/fop/layoutmgr/FlowLayoutManager.java +++ b/src/java/org/apache/fop/layoutmgr/FlowLayoutManager.java @@ -61,7 +61,7 @@ public class FlowLayoutManager extends BlockStackingLayoutManager setParent(pslm); } - /** @see org.apache.fop.layoutmgr.LayoutManager */ + /** {@inheritDoc} */ public LinkedList getNextKnuthElements(LayoutContext context, int alignment) { // set layout dimensions @@ -165,7 +165,7 @@ public class FlowLayoutManager extends BlockStackingLayoutManager } /** - * @see org.apache.fop.layoutmgr.BlockLevelLayoutManager + * {@inheritDoc} */ public int negotiateBPDAdjustment(int adj, KnuthElement lastElement) { log.debug(" FLM.negotiateBPDAdjustment> " + adj); @@ -185,7 +185,7 @@ public class FlowLayoutManager extends BlockStackingLayoutManager } /** - * @see org.apache.fop.layoutmgr.BlockLevelLayoutManager + * {@inheritDoc} */ public void discardSpace(KnuthGlue spaceGlue) { log.debug(" FLM.discardSpace> "); @@ -199,23 +199,23 @@ public class FlowLayoutManager extends BlockStackingLayoutManager } } - /** @see org.apache.fop.layoutmgr.BlockLevelLayoutManager#mustKeepTogether() */ + /** {@inheritDoc} */ public boolean mustKeepTogether() { return false; } - /** @see org.apache.fop.layoutmgr.BlockLevelLayoutManager#mustKeepWithPrevious() */ + /** {@inheritDoc} */ public boolean mustKeepWithPrevious() { return false; } - /** @see org.apache.fop.layoutmgr.BlockLevelLayoutManager#mustKeepWithNext() */ + /** {@inheritDoc} */ public boolean mustKeepWithNext() { return false; } /** - * @see org.apache.fop.layoutmgr.LayoutManager#getChangedKnuthElements(java.util.List, int) + * {@inheritDoc} */ public LinkedList getChangedKnuthElements(List oldList, /*int flaggedPenalty,*/ int alignment) { ListIterator oldListIterator = oldList.listIterator(); @@ -291,7 +291,7 @@ public class FlowLayoutManager extends BlockStackingLayoutManager } /** - * @see org.apache.fop.layoutmgr.LayoutManager#addAreas(PositionIterator, LayoutContext) + * {@inheritDoc} */ public void addAreas(PositionIterator parentIter, LayoutContext layoutContext) { AreaAdditionUtil.addAreas(this, parentIter, layoutContext); @@ -302,7 +302,8 @@ public class FlowLayoutManager extends BlockStackingLayoutManager * Add child area to a the correct container, depending on its * area class. A Flow can fill at most one area container of any class * at any one time. The actual work is done by BlockStackingLM. - * @see org.apache.fop.layoutmgr.LayoutManager#addChildArea(Area) + * + * @param childArea the area to add */ public void addChildArea(Area childArea) { getParentArea(childArea); @@ -311,7 +312,7 @@ public class FlowLayoutManager extends BlockStackingLayoutManager } /** - * @see org.apache.fop.layoutmgr.LayoutManager#getParentArea(Area) + * {@inheritDoc} */ public Area getParentArea(Area childArea) { BlockParent parentArea = null; @@ -334,7 +335,7 @@ public class FlowLayoutManager extends BlockStackingLayoutManager } /** - * @see org.apache.fop.layoutmgr.LayoutManager#resetPosition(Position) + * {@inheritDoc} */ public void resetPosition(Position resetPos) { if (resetPos == null) { diff --git a/src/java/org/apache/fop/layoutmgr/FootnoteBodyLayoutManager.java b/src/java/org/apache/fop/layoutmgr/FootnoteBodyLayoutManager.java index 70f541b2d..71f4df314 100644 --- a/src/java/org/apache/fop/layoutmgr/FootnoteBodyLayoutManager.java +++ b/src/java/org/apache/fop/layoutmgr/FootnoteBodyLayoutManager.java @@ -37,7 +37,7 @@ public class FootnoteBodyLayoutManager extends BlockStackingLayoutManager { super(body); } - /** @see org.apache.fop.layoutmgr.LayoutManager */ + /** {@inheritDoc} */ public void addAreas(PositionIterator parentIter, LayoutContext layoutContext) { LayoutManager childLM = null; LayoutManager lastLM = null; @@ -80,7 +80,7 @@ public class FootnoteBodyLayoutManager extends BlockStackingLayoutManager { } } - /** @see org.apache.fop.layoutmgr.LayoutManager#addChildArea(org.apache.fop.area.Area) */ + /** {@inheritDoc} */ public void addChildArea(Area childArea) { childArea.setAreaClass(Area.CLASS_FOOTNOTE); parentLM.addChildArea(childArea); diff --git a/src/java/org/apache/fop/layoutmgr/InlineKnuthSequence.java b/src/java/org/apache/fop/layoutmgr/InlineKnuthSequence.java index 839c3bd35..e9973c14f 100644 --- a/src/java/org/apache/fop/layoutmgr/InlineKnuthSequence.java +++ b/src/java/org/apache/fop/layoutmgr/InlineKnuthSequence.java @@ -58,14 +58,14 @@ public class InlineKnuthSequence extends KnuthSequence { } /* (non-Javadoc) - * @see org.apache.fop.layoutmgr.KnuthSequence#canAppendSequence(org.apache.fop.layoutmgr.KnuthSequence) + * {@inheritDoc} */ public boolean canAppendSequence(KnuthSequence sequence) { return sequence.isInlineSequence() && !isClosed; } /* (non-Javadoc) - * @see org.apache.fop.layoutmgr.KnuthSequence#appendSequence(org.apache.fop.layoutmgr.KnuthSequence) + * {@inheritDoc} */ public boolean appendSequence(KnuthSequence sequence) { if (!canAppendSequence(sequence)) { @@ -84,7 +84,7 @@ public class InlineKnuthSequence extends KnuthSequence { } /* (non-Javadoc) - * @see KnuthSequence#appendSequence(KnuthSequence, boolean, BreakElement) + * {@inheritDoc} */ public boolean appendSequence(KnuthSequence sequence, boolean keepTogether, BreakElement breakElement) { @@ -93,7 +93,7 @@ public class InlineKnuthSequence extends KnuthSequence { /* (non-Javadoc) - * @see org.apache.fop.layoutmgr.KnuthSequence#endSequence() + * {@inheritDoc} */ public KnuthSequence endSequence() { if (!isClosed) { diff --git a/src/java/org/apache/fop/layoutmgr/KnuthBox.java b/src/java/org/apache/fop/layoutmgr/KnuthBox.java index 7d3cf33d1..a465ca8da 100644 --- a/src/java/org/apache/fop/layoutmgr/KnuthBox.java +++ b/src/java/org/apache/fop/layoutmgr/KnuthBox.java @@ -45,12 +45,12 @@ public class KnuthBox extends KnuthElement { super(w, pos, bAux); } - /** @see org.apache.fop.layoutmgr.KnuthElement#isBox() */ + /** {@inheritDoc} */ public boolean isBox() { return true; } - /** @see java.lang.Object#toString() */ + /** {@inheritDoc} */ public String toString() { StringBuffer sb = new StringBuffer(64); if (isAuxiliary()) { diff --git a/src/java/org/apache/fop/layoutmgr/KnuthElement.java b/src/java/org/apache/fop/layoutmgr/KnuthElement.java index 5d26716ea..71f3b3ce9 100644 --- a/src/java/org/apache/fop/layoutmgr/KnuthElement.java +++ b/src/java/org/apache/fop/layoutmgr/KnuthElement.java @@ -74,7 +74,7 @@ public abstract class KnuthElement extends ListElement { throw new RuntimeException("Element is not a glue"); } - /** @see org.apache.fop.layoutmgr.ListElement#isUnresolvedElement() */ + /** {@inheritDoc} */ public boolean isUnresolvedElement() { return false; } diff --git a/src/java/org/apache/fop/layoutmgr/KnuthGlue.java b/src/java/org/apache/fop/layoutmgr/KnuthGlue.java index cfec08fca..0b6706c4b 100644 --- a/src/java/org/apache/fop/layoutmgr/KnuthGlue.java +++ b/src/java/org/apache/fop/layoutmgr/KnuthGlue.java @@ -74,7 +74,7 @@ public class KnuthGlue extends KnuthElement { adjustmentClass = iAdjClass; } - /** @see org.apache.fop.layoutmgr.KnuthElement#isGlue() */ + /** {@inheritDoc} */ public boolean isGlue() { return true; } @@ -94,7 +94,7 @@ public class KnuthGlue extends KnuthElement { return adjustmentClass; } - /** @see java.lang.Object#toString() */ + /** {@inheritDoc} */ public String toString() { StringBuffer sb = new StringBuffer(64); if (isAuxiliary()) { diff --git a/src/java/org/apache/fop/layoutmgr/KnuthPenalty.java b/src/java/org/apache/fop/layoutmgr/KnuthPenalty.java index 771316bd1..3c7dace5f 100644 --- a/src/java/org/apache/fop/layoutmgr/KnuthPenalty.java +++ b/src/java/org/apache/fop/layoutmgr/KnuthPenalty.java @@ -81,7 +81,7 @@ public class KnuthPenalty extends KnuthElement { breakClass = iBreakClass; } - /** @see org.apache.fop.layoutmgr.KnuthElement#isPenalty() */ + /** {@inheritDoc} */ public boolean isPenalty() { return true; } @@ -106,7 +106,7 @@ public class KnuthPenalty extends KnuthElement { return bFlagged; } - /** @see org.apache.fop.layoutmgr.KnuthElement#isForcedBreak() */ + /** {@inheritDoc} */ public boolean isForcedBreak() { return penalty == -KnuthElement.INFINITE; } @@ -127,7 +127,7 @@ public class KnuthPenalty extends KnuthElement { this.breakClass = cl; } - /** @see java.lang.Object#toString() */ + /** {@inheritDoc} */ public String toString() { StringBuffer sb = new StringBuffer(64); if (isAuxiliary()) { diff --git a/src/java/org/apache/fop/layoutmgr/KnuthPossPosIter.java b/src/java/org/apache/fop/layoutmgr/KnuthPossPosIter.java index 9553959b0..3f334f4be 100644 --- a/src/java/org/apache/fop/layoutmgr/KnuthPossPosIter.java +++ b/src/java/org/apache/fop/layoutmgr/KnuthPossPosIter.java @@ -47,7 +47,7 @@ public class KnuthPossPosIter extends PositionIterator { // Check position < endPos /** - * @see org.apache.fop.layoutmgr.PositionIterator#checkNext() + * {@inheritDoc} */ protected boolean checkNext() { if (iterCount > 0) { @@ -59,7 +59,7 @@ public class KnuthPossPosIter extends PositionIterator { } /** - * @see java.util.Iterator#next() + * {@inheritDoc} */ public Object next() { --iterCount; diff --git a/src/java/org/apache/fop/layoutmgr/LayoutContext.java b/src/java/org/apache/fop/layoutmgr/LayoutContext.java index 5bac30f0b..11514b756 100644 --- a/src/java/org/apache/fop/layoutmgr/LayoutContext.java +++ b/src/java/org/apache/fop/layoutmgr/LayoutContext.java @@ -471,7 +471,7 @@ public class LayoutContext { this.spaceAfter = spaceAfter; } - /** @see java.lang.Object#toString() */ + /** {@inheritDoc} */ public String toString() { return "Layout Context:" + "\nStack Limit: \t" + (getStackLimit() == null ? "null" : getStackLimit().toString()) + diff --git a/src/java/org/apache/fop/layoutmgr/LayoutManagerMapping.java b/src/java/org/apache/fop/layoutmgr/LayoutManagerMapping.java index de779b011..ce323de84 100644 --- a/src/java/org/apache/fop/layoutmgr/LayoutManagerMapping.java +++ b/src/java/org/apache/fop/layoutmgr/LayoutManagerMapping.java @@ -86,8 +86,6 @@ import org.apache.fop.layoutmgr.list.ListItemLayoutManager; import org.apache.fop.layoutmgr.table.TableLayoutManager; import org.apache.fop.util.CharUtilities; -import org.apache.fop.fo.extensions.destination.Destination; - /** * The default LayoutManager maker class */ @@ -144,7 +142,7 @@ public class LayoutManagerMapping implements LayoutManagerMaker { } /** - * @see org.apache.fop.layoutmgr.LayoutManagerMaker#makeLayoutManagers(FONode, List) + * {@inheritDoc} */ public void makeLayoutManagers(FONode node, List lms) { Maker maker = (Maker) makers.get(node.getClass()); @@ -162,7 +160,7 @@ public class LayoutManagerMapping implements LayoutManagerMaker { } /** - * @see org.apache.fop.layoutmgr.LayoutManagerMaker#makeLayoutManager(FONode) + * {@inheritDoc} */ public LayoutManager makeLayoutManager(FONode node) { List lms = new ArrayList(); @@ -185,7 +183,7 @@ public class LayoutManagerMapping implements LayoutManagerMaker { } /* - * @see org.apache.fop.layoutmgr.LayoutManagerMaker#makeFlowLayoutManager(PageSequenceLayoutManager, Flow) + * {@inheritDoc} */ public FlowLayoutManager makeFlowLayoutManager( PageSequenceLayoutManager pslm, Flow flow) { @@ -193,7 +191,7 @@ public class LayoutManagerMapping implements LayoutManagerMaker { } /* - * @see org.apache.fop.layoutmgr.LayoutManagerMaker#makeContentLayoutManager(PageSequenceLayoutManager, Title) + * {@inheritDoc} */ public ContentLayoutManager makeContentLayoutManager(PageSequenceLayoutManager pslm, Title title) { @@ -201,7 +199,7 @@ public class LayoutManagerMapping implements LayoutManagerMaker { } /* - * @see org.apache.fop.layoutmgr.LayoutManagerMaker#makeStaticContentLayoutManager(PageSequenceLayoutManager, StaticContent, Region) + * {@inheritDoc} */ public StaticContentLayoutManager makeStaticContentLayoutManager( PageSequenceLayoutManager pslm, StaticContent sc, SideRegion reg) { @@ -209,7 +207,7 @@ public class LayoutManagerMapping implements LayoutManagerMaker { } /* - * @see org.apache.fop.layoutmgr.LayoutManagerMaker#makeStaticContentLayoutManager(PageSequenceLayoutManager, StaticContent, Block) + * {@inheritDoc} */ public StaticContentLayoutManager makeStaticContentLayoutManager( PageSequenceLayoutManager pslm, StaticContent sc, org.apache.fop.area.Block block) { diff --git a/src/java/org/apache/fop/layoutmgr/LeafPosition.java b/src/java/org/apache/fop/layoutmgr/LeafPosition.java index 9e484b701..c43bb05c0 100644 --- a/src/java/org/apache/fop/layoutmgr/LeafPosition.java +++ b/src/java/org/apache/fop/layoutmgr/LeafPosition.java @@ -36,7 +36,7 @@ public class LeafPosition extends Position { return getLM() != null; } - /** @see java.lang.Object#toString()*/ + /** {@inheritDoc} */ public String toString() { StringBuffer sb = new StringBuffer(); sb.append("LeafPos:").append(getIndex()).append("("); diff --git a/src/java/org/apache/fop/layoutmgr/NonLeafPosition.java b/src/java/org/apache/fop/layoutmgr/NonLeafPosition.java index 314f2c9f1..9edb425c1 100644 --- a/src/java/org/apache/fop/layoutmgr/NonLeafPosition.java +++ b/src/java/org/apache/fop/layoutmgr/NonLeafPosition.java @@ -36,7 +36,7 @@ public class NonLeafPosition extends Position { return (subPos != null ? subPos.generatesAreas() : false); } - /** @see java.lang.Object#toString() */ + /** {@inheritDoc} */ public String toString() { StringBuffer sb = new StringBuffer(); sb.append("NonLeafPos:").append(getIndex()).append("("); diff --git a/src/java/org/apache/fop/layoutmgr/PaddingElement.java b/src/java/org/apache/fop/layoutmgr/PaddingElement.java index 61c2abb29..ee0edcc38 100644 --- a/src/java/org/apache/fop/layoutmgr/PaddingElement.java +++ b/src/java/org/apache/fop/layoutmgr/PaddingElement.java @@ -43,7 +43,7 @@ public class PaddingElement extends BorderOrPaddingElement { super(position, condLength, side, isFirst, isLast, context); } - /** @see org.apache.fop.layoutmgr.UnresolvedListElementWithLength */ + /** {@inheritDoc} */ public void notifyLayoutManager(MinOptMax effectiveLength) { LayoutManager lm = getOriginatingLayoutManager(); if (lm instanceof ConditionalElementListener) { @@ -55,7 +55,7 @@ public class PaddingElement extends BorderOrPaddingElement { } } - /** @see java.lang.Object#toString() */ + /** {@inheritDoc} */ public String toString() { StringBuffer sb = new StringBuffer("Padding["); sb.append(super.toString()); diff --git a/src/java/org/apache/fop/layoutmgr/PageBreaker.java b/src/java/org/apache/fop/layoutmgr/PageBreaker.java index ff3dfef31..cfc4b55bf 100644 --- a/src/java/org/apache/fop/layoutmgr/PageBreaker.java +++ b/src/java/org/apache/fop/layoutmgr/PageBreaker.java @@ -63,24 +63,24 @@ public class PageBreaker extends AbstractBreaker { pslm, pslm.getPageSequence().getMainFlow()); } - /** @see org.apache.fop.layoutmgr.AbstractBreaker */ + /** {@inheritDoc} */ protected void updateLayoutContext(LayoutContext context) { int flowIPD = pslm.getCurrentPV().getCurrentSpan().getColumnWidth(); context.setRefIPD(flowIPD); } - /** @see org.apache.fop.layoutmgr.AbstractBreaker#getTopLevelLM() */ + /** {@inheritDoc} */ protected LayoutManager getTopLevelLM() { return pslm; } - /** @see org.apache.fop.layoutmgr.AbstractBreaker#getPageProvider() */ + /** {@inheritDoc} */ protected PageProvider getPageProvider() { return pslm.getPageProvider(); } /** - * @see org.apache.fop.layoutmgr.AbstractBreaker#getLayoutListener() + * {@inheritDoc} */ protected PageBreakingLayoutListener getLayoutListener() { return new PageBreakingLayoutListener() { @@ -105,7 +105,7 @@ public class PageBreaker extends AbstractBreaker { }; } - /** @see org.apache.fop.layoutmgr.AbstractBreaker */ + /** {@inheritDoc} */ protected int handleSpanChange(LayoutContext childLC, int nextSequenceStartsOn) { needColumnBalancing = false; if (childLC.getNextSpan() != Constants.NOT_SET) { @@ -120,7 +120,7 @@ public class PageBreaker extends AbstractBreaker { return nextSequenceStartsOn; } - /** @see org.apache.fop.layoutmgr.AbstractBreaker */ + /** {@inheritDoc} */ protected int getNextBlockList(LayoutContext childLC, int nextSequenceStartsOn) { if (!firstPart) { @@ -137,7 +137,7 @@ public class PageBreaker extends AbstractBreaker { return super.getNextBlockList(childLC, nextSequenceStartsOn); } - /** @see org.apache.fop.layoutmgr.AbstractBreaker */ + /** {@inheritDoc} */ protected LinkedList getNextKnuthElements(LayoutContext context, int alignment) { LinkedList contentList = null; @@ -406,7 +406,7 @@ public class PageBreaker extends AbstractBreaker { firstPart = false; } - /** @see org.apache.fop.layoutmgr.AbstractBreaker#handleEmptyContent() */ + /** {@inheritDoc} */ protected void handleEmptyContent() { pslm.getCurrentPV().getPage().fakeNonEmpty(); } @@ -449,7 +449,7 @@ public class PageBreaker extends AbstractBreaker { return childFLM; } - /** @see org.apache.fop.layoutmgr.AbstractBreaker#observeElementList(java.util.List) */ + /** {@inheritDoc} */ protected void observeElementList(List elementList) { ElementListObserver.observe(elementList, "breaker", ((PageSequence)pslm.getFObj()).getId()); diff --git a/src/java/org/apache/fop/layoutmgr/PageBreakingAlgorithm.java b/src/java/org/apache/fop/layoutmgr/PageBreakingAlgorithm.java index 2c2e96986..a9ef9fd13 100644 --- a/src/java/org/apache/fop/layoutmgr/PageBreakingAlgorithm.java +++ b/src/java/org/apache/fop/layoutmgr/PageBreakingAlgorithm.java @@ -844,7 +844,7 @@ class PageBreakingAlgorithm extends BreakingAlgorithm { return topLevelLM.getFObj(); } - /** @see org.apache.fop.layoutmgr.BreakingAlgorithm#getLineWidth(int) */ + /** {@inheritDoc} */ protected int getLineWidth(int line) { int bpd; if (pageProvider != null) { diff --git a/src/java/org/apache/fop/layoutmgr/PageProvider.java b/src/java/org/apache/fop/layoutmgr/PageProvider.java index 94da60173..0360e2942 100644 --- a/src/java/org/apache/fop/layoutmgr/PageProvider.java +++ b/src/java/org/apache/fop/layoutmgr/PageProvider.java @@ -195,9 +195,9 @@ public class PageProvider implements Constants { /** * - * @param isBlank - * @param index - * @return + * @param isBlank true if the Page should be a blank one + * @param index the Page's index + * @return a Page instance */ protected Page getPage(boolean isBlank, int index) { boolean isLastPage = (lastPageIndex >= 0) && (index == lastPageIndex); diff --git a/src/java/org/apache/fop/layoutmgr/PageSequenceLayoutManager.java b/src/java/org/apache/fop/layoutmgr/PageSequenceLayoutManager.java index a34ce7956..abf1644c9 100644 --- a/src/java/org/apache/fop/layoutmgr/PageSequenceLayoutManager.java +++ b/src/java/org/apache/fop/layoutmgr/PageSequenceLayoutManager.java @@ -91,8 +91,7 @@ public class PageSequenceLayoutManager extends AbstractLayoutManager { } /** - * @see org.apache.fop.layoutmgr.LayoutManager - * @return the LayoutManagerMaker object + * @return the LayoutManagerMaker object associated to the areaTreeHandler */ public LayoutManagerMaker getLayoutManagerMaker() { return areaTreeHandler.getLayoutManagerMaker(); diff --git a/src/java/org/apache/fop/layoutmgr/Position.java b/src/java/org/apache/fop/layoutmgr/Position.java index 4a7a607f0..197970403 100644 --- a/src/java/org/apache/fop/layoutmgr/Position.java +++ b/src/java/org/apache/fop/layoutmgr/Position.java @@ -76,7 +76,7 @@ public class Position { } } - /** @see java.lang.Object#toString() */ + /** {@inheritDoc} */ public String toString() { StringBuffer sb = new StringBuffer(); sb.append("Position:").append(getIndex()).append("("); diff --git a/src/java/org/apache/fop/layoutmgr/RelSide.java b/src/java/org/apache/fop/layoutmgr/RelSide.java index 44abb9dd2..26650e0b1 100644 --- a/src/java/org/apache/fop/layoutmgr/RelSide.java +++ b/src/java/org/apache/fop/layoutmgr/RelSide.java @@ -46,7 +46,7 @@ public final class RelSide { return this.name; } - /** @see java.lang.Object#toString() */ + /** {@inheritDoc} */ public String toString() { return "RelSide:" + name; } diff --git a/src/java/org/apache/fop/layoutmgr/SpaceElement.java b/src/java/org/apache/fop/layoutmgr/SpaceElement.java index 5c18835b4..558621529 100644 --- a/src/java/org/apache/fop/layoutmgr/SpaceElement.java +++ b/src/java/org/apache/fop/layoutmgr/SpaceElement.java @@ -65,7 +65,7 @@ public class SpaceElement extends UnresolvedListElementWithLength { return this.precedence; } - /** @see org.apache.fop.layoutmgr.UnresolvedListElementWithLength */ + /** {@inheritDoc} */ public void notifyLayoutManager(MinOptMax effectiveLength) { LayoutManager lm = getOriginatingLayoutManager(); if (lm instanceof ConditionalElementListener) { @@ -77,7 +77,7 @@ public class SpaceElement extends UnresolvedListElementWithLength { } } - /** @see java.lang.Object#toString() */ + /** {@inheritDoc} */ public String toString() { StringBuffer sb = new StringBuffer("Space["); sb.append(super.toString()); diff --git a/src/java/org/apache/fop/layoutmgr/SpaceResolver.java b/src/java/org/apache/fop/layoutmgr/SpaceResolver.java index 0175835e1..abfc99b72 100644 --- a/src/java/org/apache/fop/layoutmgr/SpaceResolver.java +++ b/src/java/org/apache/fop/layoutmgr/SpaceResolver.java @@ -544,7 +544,7 @@ public class SpaceResolver { } } - /** @see java.lang.Object#toString() */ + /** {@inheritDoc} */ public String toString() { StringBuffer sb = new StringBuffer(); sb.append("SpaceHandlingBreakPosition("); @@ -597,7 +597,7 @@ public class SpaceResolver { } } - /** @see java.lang.Object#toString() */ + /** {@inheritDoc} */ public String toString() { StringBuffer sb = new StringBuffer(); sb.append("SpaceHandlingPosition"); diff --git a/src/java/org/apache/fop/layoutmgr/SpaceSpecifier.java b/src/java/org/apache/fop/layoutmgr/SpaceSpecifier.java index 8dd004333..c6c47fd35 100644 --- a/src/java/org/apache/fop/layoutmgr/SpaceSpecifier.java +++ b/src/java/org/apache/fop/layoutmgr/SpaceSpecifier.java @@ -46,7 +46,7 @@ public class SpaceSpecifier implements Cloneable { } /** - * @see java.lang.Object#clone() + * {@inheritDoc} */ public Object clone() { try { diff --git a/src/java/org/apache/fop/layoutmgr/StaticContentLayoutManager.java b/src/java/org/apache/fop/layoutmgr/StaticContentLayoutManager.java index 00bba8ae2..92437a452 100644 --- a/src/java/org/apache/fop/layoutmgr/StaticContentLayoutManager.java +++ b/src/java/org/apache/fop/layoutmgr/StaticContentLayoutManager.java @@ -83,7 +83,7 @@ public class StaticContentLayoutManager extends BlockStackingLayoutManager { targetBlock = block; } - /** @see org.apache.fop.layoutmgr.LayoutManager */ + /** {@inheritDoc} */ public LinkedList getNextKnuthElements(LayoutContext context, int alignment) { if (true) { throw new UnsupportedOperationException( @@ -176,7 +176,7 @@ public class StaticContentLayoutManager extends BlockStackingLayoutManager { } /** - * @see org.apache.fop.layoutmgr.LayoutManager#addAreas(PositionIterator, LayoutContext) + * {@inheritDoc} */ public void addAreas(PositionIterator parentIter, LayoutContext layoutContext) { AreaAdditionUtil.addAreas(this, parentIter, layoutContext); @@ -190,7 +190,7 @@ public class StaticContentLayoutManager extends BlockStackingLayoutManager { * Add child area to a the correct container, depending on its * area class. A Flow can fill at most one area container of any class * at any one time. The actual work is done by BlockStackingLM. - * @see org.apache.fop.layoutmgr.LayoutManager#addChildArea(Area) + * {@inheritDoc} */ public void addChildArea(Area childArea) { if (getStaticContentFO().getFlowName().equals("xsl-footnote-separator")) { @@ -201,7 +201,7 @@ public class StaticContentLayoutManager extends BlockStackingLayoutManager { } /** - * @see org.apache.fop.layoutmgr.LayoutManager#getParentArea(Area) + * {@inheritDoc} */ public Area getParentArea(Area childArea) { if (getStaticContentFO().getFlowName().equals("xsl-footnote-separator")) { @@ -270,7 +270,7 @@ public class StaticContentLayoutManager extends BlockStackingLayoutManager { this.displayAlign = displayAlign; } - /** @see org.apache.fop.layoutmgr.AbstractBreaker#observeElementList(java.util.List) */ + /** {@inheritDoc} */ protected void observeElementList(List elementList) { String elementListID = getStaticContentFO().getFlowName(); String pageSequenceID = ((PageSequence)lm.getParent().getFObj()).getId(); @@ -280,7 +280,7 @@ public class StaticContentLayoutManager extends BlockStackingLayoutManager { ElementListObserver.observe(elementList, "static-content", elementListID); } - /** @see org.apache.fop.layoutmgr.AbstractBreaker#isPartOverflowRecoveryActivated() */ + /** {@inheritDoc} */ protected boolean isPartOverflowRecoveryActivated() { //For side regions, this must be disabled because of wanted overflow. return false; @@ -363,7 +363,7 @@ public class StaticContentLayoutManager extends BlockStackingLayoutManager { return contentAreaIPD; } - /** @see org.apache.fop.layoutmgr.BlockStackingLayoutManager#setContentAreaIPD(int) */ + /** {@inheritDoc} */ protected void setContentAreaIPD(int contentAreaIPD) { this.contentAreaIPD = contentAreaIPD; } diff --git a/src/java/org/apache/fop/layoutmgr/UnresolvedListElementWithLength.java b/src/java/org/apache/fop/layoutmgr/UnresolvedListElementWithLength.java index 1c7b6b53b..f3c613202 100644 --- a/src/java/org/apache/fop/layoutmgr/UnresolvedListElementWithLength.java +++ b/src/java/org/apache/fop/layoutmgr/UnresolvedListElementWithLength.java @@ -58,7 +58,7 @@ public abstract class UnresolvedListElementWithLength extends UnresolvedListElem this.isLast = isLast; } - /** @see org.apache.fop.layoutmgr.UnresolvedListElement#isConditional() */ + /** {@inheritDoc} */ public boolean isConditional() { return this.conditional; } @@ -91,7 +91,7 @@ public abstract class UnresolvedListElementWithLength extends UnresolvedListElem */ public abstract void notifyLayoutManager(MinOptMax effectiveLength); - /** @see java.lang.Object#toString() */ + /** {@inheritDoc} */ public String toString() { StringBuffer sb = new StringBuffer(); sb.append(getSide().getName()).append(", "); diff --git a/src/java/org/apache/fop/layoutmgr/inline/AbstractGraphicsLayoutManager.java b/src/java/org/apache/fop/layoutmgr/inline/AbstractGraphicsLayoutManager.java index 5397d470d..ca82d3da7 100644 --- a/src/java/org/apache/fop/layoutmgr/inline/AbstractGraphicsLayoutManager.java +++ b/src/java/org/apache/fop/layoutmgr/inline/AbstractGraphicsLayoutManager.java @@ -231,7 +231,7 @@ public abstract class AbstractGraphicsLayoutManager extends LeafNodeLayoutManage } /** - * @see org.apache.fop.layoutmgr.LayoutManager#getNextKnuthElements(LayoutContext, int) + * {@inheritDoc} */ public LinkedList getNextKnuthElements(LayoutContext context, int alignment) { @@ -241,7 +241,7 @@ public abstract class AbstractGraphicsLayoutManager extends LeafNodeLayoutManage } /** - * @see LeafNodeLayoutManager#makeAlignmentContext(LayoutContext) + * {@inheritDoc} */ protected AlignmentContext makeAlignmentContext(LayoutContext context) { return new AlignmentContext( @@ -255,7 +255,7 @@ public abstract class AbstractGraphicsLayoutManager extends LeafNodeLayoutManage } /** - * @see org.apache.fop.layoutmgr.inline.LeafNodeLayoutManager#addId() + * {@inheritDoc} */ protected void addId() { getPSLM().addIDToPage(fobj.getId()); @@ -271,7 +271,7 @@ public abstract class AbstractGraphicsLayoutManager extends LeafNodeLayoutManage // --------- Property Resolution related functions --------- // /** - * @see org.apache.fop.datatypes.PercentBaseContext#getBaseLength(int, FObj) + * {@inheritDoc} */ public int getBaseLength(int lengthBase, FObj fobj) { switch (lengthBase) { diff --git a/src/java/org/apache/fop/layoutmgr/inline/AlignmentContext.java b/src/java/org/apache/fop/layoutmgr/inline/AlignmentContext.java index ac1e12a2e..14172a479 100644 --- a/src/java/org/apache/fop/layoutmgr/inline/AlignmentContext.java +++ b/src/java/org/apache/fop/layoutmgr/inline/AlignmentContext.java @@ -511,7 +511,7 @@ public class AlignmentContext implements Constants { return (getWritingMode() == EN_LR_TB || getWritingMode() == EN_RL_TB); } - /** @see java.lang.Object#toString() */ + /** {@inheritDoc} */ public String toString() { StringBuffer sb = new StringBuffer(64); sb.append("ah=" + areaHeight); diff --git a/src/java/org/apache/fop/layoutmgr/inline/BasicLinkLayoutManager.java b/src/java/org/apache/fop/layoutmgr/inline/BasicLinkLayoutManager.java index e60e38870..e7339034c 100644 --- a/src/java/org/apache/fop/layoutmgr/inline/BasicLinkLayoutManager.java +++ b/src/java/org/apache/fop/layoutmgr/inline/BasicLinkLayoutManager.java @@ -43,7 +43,7 @@ public class BasicLinkLayoutManager extends InlineLayoutManager { fobj = node; } - /** @see org.apache.fop.layoutmgr.inline.InlineLayoutManager#createArea(boolean) */ + /** {@inheritDoc} */ protected InlineArea createArea(boolean bInlineParent) { InlineArea area = super.createArea(bInlineParent); setupBasicLinkArea(parentLM, area); diff --git a/src/java/org/apache/fop/layoutmgr/inline/BasicScaledBaselineTable.java b/src/java/org/apache/fop/layoutmgr/inline/BasicScaledBaselineTable.java index e8a59fca4..606500a56 100644 --- a/src/java/org/apache/fop/layoutmgr/inline/BasicScaledBaselineTable.java +++ b/src/java/org/apache/fop/layoutmgr/inline/BasicScaledBaselineTable.java @@ -173,7 +173,7 @@ public class BasicScaledBaselineTable implements ScaledBaselineTable, Constants } /** - * @see ScaledBaselineTable#setBeforeAndAfterBaselines(int, int) + * {@inheritDoc} */ public void setBeforeAndAfterBaselines(int beforeBaseline, int afterBaseline) { beforeEdgeOffset = beforeBaseline; @@ -181,7 +181,7 @@ public class BasicScaledBaselineTable implements ScaledBaselineTable, Constants } /** - * @see ScaledBaselineTable#deriveScaledBaselineTable(int) + * {@inheritDoc} */ public ScaledBaselineTable deriveScaledBaselineTable(int baselineIdentifier) { BasicScaledBaselineTable bac diff --git a/src/java/org/apache/fop/layoutmgr/inline/CharacterLayoutManager.java b/src/java/org/apache/fop/layoutmgr/inline/CharacterLayoutManager.java index 3d1291480..25e196398 100644 --- a/src/java/org/apache/fop/layoutmgr/inline/CharacterLayoutManager.java +++ b/src/java/org/apache/fop/layoutmgr/inline/CharacterLayoutManager.java @@ -61,7 +61,7 @@ public class CharacterLayoutManager extends LeafNodeLayoutManager { fobj = node; } - /** @see org.apache.fop.layoutmgr.LayoutManager#initialize */ + /** {@inheritDoc} */ public void initialize() { font = fobj.getCommonFont().getFontState(fobj.getFOEventHandler().getFontInfo(), this); SpaceVal ls = SpaceVal.makeLetterSpacing(fobj.getLetterSpacing()); @@ -91,7 +91,7 @@ public class CharacterLayoutManager extends LeafNodeLayoutManager { return text; } - /** @see org.apache.fop.layoutmgr.LayoutManager#getNextKnuthElements(LayoutContext, int) */ + /** {@inheritDoc} */ public LinkedList getNextKnuthElements(LayoutContext context, int alignment) { MinOptMax ipd; curArea = get(context); @@ -152,13 +152,13 @@ public class CharacterLayoutManager extends LeafNodeLayoutManager { return returnList; } - /** @see InlineLevelLayoutManager#getWordChars(StringBuffer, Position) */ + /** {@inheritDoc} */ public void getWordChars(StringBuffer sbChars, Position bp) { sbChars.append (((org.apache.fop.area.inline.TextArea) curArea).getText()); } - /** @see InlineLevelLayoutManager#hyphenate(Position, HyphContext) */ + /** {@inheritDoc} */ public void hyphenate(Position pos, HyphContext hc) { if (hc.getNextHyphPoint() == 1) { // the character ends a syllable @@ -172,7 +172,7 @@ public class CharacterLayoutManager extends LeafNodeLayoutManager { hc.updateOffset(1); } - /** @see InlineLevelLayoutManager#applyChanges(List) */ + /** {@inheritDoc} */ public boolean applyChanges(List oldList) { setFinished(false); if (isSomethingChanged) { @@ -185,7 +185,7 @@ public class CharacterLayoutManager extends LeafNodeLayoutManager { } } - /** @see org.apache.fop.layoutmgr.LayoutManager#getChangedKnuthElements(List, int) */ + /** {@inheritDoc} */ public LinkedList getChangedKnuthElements(List oldList, int alignment) { if (isFinished()) { return null; @@ -235,7 +235,7 @@ public class CharacterLayoutManager extends LeafNodeLayoutManager { return returnList; } - /** @see LeafNodeLayoutManager#addId */ + /** {@inheritDoc} */ protected void addId() { getPSLM().addIDToPage(fobj.getId()); } diff --git a/src/java/org/apache/fop/layoutmgr/inline/ContentLayoutManager.java b/src/java/org/apache/fop/layoutmgr/inline/ContentLayoutManager.java index 22796c8bc..0ec5dc180 100644 --- a/src/java/org/apache/fop/layoutmgr/inline/ContentLayoutManager.java +++ b/src/java/org/apache/fop/layoutmgr/inline/ContentLayoutManager.java @@ -174,60 +174,60 @@ public class ContentLayoutManager extends AbstractBaseLayoutManager return stackSize; } - /** @see org.apache.fop.layoutmgr.LayoutManager */ + /** {@inheritDoc} */ public Area getParentArea(Area childArea) { return holder; } /** - * @see org.apache.fop.layoutmgr.LayoutManager#addChildArea(Area) + * {@inheritDoc} **/ public void addChildArea(Area childArea) { holder.addChildArea(childArea); } /** - * @see org.apache.fop.layoutmgr.LayoutManager#setParent(LayoutManager) + * {@inheritDoc} */ public void setParent(LayoutManager lm) { parentLM = lm; } - /** @see org.apache.fop.layoutmgr.LayoutManager#getParent() */ + /** {@inheritDoc} */ public LayoutManager getParent() { return this.parentLM; } /** - * @see org.apache.fop.layoutmgr.LayoutManager#isFinished() + * {@inheritDoc} */ public boolean isFinished() { return false; } /** - * @see org.apache.fop.layoutmgr.LayoutManager#setFinished(boolean) + * {@inheritDoc} */ public void setFinished(boolean isFinished) { //to be done } /** - * @see org.apache.fop.layoutmgr.LayoutManager#resetPosition(Position) + * {@inheritDoc} */ public void resetPosition(Position position) { //to be done } /** - * @see org.apache.fop.layoutmgr.LayoutManager#createNextChildLMs(int) + * {@inheritDoc} */ public boolean createNextChildLMs(int pos) { return false; } /** - * @see org.apache.fop.layoutmgr.LayoutManager#getChildLMs() + * {@inheritDoc} */ public List getChildLMs() { List childLMs = new ArrayList(1); @@ -236,7 +236,7 @@ public class ContentLayoutManager extends AbstractBaseLayoutManager } /** - * @see org.apache.fop.layoutmgr.LayoutManager#addChildLM + * {@inheritDoc} */ public void addChildLM(LayoutManager lm) { if (lm == null) { @@ -249,7 +249,7 @@ public class ContentLayoutManager extends AbstractBaseLayoutManager } /** - * @see org.apache.fop.layoutmgr.LayoutManager#addChildLMs + * {@inheritDoc} */ public void addChildLMs(List newLMs) { if (newLMs == null || newLMs.size() == 0) { @@ -349,28 +349,28 @@ public class ContentLayoutManager extends AbstractBaseLayoutManager } /** - * @see org.apache.fop.layoutmgr.LayoutManager#getGeneratesReferenceArea + * {@inheritDoc} */ public boolean getGeneratesReferenceArea() { return false; } /** - * @see org.apache.fop.layoutmgr.LayoutManager#getGeneratesBlockArea + * {@inheritDoc} */ public boolean getGeneratesBlockArea() { return getGeneratesLineArea() || holder instanceof Block; } /** - * @see org.apache.fop.layoutmgr.LayoutManager#getGeneratesLineArea + * {@inheritDoc} */ public boolean getGeneratesLineArea() { return holder instanceof LineArea; } /* (non-Javadoc) - * @see org.apache.fop.layoutmgr.LayoutManager#notifyPos(org.apache.fop.layoutmgr.Position) + * {@inheritDoc} */ public Position notifyPos(Position pos) { return pos; diff --git a/src/java/org/apache/fop/layoutmgr/inline/FootnoteLayoutManager.java b/src/java/org/apache/fop/layoutmgr/inline/FootnoteLayoutManager.java index 849ae08d8..adb0e5a73 100644 --- a/src/java/org/apache/fop/layoutmgr/inline/FootnoteLayoutManager.java +++ b/src/java/org/apache/fop/layoutmgr/inline/FootnoteLayoutManager.java @@ -61,7 +61,7 @@ public class FootnoteLayoutManager extends InlineStackingLayoutManager { footnote = node; } - /** @see org.apache.fop.layoutmgr.LayoutManager#initialize() */ + /** {@inheritDoc} */ public void initialize() { // create an InlineStackingLM handling the fo:inline child of fo:footnote citationLM = new InlineLayoutManager(footnote.getFootnoteCitation()); @@ -70,7 +70,7 @@ public class FootnoteLayoutManager extends InlineStackingLayoutManager { bodyLM = new FootnoteBodyLayoutManager(footnote.getFootnoteBody()); } - /** @see org.apache.fop.layoutmgr.LayoutManager */ + /** {@inheritDoc} */ public LinkedList getNextKnuthElements(LayoutContext context, int alignment) { // for the moment, this LM is set as the citationLM's parent @@ -120,7 +120,7 @@ public class FootnoteLayoutManager extends InlineStackingLayoutManager { } /** - * @see org.apache.fop.layoutmgr.LayoutManager#getChangedKnuthElements(java.util.List, int) + * {@inheritDoc} */ public LinkedList getChangedKnuthElements(List oldList, int alignment) { @@ -131,7 +131,7 @@ public class FootnoteLayoutManager extends InlineStackingLayoutManager { /** - * @see org.apache.fop.layoutmgr.LayoutManager#addAreas(PositionIterator posIter, LayoutContext context); + * {@inheritDoc} */ public void addAreas(PositionIterator posIter, LayoutContext context) { // "Unwrap" the NonLeafPositions stored in posIter and put diff --git a/src/java/org/apache/fop/layoutmgr/inline/InlineLayoutManager.java b/src/java/org/apache/fop/layoutmgr/inline/InlineLayoutManager.java index ea6d1ceff..30402a5f2 100755 --- a/src/java/org/apache/fop/layoutmgr/inline/InlineLayoutManager.java +++ b/src/java/org/apache/fop/layoutmgr/inline/InlineLayoutManager.java @@ -30,6 +30,7 @@ import org.apache.fop.area.inline.InlineArea; import org.apache.fop.area.inline.InlineBlockParent; import org.apache.fop.area.inline.InlineParent; import org.apache.fop.datatypes.Length; +import org.apache.fop.fo.Constants; import org.apache.fop.fo.flow.Inline; import org.apache.fop.fo.flow.InlineLevel; import org.apache.fop.fo.flow.Leader; @@ -106,7 +107,7 @@ public class InlineLayoutManager extends InlineStackingLayoutManager { return (Inline)fobj; } - /** @see LayoutManager#initialize */ + /** {@inheritDoc} */ public void initialize() { int padding = 0; font = fobj.getCommonFont().getFontState(fobj.getFOEventHandler().getFontInfo(), this); @@ -136,7 +137,7 @@ public class InlineLayoutManager extends InlineStackingLayoutManager { } - /** @see InlineStackingLayoutManager#getExtraIPD(boolean, boolean) */ + /** {@inheritDoc} */ protected MinOptMax getExtraIPD(boolean isNotFirst, boolean isNotLast) { int borderAndPadding = 0; if (borderProps != null) { @@ -153,7 +154,7 @@ public class InlineLayoutManager extends InlineStackingLayoutManager { } - /** @see InlineStackingLayoutManager#hasLeadingFence(boolean) */ + /** {@inheritDoc} */ protected boolean hasLeadingFence(boolean isNotFirst) { return borderProps != null && (borderProps.getPadding(CommonBorderPaddingBackground.START, isNotFirst, this) > 0 @@ -161,7 +162,7 @@ public class InlineLayoutManager extends InlineStackingLayoutManager { ); } - /** @see InlineStackingLayoutManager#hasTrailingFence(boolean) */ + /** {@inheritDoc} */ protected boolean hasTrailingFence(boolean isNotLast) { return borderProps != null && (borderProps.getPadding(CommonBorderPaddingBackground.END, isNotLast, this) > 0 @@ -169,16 +170,21 @@ public class InlineLayoutManager extends InlineStackingLayoutManager { ); } - /** @see InlineStackingLayoutManager#getSpaceStart */ + /** {@inheritDoc} */ protected SpaceProperty getSpaceStart() { return inlineProps != null ? inlineProps.spaceStart : null; } - /** @see InlineStackingLayoutManager#getSpaceEnd */ + /** {@inheritDoc} */ protected SpaceProperty getSpaceEnd() { return inlineProps != null ? inlineProps.spaceEnd : null; } - /** @see org.apache.fop.layoutmgr.inline.InlineLayoutManager#createArea(boolean) */ + /** + * Create and initialize an <code>InlineArea</code> + * + * @param hasInlineParent true if the parent is an inline + * @return the area + */ protected InlineArea createArea(boolean hasInlineParent) { InlineArea area; if (hasInlineParent) { @@ -193,9 +199,7 @@ public class InlineLayoutManager extends InlineStackingLayoutManager { return area; } - /** - * @see org.apache.fop.layoutmgr.inline.InlineStackingLayoutManager#setTraits(boolean, boolean) - */ + /** {@inheritDoc} */ protected void setTraits(boolean isNotFirst, boolean isNotLast) { if (borderProps != null) { // Add border and padding to current area and set flags (FIRST, LAST ...) @@ -208,7 +212,6 @@ public class InlineLayoutManager extends InlineStackingLayoutManager { /** * @return true if this element must be kept together */ - // TODO Use the keep-together property on Inline as well public boolean mustKeepTogether() { return mustKeepTogether(this.getParent()); } @@ -223,7 +226,7 @@ public class InlineLayoutManager extends InlineStackingLayoutManager { } } - /** @see org.apache.fop.layoutmgr.LayoutManager */ + /** {@inheritDoc} */ public LinkedList getNextKnuthElements(LayoutContext context, int alignment) { LayoutManager curLM; @@ -288,6 +291,7 @@ public class InlineLayoutManager extends InlineStackingLayoutManager { } while ((curLM = (LayoutManager) getChildLM()) != null) { + if (!(curLM instanceof InlineLevelLayoutManager)) { // A block LM // Leave room for start/end border and padding @@ -299,19 +303,19 @@ public class InlineLayoutManager extends InlineStackingLayoutManager { - borderProps.getBorderEndWidth(hasNextChildLM())); } } + // get KnuthElements from curLM returnedList = curLM.getNextKnuthElements(childLC, alignment); if (returnList.size() == 0 && childLC.isKeepWithPreviousPending()) { childLC.setFlags(LayoutContext.KEEP_WITH_PREVIOUS_PENDING, false); } - if (returnedList == null) { - // curLM returned null because it finished; + if (returnedList == null + || returnedList.size() == 0) { + // curLM returned null or an empty list, because it finished; // just iterate once more to see if there is another child continue; } - if (returnedList.size() == 0) { - continue; - } + if (curLM instanceof InlineLevelLayoutManager) { context.setFlags(LayoutContext.KEEP_WITH_NEXT_PENDING, false); // "wrap" the Position stored in each element of returnedList @@ -483,7 +487,7 @@ public class InlineLayoutManager extends InlineStackingLayoutManager { areaCreated = true; } - /** @see LayoutManager#addChildArea(Area) */ + /** {@inheritDoc} */ public void addChildArea(Area childArea) { Area parent = getCurrentArea(); if (getContext().resolveLeadingSpace()) { @@ -494,7 +498,7 @@ public class InlineLayoutManager extends InlineStackingLayoutManager { parent.addChildArea(childArea); } - /** @see LayoutManager#getChangedKnuthElements(List, int) */ + /** {@inheritDoc} */ public LinkedList getChangedKnuthElements(List oldList, int alignment) { LinkedList returnedList = new LinkedList(); addKnuthElementsForBorderPaddingStart(returnedList); @@ -544,7 +548,7 @@ public class InlineLayoutManager extends InlineStackingLayoutManager { return this.auxiliaryPosition; } - /** @see org.apache.fop.layoutmgr.inline.LeafNodeLayoutManager#addId() */ + /** {@inheritDoc} */ protected void addId() { if (fobj instanceof Inline) { getPSLM().addIDToPage(getInlineFO().getId()); diff --git a/src/java/org/apache/fop/layoutmgr/inline/InlineStackingLayoutManager.java b/src/java/org/apache/fop/layoutmgr/inline/InlineStackingLayoutManager.java index de7b305fd..4cb48f6e7 100644 --- a/src/java/org/apache/fop/layoutmgr/inline/InlineStackingLayoutManager.java +++ b/src/java/org/apache/fop/layoutmgr/inline/InlineStackingLayoutManager.java @@ -281,7 +281,7 @@ public class InlineStackingLayoutManager extends AbstractLayoutManager } } - /** @see InlineLevelLayoutManager#addALetterSpaceTo(List) */ + /** {@inheritDoc} */ public List addALetterSpaceTo(List oldList) { // old list contains only a box, or the sequence: box penalty glue box @@ -331,21 +331,21 @@ public class InlineStackingLayoutManager extends AbstractLayoutManager } - /** @see InlineLevelLayoutManager#getWordChars(StringBuffer, Position) */ + /** {@inheritDoc} */ public void getWordChars(StringBuffer sbChars, Position pos) { Position newPos = ((NonLeafPosition) pos).getPosition(); ((InlineLevelLayoutManager) newPos.getLM()).getWordChars(sbChars, newPos); } - /** @see InlineLevelLayoutManager#hyphenate(Position, HyphContext) */ + /** {@inheritDoc} */ public void hyphenate(Position pos, HyphContext hc) { Position newPos = ((NonLeafPosition) pos).getPosition(); ((InlineLevelLayoutManager) newPos.getLM()).hyphenate(newPos, hc); } - /** @see InlineLevelLayoutManager#applyChanges(List) */ + /** {@inheritDoc} */ public boolean applyChanges(List oldList) { // "unwrap" the Positions stored in the elements ListIterator oldListIterator = oldList.listIterator(); @@ -411,7 +411,7 @@ public class InlineStackingLayoutManager extends AbstractLayoutManager } /** - * @see org.apache.fop.layoutmgr.LayoutManager#getChangedKnuthElements(List, int) + * {@inheritDoc} */ public LinkedList getChangedKnuthElements(List oldList, int alignment) { // "unwrap" the Positions stored in the elements diff --git a/src/java/org/apache/fop/layoutmgr/inline/KnuthInlineBox.java b/src/java/org/apache/fop/layoutmgr/inline/KnuthInlineBox.java index 3d20b4ce4..856fab051 100644 --- a/src/java/org/apache/fop/layoutmgr/inline/KnuthInlineBox.java +++ b/src/java/org/apache/fop/layoutmgr/inline/KnuthInlineBox.java @@ -71,7 +71,7 @@ public class KnuthInlineBox extends KnuthBox { } - /** @see java.lang.Object#toString() */ + /** {@inheritDoc} */ public String toString() { StringBuffer sb = new StringBuffer(super.toString()); return sb.toString(); diff --git a/src/java/org/apache/fop/layoutmgr/inline/LeaderLayoutManager.java b/src/java/org/apache/fop/layoutmgr/inline/LeaderLayoutManager.java index 9e64ea534..a7c5178b0 100644 --- a/src/java/org/apache/fop/layoutmgr/inline/LeaderLayoutManager.java +++ b/src/java/org/apache/fop/layoutmgr/inline/LeaderLayoutManager.java @@ -65,7 +65,7 @@ public class LeaderLayoutManager extends LeafNodeLayoutManager { fobj = node; } - /** @see org.apache.fop.layoutmgr.LayoutManager#initialize */ + /** {@inheritDoc} */ public void initialize() { font = fobj.getCommonFont().getFontState(fobj.getFOEventHandler().getFontInfo(), this); // the property leader-alignment does not affect vertical positioning @@ -193,7 +193,7 @@ public class LeaderLayoutManager extends LeafNodeLayoutManager { return leaderArea; } - /** @see LeafNodeLayoutManager#addAreas(PositionIterator, LayoutContext) */ + /** {@inheritDoc} */ public void addAreas(PositionIterator posIter, LayoutContext context) { if (fobj.getLeaderPattern() != EN_USECONTENT) { // use LeafNodeLayoutManager.addAreas() @@ -223,7 +223,7 @@ public class LeaderLayoutManager extends LeafNodeLayoutManager { } } - /** @see org.apache.fop.layoutmgr.LayoutManager#getNextKnuthElements(LayoutContext, int) */ + /** {@inheritDoc} */ public LinkedList getNextKnuthElements(LayoutContext context, int alignment) { MinOptMax ipd; @@ -286,19 +286,19 @@ public class LeaderLayoutManager extends LeafNodeLayoutManager { return returnList; } - /** @see InlineLevelLayoutManager#hyphenate(Position, HyphContext) */ + /** {@inheritDoc} */ public void hyphenate(Position pos, HyphContext hc) { // use the AbstractLayoutManager.hyphenate() null implementation super.hyphenate(pos, hc); } - /** @see InlineLevelLayoutManager#applyChanges(List) */ + /** {@inheritDoc} */ public boolean applyChanges(List oldList) { setFinished(false); return false; } - /** @see org.apache.fop.layoutmgr.LayoutManager#getChangedKnuthElements(List, int) */ + /** {@inheritDoc} */ public LinkedList getChangedKnuthElements(List oldList, int alignment) { if (isFinished()) { @@ -335,13 +335,13 @@ public class LeaderLayoutManager extends LeafNodeLayoutManager { return returnList; } - /** @see LeafNodeLayoutManager#addId */ + /** {@inheritDoc} */ protected void addId() { getPSLM().addIDToPage(fobj.getId()); } /** - * @see org.apache.fop.datatypes.PercentBaseContext#getBaseLength(int, FObj) + * {@inheritDoc} */ public int getBaseLength(int lengthBase, FObj fobj) { return getParent().getBaseLength(lengthBase, getParent().getFObj()); diff --git a/src/java/org/apache/fop/layoutmgr/inline/LeafNodeLayoutManager.java b/src/java/org/apache/fop/layoutmgr/inline/LeafNodeLayoutManager.java index cb693d056..78d126194 100644 --- a/src/java/org/apache/fop/layoutmgr/inline/LeafNodeLayoutManager.java +++ b/src/java/org/apache/fop/layoutmgr/inline/LeafNodeLayoutManager.java @@ -258,7 +258,7 @@ public abstract class LeafNodeLayoutManager extends AbstractLayoutManager area.setAdjustment(width - areaInfo.ipdArea.opt); } - /** @see org.apache.fop.layoutmgr.LayoutManager#getNextKnuthElements(LayoutContext, int) */ + /** {@inheritDoc} */ public LinkedList getNextKnuthElements(LayoutContext context, int alignment) { curArea = get(context); @@ -292,7 +292,7 @@ public abstract class LeafNodeLayoutManager extends AbstractLayoutManager return returnList; } - /** @see InlineLevelLayoutManager#addALetterSpaceTo(List) */ + /** {@inheritDoc} */ public List addALetterSpaceTo(List oldList) { // return the unchanged elements return oldList; @@ -308,21 +308,21 @@ public abstract class LeafNodeLayoutManager extends AbstractLayoutManager log.warn(this.getClass().getName() + " should not receive a call to removeWordSpace(list)"); } - /** @see InlineLevelLayoutManager#getWordChars(StringBuffer, Position) */ + /** {@inheritDoc} */ public void getWordChars(StringBuffer sbChars, Position pos) { } - /** @see InlineLevelLayoutManager#hyphenate(Position, HyphContext) */ + /** {@inheritDoc} */ public void hyphenate(Position pos, HyphContext hc) { } - /** @see InlineLevelLayoutManager#applyChanges(List) */ + /** {@inheritDoc} */ public boolean applyChanges(List oldList) { setFinished(false); return false; } - /** @see org.apache.fop.layoutmgr.LayoutManager#getChangedKnuthElements(List, int) */ + /** {@inheritDoc} */ public LinkedList getChangedKnuthElements(List oldList, int alignment) { if (isFinished()) { diff --git a/src/java/org/apache/fop/layoutmgr/inline/LineLayoutManager.java b/src/java/org/apache/fop/layoutmgr/inline/LineLayoutManager.java index 9686cf840..ad1f6d231 100644 --- a/src/java/org/apache/fop/layoutmgr/inline/LineLayoutManager.java +++ b/src/java/org/apache/fop/layoutmgr/inline/LineLayoutManager.java @@ -84,7 +84,7 @@ public class LineLayoutManager extends InlineStackingLayoutManager private Block fobj; private boolean isFirstInBlock; - /** @see org.apache.fop.layoutmgr.LayoutManager#initialize() */ + /** {@inheritDoc} */ public void initialize() { textAlignment = fobj.getTextAlign(); textAlignmentLast = fobj.getTextAlignLast(); @@ -567,7 +567,7 @@ public class LineLayoutManager extends InlineStackingLayoutManager follow = f; } - /** @see org.apache.fop.layoutmgr.LayoutManager */ + /** {@inheritDoc} */ public LinkedList getNextKnuthElements(LayoutContext context, int alignment) { Font fs = fobj.getCommonFont().getFontState(fobj.getFOEventHandler().getFontInfo(), this); alignmentContext @@ -652,14 +652,11 @@ public class LineLayoutManager extends InlineStackingLayoutManager while ((curLM = (InlineLevelLayoutManager) getChildLM()) != null) { returnedList = curLM.getNextKnuthElements(inlineLC, effectiveAlignment); - if (returnedList == null) { - // curLM returned null; this can happen - // if it has nothing more to layout, - // so just iterate once more to see - // if there are other children - continue; - } - if (returnedList.size() == 0) { + if (returnedList == null + || returnedList.size() == 0) { + /* curLM.getNextKnuthElements() returned null or an empty list; + * this can happen if there is nothing more to layout, + * so just iterate once more to see if there are other children */ continue; } @@ -1269,28 +1266,28 @@ public class LineLayoutManager extends InlineStackingLayoutManager } /** - * @see org.apache.fop.layoutmgr.BlockLevelLayoutManager#mustKeepTogether + * {@inheritDoc} */ public boolean mustKeepTogether() { return ((BlockLevelLayoutManager) getParent()).mustKeepTogether(); } /** - * @see org.apache.fop.layoutmgr.BlockLevelLayoutManager#mustKeepWithPrevious + * {@inheritDoc} */ public boolean mustKeepWithPrevious() { return false; } /** - * @see org.apache.fop.layoutmgr.BlockLevelLayoutManager#mustKeepWithNext + * {@inheritDoc} */ public boolean mustKeepWithNext() { return false; } /** - * @see org.apache.fop.layoutmgr.BlockLevelLayoutManager#negotiateBPDAdjustment(int, org.apache.fop.layoutmgr.KnuthElement) + * {@inheritDoc} */ public int negotiateBPDAdjustment(int adj, KnuthElement lastElement) { LeafPosition pos = (LeafPosition)lastElement.getPosition(); @@ -1309,13 +1306,13 @@ public class LineLayoutManager extends InlineStackingLayoutManager } /** - * @see org.apache.fop.layoutmgr.BlockLevelLayoutManager#discardSpace(KnuthGlue) + * {@inheritDoc} */ public void discardSpace(KnuthGlue spaceGlue) { } /** - * @see org.apache.fop.layoutmgr.LayoutManager#getChangedKnuthElements(List, int) + * {@inheritDoc} */ public LinkedList getChangedKnuthElements(List oldList, int alignment) { LinkedList returnList = new LinkedList(); @@ -1803,7 +1800,7 @@ public class LineLayoutManager extends InlineStackingLayoutManager } /** - * @see org.apache.fop.layoutmgr.LayoutManager#addChildArea(Area) + * {@inheritDoc} */ public void addChildArea(Area childArea) { // Make sure childArea is inline area @@ -1821,14 +1818,14 @@ public class LineLayoutManager extends InlineStackingLayoutManager // --------- Property Resolution related functions --------- // /** - * @see org.apache.fop.layoutmgr.LayoutManager#getGeneratesBlockArea + * {@inheritDoc} */ public boolean getGeneratesBlockArea() { return true; } /** - * @see org.apache.fop.layoutmgr.LayoutManager#getGeneratesLineArea + * {@inheritDoc} */ public boolean getGeneratesLineArea() { return true; diff --git a/src/java/org/apache/fop/layoutmgr/inline/PageNumberCitationLastLayoutManager.java b/src/java/org/apache/fop/layoutmgr/inline/PageNumberCitationLastLayoutManager.java index b507c3997..c012f351e 100644 --- a/src/java/org/apache/fop/layoutmgr/inline/PageNumberCitationLastLayoutManager.java +++ b/src/java/org/apache/fop/layoutmgr/inline/PageNumberCitationLastLayoutManager.java @@ -46,7 +46,7 @@ public class PageNumberCitationLastLayoutManager extends PageNumberCitationLayou fobj = node; } - /** @see org.apache.fop.layoutmgr.inline.LeafNodeLayoutManager#get(LayoutContext) */ + /** {@inheritDoc} */ public InlineArea get(LayoutContext context) { curArea = getPageNumberCitationLastInlineArea(parentLM); return curArea; diff --git a/src/java/org/apache/fop/layoutmgr/inline/PageNumberCitationLayoutManager.java b/src/java/org/apache/fop/layoutmgr/inline/PageNumberCitationLayoutManager.java index 8ab338e99..fda62ea15 100644 --- a/src/java/org/apache/fop/layoutmgr/inline/PageNumberCitationLayoutManager.java +++ b/src/java/org/apache/fop/layoutmgr/inline/PageNumberCitationLayoutManager.java @@ -55,14 +55,14 @@ public class PageNumberCitationLayoutManager extends LeafNodeLayoutManager { fobj = node; } - /** @see org.apache.fop.layoutmgr.LayoutManager#initialize */ + /** {@inheritDoc} */ public void initialize() { font = fobj.getCommonFont().getFontState(fobj.getFOEventHandler().getFontInfo(), this); setCommonBorderPaddingBackground(fobj.getCommonBorderPaddingBackground()); } /** - * @see LeafNodeLayoutManager#makeAlignmentContext(LayoutContext) + * {@inheritDoc} */ protected AlignmentContext makeAlignmentContext(LayoutContext context) { return new AlignmentContext( @@ -76,14 +76,14 @@ public class PageNumberCitationLayoutManager extends LeafNodeLayoutManager { ); } - /** @see org.apache.fop.layoutmgr.inline.LeafNodeLayoutManager#get(LayoutContext) */ + /** {@inheritDoc} */ public InlineArea get(LayoutContext context) { curArea = getPageNumberCitationInlineArea(parentLM); return curArea; } /** - * @see org.apache.fop.layoutmgr.inline.LeafNodeLayoutManager#addAreas(PositionIterator + * {@inheritDoc} * , LayoutContext) */ public void addAreas(PositionIterator posIter, LayoutContext context) { @@ -145,7 +145,7 @@ public class PageNumberCitationLayoutManager extends LeafNodeLayoutManager { return width; } - /** @see org.apache.fop.layoutmgr.inline.LeafNodeLayoutManager#addId() */ + /** {@inheritDoc} */ protected void addId() { getPSLM().addIDToPage(fobj.getId()); } diff --git a/src/java/org/apache/fop/layoutmgr/inline/PageNumberLayoutManager.java b/src/java/org/apache/fop/layoutmgr/inline/PageNumberLayoutManager.java index 51783fc1e..d09523e3c 100644 --- a/src/java/org/apache/fop/layoutmgr/inline/PageNumberLayoutManager.java +++ b/src/java/org/apache/fop/layoutmgr/inline/PageNumberLayoutManager.java @@ -47,14 +47,14 @@ public class PageNumberLayoutManager extends LeafNodeLayoutManager { fobj = node; } - /** @see org.apache.fop.layoutmgr.inline.LeafNodeLayoutManager#get(LayoutContext) */ + /** {@inheritDoc} */ public void initialize() { font = fobj.getCommonFont().getFontState(fobj.getFOEventHandler().getFontInfo(), this); setCommonBorderPaddingBackground(fobj.getCommonBorderPaddingBackground()); } /** - * @see org.apache.fop.layoutmgr.inline.LeafNodeLayoutManager + * {@inheritDoc} * #makeAlignmentContext(LayoutContext) */ protected AlignmentContext makeAlignmentContext(LayoutContext context) { @@ -69,7 +69,7 @@ public class PageNumberLayoutManager extends LeafNodeLayoutManager { ); } - /** @see org.apache.fop.layoutmgr.inline.LeafNodeLayoutManager#get(LayoutContext) */ + /** {@inheritDoc} */ public InlineArea get(LayoutContext context) { // get page string from parent, build area TextArea text = new TextArea(); @@ -87,7 +87,7 @@ public class PageNumberLayoutManager extends LeafNodeLayoutManager { return text; } - /** @see org.apache.fop.layoutmgr.inline.LeafNodeLayoutManager#getEffectiveArea() */ + /** {@inheritDoc} */ protected InlineArea getEffectiveArea() { TextArea baseArea = (TextArea)curArea; //TODO Maybe replace that with a clone() call or better, a copy constructor @@ -127,7 +127,7 @@ public class PageNumberLayoutManager extends LeafNodeLayoutManager { return width; } - /** @see org.apache.fop.layoutmgr.inline.LeafNodeLayoutManager#addId() */ + /** {@inheritDoc} */ protected void addId() { getPSLM().addIDToPage(fobj.getId()); } diff --git a/src/java/org/apache/fop/layoutmgr/inline/TextLayoutManager.java b/src/java/org/apache/fop/layoutmgr/inline/TextLayoutManager.java index de5f086b0..a805c363d 100644 --- a/src/java/org/apache/fop/layoutmgr/inline/TextLayoutManager.java +++ b/src/java/org/apache/fop/layoutmgr/inline/TextLayoutManager.java @@ -182,7 +182,7 @@ public class TextLayoutManager extends LeafNodeLayoutManager { vecAreaInfo = new java.util.ArrayList(); } - /** @see org.apache.fop.layoutmgr.LayoutManager#initialize */ + /** {@inheritDoc} */ public void initialize() { font = foText.getCommonFont().getFontState(foText.getFOEventHandler().getFontInfo(), this); @@ -542,7 +542,7 @@ public class TextLayoutManager extends LeafNodeLayoutManager { || CharUtilities.isFixedWidthSpace(ch); } - /** @see org.apache.fop.layoutmgr.LayoutManager#getNextKnuthElements(LayoutContext, int) */ + /** {@inheritDoc} */ public LinkedList getNextKnuthElements(LayoutContext context, int alignment) { lineStartBAP = context.getLineStartBorderAndPaddingWidth(); lineEndBAP = context.getLineEndBorderAndPaddingWidth(); @@ -792,7 +792,7 @@ public class TextLayoutManager extends LeafNodeLayoutManager { } } - /** @see InlineLevelLayoutManager#addALetterSpaceTo(List) */ + /** {@inheritDoc} */ public List addALetterSpaceTo(List oldList) { // old list contains only a box, or the sequence: box penalty glue box; // look at the Position stored in the first element in oldList @@ -858,7 +858,7 @@ public class TextLayoutManager extends LeafNodeLayoutManager { } } - /** @see InlineLevelLayoutManager#hyphenate(Position, HyphContext) */ + /** {@inheritDoc} */ public void hyphenate(Position pos, HyphContext hc) { AreaInfo ai = (AreaInfo) vecAreaInfo.get(((LeafPosition) pos).getLeafPos()); @@ -936,7 +936,7 @@ public class TextLayoutManager extends LeafNodeLayoutManager { } } - /** @see InlineLevelLayoutManager#applyChanges(List) */ + /** {@inheritDoc} */ public boolean applyChanges(List oldList) { setFinished(false); @@ -968,7 +968,7 @@ public class TextLayoutManager extends LeafNodeLayoutManager { return bChanged; } - /** @see org.apache.fop.layoutmgr.LayoutManager#getChangedKnuthElements(List, int) */ + /** {@inheritDoc} */ public LinkedList getChangedKnuthElements(List oldList, int alignment) { if (isFinished()) { @@ -995,7 +995,7 @@ public class TextLayoutManager extends LeafNodeLayoutManager { return returnList; } - /** @see InlineLevelLayoutManager#getWordChars(StringBuffer, Position) */ + /** {@inheritDoc} */ public void getWordChars(StringBuffer sbChars, Position pos) { int iLeafValue = ((LeafPosition) pos).getLeafPos(); if (iLeafValue != -1) { diff --git a/src/java/org/apache/fop/layoutmgr/inline/WrapperLayoutManager.java b/src/java/org/apache/fop/layoutmgr/inline/WrapperLayoutManager.java index a9807573d..fbeb61aa3 100644 --- a/src/java/org/apache/fop/layoutmgr/inline/WrapperLayoutManager.java +++ b/src/java/org/apache/fop/layoutmgr/inline/WrapperLayoutManager.java @@ -41,7 +41,7 @@ public class WrapperLayoutManager extends LeafNodeLayoutManager { fobj = node;
}
- /** @see org.apache.fop.layoutmgr.inline.LeafNodeLayoutManager */
+ /** {@inheritDoc} */
public InlineArea get(LayoutContext context) {
// Create a zero-width, zero-height dummy area so this node can
// participate in the ID handling. Otherwise, addId() wouldn't
@@ -75,7 +75,7 @@ public class WrapperLayoutManager extends LeafNodeLayoutManager { }
}
- /** @see org.apache.fop.layoutmgr.inline.LeafNodeLayoutManager#addId() */
+ /** {@inheritDoc} */
protected void addId() {
getPSLM().addIDToPage(fobj.getId());
}
diff --git a/src/java/org/apache/fop/layoutmgr/list/ListBlockLayoutManager.java b/src/java/org/apache/fop/layoutmgr/list/ListBlockLayoutManager.java index b830f84de..49e8b0df8 100644 --- a/src/java/org/apache/fop/layoutmgr/list/ListBlockLayoutManager.java +++ b/src/java/org/apache/fop/layoutmgr/list/ListBlockLayoutManager.java @@ -94,7 +94,7 @@ public class ListBlockLayoutManager extends BlockStackingLayoutManager return (ListBlock)fobj; } - /** @see org.apache.fop.layoutmgr.LayoutManager#initialize() */ + /** {@inheritDoc} */ public void initialize() { foSpaceBefore = new SpaceVal( getListBlockFO().getCommonMarginBlock().spaceBefore, this).getSpace(); @@ -113,7 +113,7 @@ public class ListBlockLayoutManager extends BlockStackingLayoutManager this.effSpaceAfter = null; } - /** @see org.apache.fop.layoutmgr.BlockStackingLayoutManager */ + /** {@inheritDoc} */ public LinkedList getNextKnuthElements(LayoutContext context, int alignment) { resetSpaces(); LinkedList returnList = super.getNextKnuthElements(context, alignment); @@ -133,7 +133,7 @@ public class ListBlockLayoutManager extends BlockStackingLayoutManager return returnList; } - /** @see org.apache.fop.layoutmgr.LayoutManager#getChangedKnuthElements(java.util.List, int) */ + /** {@inheritDoc} */ public LinkedList getChangedKnuthElements(List oldList, int alignment) { //log.debug("LBLM.getChangedKnuthElements>"); return super.getChangedKnuthElements(oldList, alignment); @@ -294,7 +294,7 @@ public class ListBlockLayoutManager extends BlockStackingLayoutManager } } - /** @see org.apache.fop.layoutmgr.BlockLevelLayoutManager#mustKeepTogether() */ + /** {@inheritDoc} */ public boolean mustKeepTogether() { //TODO Keeps will have to be more sophisticated sooner or later return ((BlockLevelLayoutManager)getParent()).mustKeepTogether() @@ -302,19 +302,19 @@ public class ListBlockLayoutManager extends BlockStackingLayoutManager || !getListBlockFO().getKeepTogether().getWithinColumn().isAuto(); } - /** @see org.apache.fop.layoutmgr.BlockLevelLayoutManager#mustKeepWithPrevious() */ + /** {@inheritDoc} */ public boolean mustKeepWithPrevious() { return !getListBlockFO().getKeepWithPrevious().getWithinPage().isAuto() || !getListBlockFO().getKeepWithPrevious().getWithinColumn().isAuto(); } - /** @see org.apache.fop.layoutmgr.BlockLevelLayoutManager#mustKeepWithNext() */ + /** {@inheritDoc} */ public boolean mustKeepWithNext() { return !getListBlockFO().getKeepWithNext().getWithinPage().isAuto() || !getListBlockFO().getKeepWithNext().getWithinColumn().isAuto(); } - /** @see org.apache.fop.layoutmgr.ConditionalElementListener */ + /** {@inheritDoc} */ public void notifySpace(RelSide side, MinOptMax effectiveLength) { if (RelSide.BEFORE == side) { if (log.isDebugEnabled()) { @@ -331,7 +331,7 @@ public class ListBlockLayoutManager extends BlockStackingLayoutManager } } - /** @see org.apache.fop.layoutmgr.ConditionalElementListener */ + /** {@inheritDoc} */ public void notifyBorder(RelSide side, MinOptMax effectiveLength) { if (effectiveLength == null) { if (RelSide.BEFORE == side) { @@ -345,7 +345,7 @@ public class ListBlockLayoutManager extends BlockStackingLayoutManager } } - /** @see org.apache.fop.layoutmgr.ConditionalElementListener */ + /** {@inheritDoc} */ public void notifyPadding(RelSide side, MinOptMax effectiveLength) { if (effectiveLength == null) { if (RelSide.BEFORE == side) { diff --git a/src/java/org/apache/fop/layoutmgr/list/ListItemContentLayoutManager.java b/src/java/org/apache/fop/layoutmgr/list/ListItemContentLayoutManager.java index 41ab67dcd..a60fa17b7 100644 --- a/src/java/org/apache/fop/layoutmgr/list/ListItemContentLayoutManager.java +++ b/src/java/org/apache/fop/layoutmgr/list/ListItemContentLayoutManager.java @@ -97,7 +97,7 @@ public class ListItemContentLayoutManager extends BlockStackingLayoutManager { xoffset = off; } - /** @see org.apache.fop.layoutmgr.LayoutManager#getChangedKnuthElements(java.util.List, int) */ + /** {@inheritDoc} */ public LinkedList getChangedKnuthElements(List oldList, int alignment) { //log.debug(" ListItemContentLayoutManager.getChanged>"); return super.getChangedKnuthElements(oldList, alignment); @@ -238,7 +238,7 @@ public class ListItemContentLayoutManager extends BlockStackingLayoutManager { } } - /** @see org.apache.fop.layoutmgr.BlockLevelLayoutManager#mustKeepTogether() */ + /** {@inheritDoc} */ public boolean mustKeepTogether() { //TODO Keeps will have to be more sophisticated sooner or later return ((BlockLevelLayoutManager)getParent()).mustKeepTogether() diff --git a/src/java/org/apache/fop/layoutmgr/list/ListItemLayoutManager.java b/src/java/org/apache/fop/layoutmgr/list/ListItemLayoutManager.java index 9b557d2e8..41738ff62 100644 --- a/src/java/org/apache/fop/layoutmgr/list/ListItemLayoutManager.java +++ b/src/java/org/apache/fop/layoutmgr/list/ListItemLayoutManager.java @@ -115,7 +115,7 @@ public class ListItemLayoutManager extends BlockStackingLayoutManager return iBodyLastIndex; } - /** @see java.lang.Object#toString() */ + /** {@inheritDoc} */ public String toString() { StringBuffer sb = new StringBuffer("ListItemPosition:"); sb.append(getIndex()).append("("); @@ -162,7 +162,7 @@ public class ListItemLayoutManager extends BlockStackingLayoutManager body.setParent(this); } - /** @see org.apache.fop.layoutmgr.LayoutManager#initialize() */ + /** {@inheritDoc} */ public void initialize() { foSpaceBefore = new SpaceVal( getListItemFO().getCommonMarginBlock().spaceBefore, this).getSpace(); @@ -181,7 +181,7 @@ public class ListItemLayoutManager extends BlockStackingLayoutManager this.effSpaceAfter = null; } - /** @see org.apache.fop.layoutmgr.LayoutManager */ + /** {@inheritDoc} */ public LinkedList getNextKnuthElements(LayoutContext context, int alignment) { referenceIPD = context.getRefIPD(); LayoutContext childLC; @@ -402,7 +402,7 @@ public class ListItemLayoutManager extends BlockStackingLayoutManager } /** - * @see org.apache.fop.layoutmgr.LayoutManager#getChangedKnuthElements(java.util.List, int) + * {@inheritDoc} */ public LinkedList getChangedKnuthElements(List oldList, int alignment) { //log.debug(" LILM.getChanged> label"); @@ -638,7 +638,7 @@ public class ListItemLayoutManager extends BlockStackingLayoutManager } } - /** @see org.apache.fop.layoutmgr.BlockLevelLayoutManager#mustKeepTogether() */ + /** {@inheritDoc} */ public boolean mustKeepTogether() { //TODO Keeps will have to be more sophisticated sooner or later return ((BlockLevelLayoutManager)getParent()).mustKeepTogether() @@ -646,19 +646,19 @@ public class ListItemLayoutManager extends BlockStackingLayoutManager || !getListItemFO().getKeepTogether().getWithinColumn().isAuto(); } - /** @see org.apache.fop.layoutmgr.BlockLevelLayoutManager#mustKeepWithPrevious() */ + /** {@inheritDoc} */ public boolean mustKeepWithPrevious() { return !getListItemFO().getKeepWithPrevious().getWithinPage().isAuto() || !getListItemFO().getKeepWithPrevious().getWithinColumn().isAuto(); } - /** @see org.apache.fop.layoutmgr.BlockLevelLayoutManager#mustKeepWithNext() */ + /** {@inheritDoc} */ public boolean mustKeepWithNext() { return !getListItemFO().getKeepWithNext().getWithinPage().isAuto() || !getListItemFO().getKeepWithNext().getWithinColumn().isAuto(); } - /** @see org.apache.fop.layoutmgr.ConditionalElementListener */ + /** {@inheritDoc} */ public void notifySpace(RelSide side, MinOptMax effectiveLength) { if (RelSide.BEFORE == side) { if (log.isDebugEnabled()) { @@ -675,7 +675,7 @@ public class ListItemLayoutManager extends BlockStackingLayoutManager } } - /** @see org.apache.fop.layoutmgr.ConditionalElementListener */ + /** {@inheritDoc} */ public void notifyBorder(RelSide side, MinOptMax effectiveLength) { if (effectiveLength == null) { if (RelSide.BEFORE == side) { @@ -689,7 +689,7 @@ public class ListItemLayoutManager extends BlockStackingLayoutManager } } - /** @see org.apache.fop.layoutmgr.ConditionalElementListener */ + /** {@inheritDoc} */ public void notifyPadding(RelSide side, MinOptMax effectiveLength) { if (effectiveLength == null) { if (RelSide.BEFORE == side) { diff --git a/src/java/org/apache/fop/layoutmgr/table/ColumnSetup.java b/src/java/org/apache/fop/layoutmgr/table/ColumnSetup.java index eb91f7175..bb33547e9 100644 --- a/src/java/org/apache/fop/layoutmgr/table/ColumnSetup.java +++ b/src/java/org/apache/fop/layoutmgr/table/ColumnSetup.java @@ -120,7 +120,7 @@ public class ColumnSetup { } } - /** @see java.lang.Object#toString() */ + /** {@inheritDoc} */ public String toString() { return columns.toString(); } diff --git a/src/java/org/apache/fop/layoutmgr/table/EffRow.java b/src/java/org/apache/fop/layoutmgr/table/EffRow.java index 1e184e767..85a9792d3 100644 --- a/src/java/org/apache/fop/layoutmgr/table/EffRow.java +++ b/src/java/org/apache/fop/layoutmgr/table/EffRow.java @@ -157,7 +157,7 @@ class EffRow { } } - /** @see java.lang.Object#toString() */ + /** {@inheritDoc} */ public String toString() { StringBuffer sb = new StringBuffer("EffRow {"); sb.append(index); diff --git a/src/java/org/apache/fop/layoutmgr/table/EmptyGridUnit.java b/src/java/org/apache/fop/layoutmgr/table/EmptyGridUnit.java index 274c752fc..1308b5840 100644 --- a/src/java/org/apache/fop/layoutmgr/table/EmptyGridUnit.java +++ b/src/java/org/apache/fop/layoutmgr/table/EmptyGridUnit.java @@ -44,17 +44,17 @@ public class EmptyGridUnit extends GridUnit { this.body = body; } - /** @see org.apache.fop.layoutmgr.table.GridUnit#isPrimary() */ + /** {@inheritDoc} */ public boolean isPrimary() { return true; } - /** @see org.apache.fop.layoutmgr.table.GridUnit#getBody() */ + /** {@inheritDoc} */ public TableBody getBody() { return this.body; } - /** @see org.apache.fop.layoutmgr.table.GridUnit#getRow() */ + /** {@inheritDoc} */ public TableRow getRow() { return this.row; } diff --git a/src/java/org/apache/fop/layoutmgr/table/GridUnit.java b/src/java/org/apache/fop/layoutmgr/table/GridUnit.java index beb41f35b..b4a2d7e5d 100644 --- a/src/java/org/apache/fop/layoutmgr/table/GridUnit.java +++ b/src/java/org/apache/fop/layoutmgr/table/GridUnit.java @@ -334,7 +334,7 @@ public class GridUnit { } } - /** @see java.lang.Object#toString() */ + /** {@inheritDoc} */ public String toString() { StringBuffer buffer = new StringBuffer(); if (isEmpty()) { diff --git a/src/java/org/apache/fop/layoutmgr/table/GridUnitPart.java b/src/java/org/apache/fop/layoutmgr/table/GridUnitPart.java index 0dcb785fc..28064b3e3 100644 --- a/src/java/org/apache/fop/layoutmgr/table/GridUnitPart.java +++ b/src/java/org/apache/fop/layoutmgr/table/GridUnitPart.java @@ -53,7 +53,7 @@ class GridUnitPart { return (end >= 0 && end == pgu.getElements().size() - 1); } - /** @see java.lang.Object#toString() */ + /** {@inheritDoc} */ public String toString() { StringBuffer sb = new StringBuffer("Part: "); sb.append(start).append("-").append(end); diff --git a/src/java/org/apache/fop/layoutmgr/table/PrimaryGridUnit.java b/src/java/org/apache/fop/layoutmgr/table/PrimaryGridUnit.java index 179a1c7bd..da6ecc627 100644 --- a/src/java/org/apache/fop/layoutmgr/table/PrimaryGridUnit.java +++ b/src/java/org/apache/fop/layoutmgr/table/PrimaryGridUnit.java @@ -212,7 +212,7 @@ public class PrimaryGridUnit extends GridUnit { return widths; } - /** @see java.lang.Object#toString() */ + /** {@inheritDoc} */ public String toString() { StringBuffer sb = new StringBuffer(super.toString()); sb.append(" startRow=").append(startRow); diff --git a/src/java/org/apache/fop/layoutmgr/table/TableCellLayoutManager.java b/src/java/org/apache/fop/layoutmgr/table/TableCellLayoutManager.java index 1ea836d38..17c8dd2d8 100644 --- a/src/java/org/apache/fop/layoutmgr/table/TableCellLayoutManager.java +++ b/src/java/org/apache/fop/layoutmgr/table/TableCellLayoutManager.java @@ -94,7 +94,7 @@ public class TableCellLayoutManager extends BlockStackingLayoutManager return getTable().isSeparateBorderModel(); } - /** @see org.apache.fop.layoutmgr.LayoutManager#initialize() */ + /** {@inheritDoc} */ public void initialize() { borderAndPaddingBPD = 0; borderAndPaddingBPD += getTableCell() @@ -122,7 +122,7 @@ public class TableCellLayoutManager extends BlockStackingLayoutManager } - /** @see org.apache.fop.layoutmgr.BlockStackingLayoutManager#getIPIndents() */ + /** {@inheritDoc} */ protected int getIPIndents() { int iIndents = 0; int[] startEndBorderWidths = primaryGridUnit.getStartEndBorderWidths(); @@ -139,7 +139,7 @@ public class TableCellLayoutManager extends BlockStackingLayoutManager } /** - * @see org.apache.fop.layoutmgr.LayoutManager + * {@inheritDoc} */ public LinkedList getNextKnuthElements(LayoutContext context, int alignment) { MinOptMax stackLimit = new MinOptMax(context.getStackLimit()); @@ -517,7 +517,7 @@ public class TableCellLayoutManager extends BlockStackingLayoutManager } /** - * @see org.apache.fop.layoutmgr.BlockLevelLayoutManager + * {@inheritDoc} */ public int negotiateBPDAdjustment(int adj, KnuthElement lastElement) { // TODO Auto-generated method stub @@ -525,14 +525,14 @@ public class TableCellLayoutManager extends BlockStackingLayoutManager } /** - * @see org.apache.fop.layoutmgr.BlockLevelLayoutManager + * {@inheritDoc} */ public void discardSpace(KnuthGlue spaceGlue) { // TODO Auto-generated method stub } /** - * @see org.apache.fop.layoutmgr.BlockLevelLayoutManager#mustKeepTogether() + * {@inheritDoc} */ public boolean mustKeepTogether() { //TODO Keeps will have to be more sophisticated sooner or later @@ -544,7 +544,7 @@ public class TableCellLayoutManager extends BlockStackingLayoutManager } /** - * @see org.apache.fop.layoutmgr.BlockLevelLayoutManager#mustKeepWithPrevious() + * {@inheritDoc} */ public boolean mustKeepWithPrevious() { return false; //TODO FIX ME @@ -555,7 +555,7 @@ public class TableCellLayoutManager extends BlockStackingLayoutManager } /** - * @see org.apache.fop.layoutmgr.BlockLevelLayoutManager#mustKeepWithNext() + * {@inheritDoc} */ public boolean mustKeepWithNext() { return false; //TODO FIX ME @@ -589,14 +589,14 @@ public class TableCellLayoutManager extends BlockStackingLayoutManager } /** - * @see org.apache.fop.layoutmgr.LayoutManager#getGeneratesReferenceArea + * {@inheritDoc} */ public boolean getGeneratesReferenceArea() { return true; } /** - * @see org.apache.fop.layoutmgr.LayoutManager#getGeneratesBlockArea + * {@inheritDoc} */ public boolean getGeneratesBlockArea() { return true; diff --git a/src/java/org/apache/fop/layoutmgr/table/TableContentLayoutManager.java b/src/java/org/apache/fop/layoutmgr/table/TableContentLayoutManager.java index 078b99df5..675e5ce95 100644 --- a/src/java/org/apache/fop/layoutmgr/table/TableContentLayoutManager.java +++ b/src/java/org/apache/fop/layoutmgr/table/TableContentLayoutManager.java @@ -133,7 +133,7 @@ public class TableContentLayoutManager implements PercentBaseContext { return this.footerList; } - /** @see org.apache.fop.layoutmgr.LayoutManager */ + /** @see org.apache.fop.layoutmgr.LayoutManager#getNextKnuthElements(LayoutContext, int) */ public LinkedList getNextKnuthElements(LayoutContext context, int alignment) { log.debug("==> Columns: " + getTableLM().getColumns()); KnuthBox headerAsFirst = null; @@ -825,7 +825,7 @@ public class TableContentLayoutManager implements PercentBaseContext { // --------- Property Resolution related functions --------- // /** - * @see org.apache.fop.datatypes.PercentBaseContext#getBaseLength(int, FObj) + * {@inheritDoc} */ public int getBaseLength(int lengthBase, FObj fobj) { return tableLM.getBaseLength(lengthBase, fobj); diff --git a/src/java/org/apache/fop/layoutmgr/table/TableLayoutManager.java b/src/java/org/apache/fop/layoutmgr/table/TableLayoutManager.java index 155111ac4..8500398b2 100644 --- a/src/java/org/apache/fop/layoutmgr/table/TableLayoutManager.java +++ b/src/java/org/apache/fop/layoutmgr/table/TableLayoutManager.java @@ -100,7 +100,7 @@ public class TableLayoutManager extends BlockStackingLayoutManager return this.columns; } - /** @see org.apache.fop.layoutmgr.LayoutManager#initialize() */ + /** {@inheritDoc} */ public void initialize() { foSpaceBefore = new SpaceVal( getTable().getCommonMarginBlock().spaceBefore, this).getSpace(); @@ -415,20 +415,20 @@ public class TableLayoutManager extends BlockStackingLayoutManager } } - /** @see org.apache.fop.layoutmgr.BlockLevelLayoutManager */ + /** {@inheritDoc} */ public int negotiateBPDAdjustment(int adj, KnuthElement lastElement) { // TODO Auto-generated method stub return 0; } - /** @see org.apache.fop.layoutmgr.BlockLevelLayoutManager */ + /** {@inheritDoc} */ public void discardSpace(KnuthGlue spaceGlue) { // TODO Auto-generated method stub } /** - * @see org.apache.fop.layoutmgr.BlockLevelLayoutManager#mustKeepTogether() + * {@inheritDoc} */ public boolean mustKeepTogether() { //TODO Keeps will have to be more sophisticated sooner or later @@ -438,7 +438,7 @@ public class TableLayoutManager extends BlockStackingLayoutManager } /** - * @see org.apache.fop.layoutmgr.BlockLevelLayoutManager#mustKeepWithPrevious() + * {@inheritDoc} */ public boolean mustKeepWithPrevious() { return !getTable().getKeepWithPrevious().getWithinPage().isAuto() @@ -446,7 +446,7 @@ public class TableLayoutManager extends BlockStackingLayoutManager } /** - * @see org.apache.fop.layoutmgr.BlockLevelLayoutManager#mustKeepWithNext() + * {@inheritDoc} */ public boolean mustKeepWithNext() { return !getTable().getKeepWithNext().getWithinPage().isAuto() @@ -456,7 +456,7 @@ public class TableLayoutManager extends BlockStackingLayoutManager // --------- Property Resolution related functions --------- // /** - * @see org.apache.fop.datatypes.PercentBaseContext#getBaseLength(int, FObj) + * {@inheritDoc} */ public int getBaseLength(int lengthBase, FObj fobj) { // Special handler for TableColumn width specifications @@ -480,7 +480,7 @@ public class TableLayoutManager extends BlockStackingLayoutManager } } - /** @see org.apache.fop.layoutmgr.ConditionalElementListener */ + /** {@inheritDoc} */ public void notifySpace(RelSide side, MinOptMax effectiveLength) { if (RelSide.BEFORE == side) { if (log.isDebugEnabled()) { @@ -497,7 +497,7 @@ public class TableLayoutManager extends BlockStackingLayoutManager } } - /** @see org.apache.fop.layoutmgr.ConditionalElementListener */ + /** {@inheritDoc} */ public void notifyBorder(RelSide side, MinOptMax effectiveLength) { if (effectiveLength == null) { if (RelSide.BEFORE == side) { @@ -511,7 +511,7 @@ public class TableLayoutManager extends BlockStackingLayoutManager } } - /** @see org.apache.fop.layoutmgr.ConditionalElementListener */ + /** {@inheritDoc} */ public void notifyPadding(RelSide side, MinOptMax effectiveLength) { if (effectiveLength == null) { if (RelSide.BEFORE == side) { diff --git a/src/java/org/apache/fop/layoutmgr/table/TableStepper.java b/src/java/org/apache/fop/layoutmgr/table/TableStepper.java index 2ed175fca..8dad6d520 100644 --- a/src/java/org/apache/fop/layoutmgr/table/TableStepper.java +++ b/src/java/org/apache/fop/layoutmgr/table/TableStepper.java @@ -88,7 +88,7 @@ public class TableStepper { * * @param column column number of the grid unit to get * @return the corresponding grid unit (may be null) - * @see TableStepper#getActiveRow + * {@inheritDoc} */ private GridUnit getActiveGridUnit(int column) { return getActiveRow().safelyGetGridUnit(column); diff --git a/src/java/org/apache/fop/pdf/ASCII85Filter.java b/src/java/org/apache/fop/pdf/ASCII85Filter.java index 32c7257e8..ef50bae93 100644 --- a/src/java/org/apache/fop/pdf/ASCII85Filter.java +++ b/src/java/org/apache/fop/pdf/ASCII85Filter.java @@ -41,7 +41,7 @@ public class ASCII85Filter extends PDFFilter { } /** - * @see org.apache.fop.pdf.PDFFilter#isASCIIFilter() + * {@inheritDoc} */ public boolean isASCIIFilter() { return true; @@ -57,7 +57,7 @@ public class ASCII85Filter extends PDFFilter { } /** - * @see org.apache.fop.pdf.PDFFilter#applyFilter(OutputStream) + * {@inheritDoc} */ public OutputStream applyFilter(OutputStream out) throws IOException { return new ASCII85OutputStream(out); diff --git a/src/java/org/apache/fop/pdf/ASCIIHexFilter.java b/src/java/org/apache/fop/pdf/ASCIIHexFilter.java index 23a19afbc..ba5f15882 100644 --- a/src/java/org/apache/fop/pdf/ASCIIHexFilter.java +++ b/src/java/org/apache/fop/pdf/ASCIIHexFilter.java @@ -40,7 +40,7 @@ public class ASCIIHexFilter extends PDFFilter { } /** - * @see org.apache.fop.pdf.PDFFilter#isASCIIFilter() + * {@inheritDoc} */ public boolean isASCIIFilter() { return true; @@ -56,7 +56,7 @@ public class ASCIIHexFilter extends PDFFilter { } /** - * @see org.apache.fop.pdf.PDFFilter#applyFilter(OutputStream) + * {@inheritDoc} */ public OutputStream applyFilter(OutputStream out) throws IOException { return new ASCIIHexOutputStream(out); diff --git a/src/java/org/apache/fop/pdf/AbstractPDFStream.java b/src/java/org/apache/fop/pdf/AbstractPDFStream.java index 0901ce196..364b42d66 100644 --- a/src/java/org/apache/fop/pdf/AbstractPDFStream.java +++ b/src/java/org/apache/fop/pdf/AbstractPDFStream.java @@ -164,7 +164,7 @@ public abstract class AbstractPDFStream extends PDFObject { /** * Overload the base object method so we don't have to copy * byte arrays around so much - * @see org.apache.fop.pdf.PDFObject#output(OutputStream) + * {@inheritDoc} */ protected int output(OutputStream stream) throws IOException { int length = 0; diff --git a/src/java/org/apache/fop/pdf/BitmapImage.java b/src/java/org/apache/fop/pdf/BitmapImage.java index 4752a78bf..e855dc61a 100644 --- a/src/java/org/apache/fop/pdf/BitmapImage.java +++ b/src/java/org/apache/fop/pdf/BitmapImage.java @@ -173,13 +173,13 @@ public class BitmapImage implements PDFImage { return maskRef; } - /** @see org.apache.fop.pdf.PDFImage#isInverted() */ + /** {@inheritDoc} */ public boolean isInverted() { return false; } /** - * @see org.apache.fop.pdf.PDFImage#outputContents(OutputStream) + * {@inheritDoc} */ public void outputContents(OutputStream out) throws IOException { out.write(bitmaps); @@ -202,14 +202,14 @@ public class BitmapImage implements PDFImage { } /** - * @see org.apache.fop.pdf.PDFImage#getFilterHint() + * {@inheritDoc} */ public String getFilterHint() { return PDFFilterList.IMAGE_FILTER; } /** - * @see org.apache.fop.pdf.PDFImage#getPDFFilter() + * {@inheritDoc} */ public PDFFilter getPDFFilter() { return null; diff --git a/src/java/org/apache/fop/pdf/CCFFilter.java b/src/java/org/apache/fop/pdf/CCFFilter.java index cc82d983f..98d23d25e 100644 --- a/src/java/org/apache/fop/pdf/CCFFilter.java +++ b/src/java/org/apache/fop/pdf/CCFFilter.java @@ -31,14 +31,14 @@ public class CCFFilter extends NullFilter { private String decodeParms; /** - * @see org.apache.fop.pdf.PDFFilter#getName() + * {@inheritDoc} */ public String getName() { return "/CCITTFaxDecode"; } /** - * @see org.apache.fop.pdf.PDFFilter#getDecodeParms() + * {@inheritDoc} */ public String getDecodeParms() { return this.decodeParms; diff --git a/src/java/org/apache/fop/pdf/FlateFilter.java b/src/java/org/apache/fop/pdf/FlateFilter.java index f9fc3705c..83eb1ac08 100644 --- a/src/java/org/apache/fop/pdf/FlateFilter.java +++ b/src/java/org/apache/fop/pdf/FlateFilter.java @@ -211,7 +211,7 @@ public class FlateFilter extends PDFFilter { /** - * @see org.apache.fop.pdf.PDFFilter#applyFilter(OutputStream) + * {@inheritDoc} */ public OutputStream applyFilter(OutputStream out) throws IOException { return new FlateEncodeOutputStream(out); diff --git a/src/java/org/apache/fop/pdf/InMemoryStreamCache.java b/src/java/org/apache/fop/pdf/InMemoryStreamCache.java index 8ad88e3b7..03552aa23 100644 --- a/src/java/org/apache/fop/pdf/InMemoryStreamCache.java +++ b/src/java/org/apache/fop/pdf/InMemoryStreamCache.java @@ -67,7 +67,7 @@ public class InMemoryStreamCache implements StreamCache { } /** - * @see org.apache.fop.pdf.StreamCache#write(byte[]) + * {@inheritDoc} */ public void write(byte[] data) throws IOException { getOutputStream().write(data); diff --git a/src/java/org/apache/fop/pdf/NullFilter.java b/src/java/org/apache/fop/pdf/NullFilter.java index 4b1506da2..7c7f54b68 100644 --- a/src/java/org/apache/fop/pdf/NullFilter.java +++ b/src/java/org/apache/fop/pdf/NullFilter.java @@ -29,21 +29,21 @@ import java.io.OutputStream; public class NullFilter extends PDFFilter { /** - * @see org.apache.fop.pdf.PDFFilter#getName() + * {@inheritDoc} */ public String getName() { return ""; } /** - * @see org.apache.fop.pdf.PDFFilter#getDecodeParms() + * {@inheritDoc} */ public String getDecodeParms() { return null; } /** - * @see org.apache.fop.pdf.PDFFilter#applyFilter(OutputStream) + * {@inheritDoc} */ public OutputStream applyFilter(OutputStream out) throws IOException { return out; diff --git a/src/java/org/apache/fop/pdf/PDFAMode.java b/src/java/org/apache/fop/pdf/PDFAMode.java index fef8140dc..d27f64e83 100644 --- a/src/java/org/apache/fop/pdf/PDFAMode.java +++ b/src/java/org/apache/fop/pdf/PDFAMode.java @@ -65,7 +65,7 @@ public final class PDFAMode { } } - /** @see java.lang.Object#toString() */ + /** {@inheritDoc} */ public String toString() { return name; } diff --git a/src/java/org/apache/fop/pdf/PDFAnnotList.java b/src/java/org/apache/fop/pdf/PDFAnnotList.java index a1196060a..30116c0f8 100644 --- a/src/java/org/apache/fop/pdf/PDFAnnotList.java +++ b/src/java/org/apache/fop/pdf/PDFAnnotList.java @@ -54,7 +54,7 @@ public class PDFAnnotList extends PDFObject { } /** - * @see org.apache.fop.pdf.PDFObject#toPDFString() + * {@inheritDoc} */ public String toPDFString() { StringBuffer p = new StringBuffer(128); diff --git a/src/java/org/apache/fop/pdf/PDFArray.java b/src/java/org/apache/fop/pdf/PDFArray.java index abeed1d86..1140363ec 100644 --- a/src/java/org/apache/fop/pdf/PDFArray.java +++ b/src/java/org/apache/fop/pdf/PDFArray.java @@ -114,7 +114,7 @@ public class PDFArray extends PDFObject { } /** - * @see org.apache.fop.pdf.PDFObject#toPDFString() + * {@inheritDoc} */ public String toPDFString() { StringBuffer p = new StringBuffer(64); diff --git a/src/java/org/apache/fop/pdf/PDFCIDFont.java b/src/java/org/apache/fop/pdf/PDFCIDFont.java index ec091c8a7..3fcedbbb9 100644 --- a/src/java/org/apache/fop/pdf/PDFCIDFont.java +++ b/src/java/org/apache/fop/pdf/PDFCIDFont.java @@ -195,7 +195,7 @@ public class PDFCIDFont extends PDFObject { } /** - * @see org.apache.fop.pdf.PDFObject#toPDFString() + * {@inheritDoc} */ public String toPDFString() { StringBuffer p = new StringBuffer(128); diff --git a/src/java/org/apache/fop/pdf/PDFDestination.java b/src/java/org/apache/fop/pdf/PDFDestination.java index 2b7ec0a1f..c59b20cfc 100644 --- a/src/java/org/apache/fop/pdf/PDFDestination.java +++ b/src/java/org/apache/fop/pdf/PDFDestination.java @@ -59,7 +59,7 @@ public class PDFDestination extends PDFObject { return sb.toString(); } - /** @see org.apache.fop.pdf.PDFObject#toPDFString() */ + /** {@inheritDoc} */ protected String toPDFString() { return toKeyValuePair(); } @@ -125,7 +125,7 @@ public class PDFDestination extends PDFObject { } /** - * @see java.lang.Object#hashCode() + * {@inheritDoc} */ public int hashCode() { return getIDRef().hashCode(); diff --git a/src/java/org/apache/fop/pdf/PDFDeviceColorSpace.java b/src/java/org/apache/fop/pdf/PDFDeviceColorSpace.java index db0fa57ec..269b9f7b0 100644 --- a/src/java/org/apache/fop/pdf/PDFDeviceColorSpace.java +++ b/src/java/org/apache/fop/pdf/PDFDeviceColorSpace.java @@ -117,22 +117,22 @@ public class PDFDeviceColorSpace implements PDFColorSpace { } } - /** @see org.apache.fop.pdf.PDFColorSpace#isDeviceColorSpace() */ + /** {@inheritDoc} */ public boolean isDeviceColorSpace() { return true; } - /** @see org.apache.fop.pdf.PDFColorSpace#isRGBColorSpace() */ + /** {@inheritDoc} */ public boolean isRGBColorSpace() { return getColorSpace() == DEVICE_RGB; } - /** @see org.apache.fop.pdf.PDFColorSpace#isCMYKColorSpace() */ + /** {@inheritDoc} */ public boolean isCMYKColorSpace() { return getColorSpace() == DEVICE_CMYK; } - /** @see org.apache.fop.pdf.PDFColorSpace#isGrayColorSpace() */ + /** {@inheritDoc} */ public boolean isGrayColorSpace() { return getColorSpace() == DEVICE_GRAY; } diff --git a/src/java/org/apache/fop/pdf/PDFDictionary.java b/src/java/org/apache/fop/pdf/PDFDictionary.java index 2a9c3ffe4..73878bdc6 100644 --- a/src/java/org/apache/fop/pdf/PDFDictionary.java +++ b/src/java/org/apache/fop/pdf/PDFDictionary.java @@ -69,7 +69,7 @@ public class PDFDictionary extends PDFObject { } /** - * @see org.apache.fop.pdf.PDFObject#toPDFString() + * {@inheritDoc} */ public String toPDFString() { StringBuffer p = new StringBuffer(64); diff --git a/src/java/org/apache/fop/pdf/PDFEncoding.java b/src/java/org/apache/fop/pdf/PDFEncoding.java index a334445fc..b9064dc1f 100644 --- a/src/java/org/apache/fop/pdf/PDFEncoding.java +++ b/src/java/org/apache/fop/pdf/PDFEncoding.java @@ -89,7 +89,7 @@ public class PDFEncoding extends PDFObject { } /** - * @see org.apache.fop.pdf.PDFObject#toPDFString() + * {@inheritDoc} */ public String toPDFString() { StringBuffer p = new StringBuffer(128); diff --git a/src/java/org/apache/fop/pdf/PDFEncryptionJCE.java b/src/java/org/apache/fop/pdf/PDFEncryptionJCE.java index 22085deac..099948864 100644 --- a/src/java/org/apache/fop/pdf/PDFEncryptionJCE.java +++ b/src/java/org/apache/fop/pdf/PDFEncryptionJCE.java @@ -89,7 +89,7 @@ public class PDFEncryptionJCE extends PDFObject implements PDFEncryption { } /** - * @see org.apache.fop.pdf.PDFFilter#encode(InputStream, OutputStream, int) + * {@inheritDoc} */ public void encode(InputStream in, OutputStream out, int length) throws IOException { @@ -100,7 +100,7 @@ public class PDFEncryptionJCE extends PDFObject implements PDFEncryption { } /** - * @see org.apache.fop.pdf.PDFFilter#applyFilter(OutputStream) + * {@inheritDoc} */ public OutputStream applyFilter(OutputStream out) throws IOException { return new CipherOutputStream(out, @@ -365,7 +365,7 @@ public class PDFEncryptionJCE extends PDFObject implements PDFEncryption { } /** - * @see org.apache.fop.pdf.PDFEncryption#encrypt(byte[], PDFObject) + * {@inheritDoc} */ public byte[] encrypt(byte[] data, PDFObject refObj) { return encryptData(data, refObj.getObjectNumber(), refObj.getGeneration()); @@ -420,7 +420,7 @@ public class PDFEncryptionJCE extends PDFObject implements PDFEncryption { } /** - * @see org.apache.fop.pdf.PDFEncryption#getTrailerEntry() + * {@inheritDoc} */ public String getTrailerEntry() { return "/Encrypt " + getObjectNumber() + " " diff --git a/src/java/org/apache/fop/pdf/PDFFactory.java b/src/java/org/apache/fop/pdf/PDFFactory.java index 8011ffc92..d1e81647a 100644 --- a/src/java/org/apache/fop/pdf/PDFFactory.java +++ b/src/java/org/apache/fop/pdf/PDFFactory.java @@ -1473,7 +1473,7 @@ public class PDFFactory { * Create a PDFICCStream * @see PDFXObject * @see org.apache.fop.image.JpegImage - * @see org.apache.fop.pdf.PDFDeviceColorSpace + * @see org.apache.fop.pdf.PDFDeviceColorSpace * @return the new PDF ICC stream object */ public PDFICCStream makePDFICCStream() { diff --git a/src/java/org/apache/fop/pdf/PDFFileSpec.java b/src/java/org/apache/fop/pdf/PDFFileSpec.java index 587f3a849..2c91dac5c 100644 --- a/src/java/org/apache/fop/pdf/PDFFileSpec.java +++ b/src/java/org/apache/fop/pdf/PDFFileSpec.java @@ -44,7 +44,7 @@ public class PDFFileSpec extends PDFObject { } /** - * @see org.apache.fop.pdf.PDFObject#toPDFString() + * {@inheritDoc} */ public String toPDFString() { return getObjectID() diff --git a/src/java/org/apache/fop/pdf/PDFFont.java b/src/java/org/apache/fop/pdf/PDFFont.java index 181636c65..0730376db 100644 --- a/src/java/org/apache/fop/pdf/PDFFont.java +++ b/src/java/org/apache/fop/pdf/PDFFont.java @@ -204,7 +204,7 @@ public class PDFFont extends PDFObject { } /** - * @see org.apache.fop.pdf.PDFObject#toPDFString() + * {@inheritDoc} */ public String toPDFString() { validate(); diff --git a/src/java/org/apache/fop/pdf/PDFFontDescriptor.java b/src/java/org/apache/fop/pdf/PDFFontDescriptor.java index db1e73ec0..be460dcc2 100644 --- a/src/java/org/apache/fop/pdf/PDFFontDescriptor.java +++ b/src/java/org/apache/fop/pdf/PDFFontDescriptor.java @@ -137,7 +137,7 @@ public class PDFFontDescriptor extends PDFObject { // public void setCharSet(){}//for subset fonts /** - * @see org.apache.fop.pdf.PDFObject#toPDFString() + * {@inheritDoc} */ public String toPDFString() { StringBuffer p = new StringBuffer(128); diff --git a/src/java/org/apache/fop/pdf/PDFFontNonBase14.java b/src/java/org/apache/fop/pdf/PDFFontNonBase14.java index e479e9222..0689cbbdb 100644 --- a/src/java/org/apache/fop/pdf/PDFFontNonBase14.java +++ b/src/java/org/apache/fop/pdf/PDFFontNonBase14.java @@ -94,7 +94,7 @@ public abstract class PDFFontNonBase14 extends PDFFont { return this.descriptor; } - /** @see org.apache.fop.pdf.PDFFont#validate() */ + /** {@inheritDoc} */ protected void validate() { if (getDocumentSafely().getProfile().isFontEmbeddingRequired()) { if (this.getDescriptor().getFontFile() == null) { @@ -105,7 +105,7 @@ public abstract class PDFFontNonBase14 extends PDFFont { } /** - * @see org.apache.fop.pdf.PDFFont#fillInPDF(StringBuffer) + * {@inheritDoc} */ protected void fillInPDF(StringBuffer target) { target.append("\n/FirstChar "); diff --git a/src/java/org/apache/fop/pdf/PDFFontType0.java b/src/java/org/apache/fop/pdf/PDFFontType0.java index 5467f12a5..e8a338ad4 100644 --- a/src/java/org/apache/fop/pdf/PDFFontType0.java +++ b/src/java/org/apache/fop/pdf/PDFFontType0.java @@ -94,7 +94,7 @@ public class PDFFontType0 extends PDFFontNonBase14 { } /** - * @see org.apache.fop.pdf.PDFFont#fillInPDF(StringBuffer) + * {@inheritDoc} */ protected void fillInPDF(StringBuffer target) { if (descendantFonts != null) { diff --git a/src/java/org/apache/fop/pdf/PDFFontType3.java b/src/java/org/apache/fop/pdf/PDFFontType3.java index 78238d1b8..48df26fdf 100644 --- a/src/java/org/apache/fop/pdf/PDFFontType3.java +++ b/src/java/org/apache/fop/pdf/PDFFontType3.java @@ -124,7 +124,7 @@ public class PDFFontType3 extends PDFFontNonBase14 { } /** - * @see org.apache.fop.pdf.PDFFont#fillInPDF(StringBuffer) + * {@inheritDoc} */ protected void fillInPDF(StringBuffer target) { if (fontBBox != null) { diff --git a/src/java/org/apache/fop/pdf/PDFFormXObject.java b/src/java/org/apache/fop/pdf/PDFFormXObject.java index c399456a5..519bae47a 100644 --- a/src/java/org/apache/fop/pdf/PDFFormXObject.java +++ b/src/java/org/apache/fop/pdf/PDFFormXObject.java @@ -97,7 +97,7 @@ public class PDFFormXObject extends PDFXObject { } /** - * @see org.apache.fop.pdf.PDFStream#outputRawStreamData(OutputStream) + * {@inheritDoc} */ protected void outputRawStreamData(OutputStream out) throws IOException { contents.outputRawStreamData(out); diff --git a/src/java/org/apache/fop/pdf/PDFGState.java b/src/java/org/apache/fop/pdf/PDFGState.java index 3ed86c7b7..03608994d 100644 --- a/src/java/org/apache/fop/pdf/PDFGState.java +++ b/src/java/org/apache/fop/pdf/PDFGState.java @@ -145,7 +145,7 @@ public class PDFGState extends PDFObject { } /** - * @see org.apache.fop.pdf.PDFObject#toPDFString() + * {@inheritDoc} */ public String toPDFString() { StringBuffer sb = new StringBuffer(64); @@ -176,7 +176,7 @@ public class PDFGState extends PDFObject { */ /** - * @see java.lang.Object#equals(Object) + * {@inheritDoc} */ public boolean equals(Object obj) { if (obj == this) { diff --git a/src/java/org/apache/fop/pdf/PDFGoTo.java b/src/java/org/apache/fop/pdf/PDFGoTo.java index 16eaf73ce..ae35928d2 100644 --- a/src/java/org/apache/fop/pdf/PDFGoTo.java +++ b/src/java/org/apache/fop/pdf/PDFGoTo.java @@ -118,7 +118,7 @@ public class PDFGoTo extends PDFAction { } /** - * @see org.apache.fop.pdf.PDFObject#toPDFString() + * {@inheritDoc} */ public String toPDFString() { String dest; diff --git a/src/java/org/apache/fop/pdf/PDFGoToRemote.java b/src/java/org/apache/fop/pdf/PDFGoToRemote.java index b852899de..71cae5ba6 100644 --- a/src/java/org/apache/fop/pdf/PDFGoToRemote.java +++ b/src/java/org/apache/fop/pdf/PDFGoToRemote.java @@ -81,7 +81,7 @@ public class PDFGoToRemote extends PDFAction { } /** - * @see org.apache.fop.pdf.PDFObject#toPDFString() + * {@inheritDoc} */ public String toPDFString() { StringBuffer sb = new StringBuffer(64); diff --git a/src/java/org/apache/fop/pdf/PDFICCBasedColorSpace.java b/src/java/org/apache/fop/pdf/PDFICCBasedColorSpace.java index cd6df5284..7d17bb01f 100644 --- a/src/java/org/apache/fop/pdf/PDFICCBasedColorSpace.java +++ b/src/java/org/apache/fop/pdf/PDFICCBasedColorSpace.java @@ -50,12 +50,12 @@ public class PDFICCBasedColorSpace extends PDFObject implements PDFColorSpace { return this.iccStream; } - /** @see org.apache.fop.pdf.PDFColorSpace#getNumComponents() */ + /** {@inheritDoc} */ public int getNumComponents() { return iccStream.getICCProfile().getNumComponents(); } - /** @see org.apache.fop.pdf.PDFColorSpace#getName() */ + /** {@inheritDoc} */ public String getName() { if (explicitName != null) { return explicitName; @@ -64,27 +64,27 @@ public class PDFICCBasedColorSpace extends PDFObject implements PDFColorSpace { } } - /** @see org.apache.fop.pdf.PDFColorSpace#isDeviceColorSpace() */ + /** {@inheritDoc} */ public boolean isDeviceColorSpace() { return false; } - /** @see org.apache.fop.pdf.PDFColorSpace#isRGBColorSpace() */ + /** {@inheritDoc} */ public boolean isRGBColorSpace() { return getNumComponents() == 3; } - /** @see org.apache.fop.pdf.PDFColorSpace#isCMYKColorSpace() */ + /** {@inheritDoc} */ public boolean isCMYKColorSpace() { return getNumComponents() == 4; } - /** @see org.apache.fop.pdf.PDFColorSpace#isGrayColorSpace() */ + /** {@inheritDoc} */ public boolean isGrayColorSpace() { return getNumComponents() == 1; } - /** @see org.apache.fop.pdf.PDFObject#toPDFString() */ + /** {@inheritDoc} */ protected String toPDFString() { StringBuffer sb = new StringBuffer(64); sb.append(getObjectID()); diff --git a/src/java/org/apache/fop/pdf/PDFICCStream.java b/src/java/org/apache/fop/pdf/PDFICCStream.java index 788a3a1a3..6c08953cb 100644 --- a/src/java/org/apache/fop/pdf/PDFICCStream.java +++ b/src/java/org/apache/fop/pdf/PDFICCStream.java @@ -57,7 +57,7 @@ public class PDFICCStream extends PDFStream { /** * overload the base object method so we don't have to copy * byte arrays around so much - * @see org.apache.fop.pdf.PDFObject#output(OutputStream) + * {@inheritDoc} */ protected int output(java.io.OutputStream stream) throws java.io.IOException { @@ -67,14 +67,14 @@ public class PDFICCStream extends PDFStream { } /** - * @see org.apache.fop.pdf.PDFStream#outputRawStreamData(OutputStream) + * {@inheritDoc} */ protected void outputRawStreamData(OutputStream out) throws IOException { cp.write(out); } /** - * @see org.apache.fop.pdf.AbstractPDFStream#buildStreamDict(String) + * {@inheritDoc} */ protected String buildStreamDict(String lengthEntry) { final String filterEntry = getFilterList().buildFilterDictEntries(); diff --git a/src/java/org/apache/fop/pdf/PDFInfo.java b/src/java/org/apache/fop/pdf/PDFInfo.java index 57b4f01a5..888fdb2c6 100644 --- a/src/java/org/apache/fop/pdf/PDFInfo.java +++ b/src/java/org/apache/fop/pdf/PDFInfo.java @@ -159,7 +159,7 @@ public class PDFInfo extends PDFObject { } /** - * @see org.apache.fop.pdf.PDFObject#toPDF() + * {@inheritDoc} */ public byte[] toPDF() { PDFProfile profile = getDocumentSafely().getProfile(); diff --git a/src/java/org/apache/fop/pdf/PDFInternalLink.java b/src/java/org/apache/fop/pdf/PDFInternalLink.java index 884fcde0d..fcdc2e1bc 100644 --- a/src/java/org/apache/fop/pdf/PDFInternalLink.java +++ b/src/java/org/apache/fop/pdf/PDFInternalLink.java @@ -46,7 +46,7 @@ public class PDFInternalLink extends PDFAction { } /** - * @see org.apache.fop.pdf.PDFObject#toPDFString() + * {@inheritDoc} */ protected String toPDFString() { throw new UnsupportedOperationException("This method should not be called"); diff --git a/src/java/org/apache/fop/pdf/PDFLink.java b/src/java/org/apache/fop/pdf/PDFLink.java index e800f3b67..fb8544f6b 100644 --- a/src/java/org/apache/fop/pdf/PDFLink.java +++ b/src/java/org/apache/fop/pdf/PDFLink.java @@ -69,7 +69,7 @@ public class PDFLink extends PDFObject { } /** - * @see org.apache.fop.pdf.PDFObject#toPDFString() + * {@inheritDoc} */ public String toPDFString() { getDocumentSafely().getProfile().verifyAnnotAllowed(); diff --git a/src/java/org/apache/fop/pdf/PDFMetadata.java b/src/java/org/apache/fop/pdf/PDFMetadata.java index addd7f2b1..74ffb1580 100644 --- a/src/java/org/apache/fop/pdf/PDFMetadata.java +++ b/src/java/org/apache/fop/pdf/PDFMetadata.java @@ -58,7 +58,7 @@ public class PDFMetadata extends PDFStream { this.readOnly = readOnly; } - /** @see org.apache.fop.pdf.AbstractPDFStream#setupFilterList() */ + /** {@inheritDoc} */ protected void setupFilterList() { if (!getFilterList().isInitialized()) { getFilterList().addDefaultFilters( @@ -78,7 +78,7 @@ public class PDFMetadata extends PDFStream { /** * overload the base object method so we don't have to copy * byte arrays around so much - * @see org.apache.fop.pdf.PDFObject#output(OutputStream) + * {@inheritDoc} */ protected int output(java.io.OutputStream stream) throws java.io.IOException { @@ -87,7 +87,7 @@ public class PDFMetadata extends PDFStream { return length; } - /** @see org.apache.fop.pdf.AbstractPDFStream#outputRawStreamData(java.io.OutputStream) */ + /** {@inheritDoc} */ protected void outputRawStreamData(OutputStream out) throws IOException { try { XMPSerializer.writeXMPPacket(xmpMetadata, out, this.readOnly); @@ -100,7 +100,7 @@ public class PDFMetadata extends PDFStream { } } - /** @see org.apache.fop.pdf.AbstractPDFStream#buildStreamDict(String) */ + /** {@inheritDoc} */ protected String buildStreamDict(String lengthEntry) { final String filterEntry = getFilterList().buildFilterDictEntries(); if (getDocumentSafely().getProfile().getPDFAMode().isPDFA1LevelB() diff --git a/src/java/org/apache/fop/pdf/PDFNumber.java b/src/java/org/apache/fop/pdf/PDFNumber.java index 6fa649ffa..6da28f9be 100644 --- a/src/java/org/apache/fop/pdf/PDFNumber.java +++ b/src/java/org/apache/fop/pdf/PDFNumber.java @@ -103,7 +103,7 @@ public class PDFNumber extends PDFObject { } /** - * @see org.apache.fop.pdf.PDFObject#toPDFString() + * {@inheritDoc} */ protected String toPDFString() { if (getNumber() == null) { diff --git a/src/java/org/apache/fop/pdf/PDFOutline.java b/src/java/org/apache/fop/pdf/PDFOutline.java index 17ca2ade1..b4b7cb6be 100644 --- a/src/java/org/apache/fop/pdf/PDFOutline.java +++ b/src/java/org/apache/fop/pdf/PDFOutline.java @@ -127,7 +127,7 @@ public class PDFOutline extends PDFObject { } /** - * @see org.apache.fop.pdf.PDFObject#toPDF() + * {@inheritDoc} */ protected byte[] toPDF() { ByteArrayOutputStream bout = new ByteArrayOutputStream(128); diff --git a/src/java/org/apache/fop/pdf/PDFOutputIntent.java b/src/java/org/apache/fop/pdf/PDFOutputIntent.java index 0db1fc306..17badfd5a 100644 --- a/src/java/org/apache/fop/pdf/PDFOutputIntent.java +++ b/src/java/org/apache/fop/pdf/PDFOutputIntent.java @@ -126,7 +126,7 @@ public class PDFOutputIntent extends PDFObject { this.destOutputProfile = destOutputProfile; } - /** @see org.apache.fop.pdf.PDFObject#toPDF() */ + /** {@inheritDoc} */ public byte[] toPDF() { ByteArrayOutputStream bout = new ByteArrayOutputStream(128); try { diff --git a/src/java/org/apache/fop/pdf/PDFPage.java b/src/java/org/apache/fop/pdf/PDFPage.java index 49eb0c278..479600536 100644 --- a/src/java/org/apache/fop/pdf/PDFPage.java +++ b/src/java/org/apache/fop/pdf/PDFPage.java @@ -153,7 +153,7 @@ public class PDFPage extends PDFResourceContext { } /** - * @see org.apache.fop.pdf.PDFObject#toPDFString() + * {@inheritDoc} */ public String toPDFString() { StringBuffer sb = new StringBuffer(); diff --git a/src/java/org/apache/fop/pdf/PDFPages.java b/src/java/org/apache/fop/pdf/PDFPages.java index d84342fe0..37a2394db 100644 --- a/src/java/org/apache/fop/pdf/PDFPages.java +++ b/src/java/org/apache/fop/pdf/PDFPages.java @@ -106,7 +106,7 @@ public class PDFPages extends PDFObject { } /** - * @see org.apache.fop.pdf.PDFObject#toPDFString() + * {@inheritDoc} */ public String toPDFString() { StringBuffer sb = new StringBuffer(64); diff --git a/src/java/org/apache/fop/pdf/PDFProfile.java b/src/java/org/apache/fop/pdf/PDFProfile.java index 3458d72a4..3264e1f44 100644 --- a/src/java/org/apache/fop/pdf/PDFProfile.java +++ b/src/java/org/apache/fop/pdf/PDFProfile.java @@ -119,7 +119,7 @@ public class PDFProfile { validateProfileCombination(); } - /** @see java.lang.Object#toString() */ + /** {@inheritDoc} */ public String toString() { StringBuffer sb = new StringBuffer(); if (isPDFAActive() && isPDFXActive()) { diff --git a/src/java/org/apache/fop/pdf/PDFReference.java b/src/java/org/apache/fop/pdf/PDFReference.java index 4ca50a79f..a1b776a81 100644 --- a/src/java/org/apache/fop/pdf/PDFReference.java +++ b/src/java/org/apache/fop/pdf/PDFReference.java @@ -59,7 +59,7 @@ public class PDFReference implements PDFWritable { } } - /** @see org.apache.fop.pdf.PDFWritable#toInlinePDFString() */ + /** {@inheritDoc} */ public String toInlinePDFString() { return this.indirectReference; } diff --git a/src/java/org/apache/fop/pdf/PDFResources.java b/src/java/org/apache/fop/pdf/PDFResources.java index 232001001..70e809aaa 100644 --- a/src/java/org/apache/fop/pdf/PDFResources.java +++ b/src/java/org/apache/fop/pdf/PDFResources.java @@ -184,7 +184,7 @@ public class PDFResources extends PDFObject { * resource context. * * @return the PDF - * @see org.apache.fop.pdf.PDFObject#toPDFString() + * {@inheritDoc} */ public String toPDFString() { StringBuffer p = new StringBuffer(128); diff --git a/src/java/org/apache/fop/pdf/PDFRoot.java b/src/java/org/apache/fop/pdf/PDFRoot.java index 4a80de4c9..64103df22 100644 --- a/src/java/org/apache/fop/pdf/PDFRoot.java +++ b/src/java/org/apache/fop/pdf/PDFRoot.java @@ -174,7 +174,7 @@ public class PDFRoot extends PDFObject { } /** - * @see org.apache.fop.pdf.PDFObject#toPDFString() + * {@inheritDoc} */ public String toPDFString() { StringBuffer p = new StringBuffer(128); diff --git a/src/java/org/apache/fop/pdf/PDFState.java b/src/java/org/apache/fop/pdf/PDFState.java index c01aab52e..e453d7b51 100644 --- a/src/java/org/apache/fop/pdf/PDFState.java +++ b/src/java/org/apache/fop/pdf/PDFState.java @@ -364,7 +364,7 @@ public class PDFState { public PDFGState gstate = null; - /** @see java.lang.Object#clone() */ + /** {@inheritDoc} */ public Object clone() throws CloneNotSupportedException { Data obj = new Data(); obj.color = this.color; @@ -408,7 +408,7 @@ public class PDFState { transform.concatenate(at); } - /** @see java.lang.Object#toString() */ + /** {@inheritDoc} */ public String toString() { return super.toString() + ", " + this.transform; } diff --git a/src/java/org/apache/fop/pdf/PDFStream.java b/src/java/org/apache/fop/pdf/PDFStream.java index 2cc9a1b0a..ac025da87 100644 --- a/src/java/org/apache/fop/pdf/PDFStream.java +++ b/src/java/org/apache/fop/pdf/PDFStream.java @@ -90,21 +90,21 @@ public class PDFStream extends AbstractPDFStream { } /** - * @see org.apache.fop.pdf.AbstractPDFStream#getSizeHint() + * {@inheritDoc} */ protected int getSizeHint() throws IOException { return data.getSize(); } /** - * @see org.apache.fop.pdf.AbstractPDFStream#outputRawStreamData(OutputStream) + * {@inheritDoc} */ protected void outputRawStreamData(OutputStream out) throws IOException { data.outputContents(out); } /** - * @see org.apache.fop.pdf.PDFObject#output(OutputStream) + * {@inheritDoc} */ protected int output(OutputStream stream) throws IOException { final int len = super.output(stream); diff --git a/src/java/org/apache/fop/pdf/PDFT1Stream.java b/src/java/org/apache/fop/pdf/PDFT1Stream.java index 58cbdf758..aca7e4f60 100644 --- a/src/java/org/apache/fop/pdf/PDFT1Stream.java +++ b/src/java/org/apache/fop/pdf/PDFT1Stream.java @@ -34,7 +34,7 @@ public class PDFT1Stream extends AbstractPDFStream { private PFBData pfb; /** - * @see org.apache.fop.pdf.AbstractPDFStream#getSizeHint() + * {@inheritDoc} */ protected int getSizeHint() throws IOException { if (this.pfb != null) { @@ -47,7 +47,7 @@ public class PDFT1Stream extends AbstractPDFStream { /** * Overload the base object method so we don't have to copy * byte arrays around so much - * @see org.apache.fop.pdf.PDFObject#output(OutputStream) + * {@inheritDoc} */ protected int output(java.io.OutputStream stream) throws java.io.IOException { @@ -62,7 +62,7 @@ public class PDFT1Stream extends AbstractPDFStream { } /** - * @see org.apache.fop.pdf.AbstractPDFStream#buildStreamDict(String) + * {@inheritDoc} */ protected String buildStreamDict(String lengthEntry) { final String filterEntry = getFilterList().buildFilterDictEntries(); @@ -76,7 +76,7 @@ public class PDFT1Stream extends AbstractPDFStream { } /** - * @see org.apache.fop.pdf.PDFStream#outputRawStreamData(OutputStream) + * {@inheritDoc} */ protected void outputRawStreamData(OutputStream out) throws IOException { this.pfb.outputAllParts(out); diff --git a/src/java/org/apache/fop/pdf/PDFTTFStream.java b/src/java/org/apache/fop/pdf/PDFTTFStream.java index a184f46c6..5176fac66 100644 --- a/src/java/org/apache/fop/pdf/PDFTTFStream.java +++ b/src/java/org/apache/fop/pdf/PDFTTFStream.java @@ -40,7 +40,7 @@ public class PDFTTFStream extends PDFStream { /** * Overload the base object method so we don't have to copy * byte arrays around so much - * @see org.apache.fop.pdf.PDFObject#output(OutputStream) + * {@inheritDoc} */ protected int output(java.io.OutputStream stream) throws java.io.IOException { @@ -52,7 +52,7 @@ public class PDFTTFStream extends PDFStream { } /** - * @see org.apache.fop.pdf.AbstractPDFStream#buildStreamDict(String) + * {@inheritDoc} */ protected String buildStreamDict(String lengthEntry) { final String filterEntry = getFilterList().buildFilterDictEntries(); diff --git a/src/java/org/apache/fop/pdf/PDFText.java b/src/java/org/apache/fop/pdf/PDFText.java index 2c001c671..4c17148c1 100644 --- a/src/java/org/apache/fop/pdf/PDFText.java +++ b/src/java/org/apache/fop/pdf/PDFText.java @@ -52,7 +52,7 @@ public class PDFText extends PDFObject { } /** - * @see org.apache.fop.pdf.PDFObject#toPDFString() + * {@inheritDoc} */ protected String toPDFString() { if (getText() == null) { diff --git a/src/java/org/apache/fop/pdf/PDFToUnicodeCMap.java b/src/java/org/apache/fop/pdf/PDFToUnicodeCMap.java index cacab3bab..ab3295a46 100644 --- a/src/java/org/apache/fop/pdf/PDFToUnicodeCMap.java +++ b/src/java/org/apache/fop/pdf/PDFToUnicodeCMap.java @@ -54,7 +54,7 @@ public class PDFToUnicodeCMap extends PDFCMap { cidFont = cidMetrics; } - /** @see org.apache.fop.pdf.PDFCMap#fillInPDF(java.lang.StringBuffer) */ + /** {@inheritDoc} */ public void fillInPDF(StringBuffer p) { writeCIDInit(p); writeCIDSystemInfo(p); @@ -65,7 +65,7 @@ public class PDFToUnicodeCMap extends PDFCMap { add(p.toString()); } - /** @see org.apache.fop.pdf.PDFCMap#writeCIDSystemInfo(java.lang.StringBuffer) */ + /** {@inheritDoc} */ protected void writeCIDSystemInfo(StringBuffer p) { p.append("/CIDSystemInfo\n"); p.append("<< /Registry (Adobe)\n"); @@ -74,7 +74,7 @@ public class PDFToUnicodeCMap extends PDFCMap { p.append(">> def\n"); } - /** @see org.apache.fop.pdf.PDFCMap#writeVersionTypeName(java.lang.StringBuffer) */ + /** {@inheritDoc} */ protected void writeVersionTypeName(StringBuffer p) { p.append("/CMapName /Adobe-Identity-UCS def\n"); p.append("/CMapType 2 def\n"); diff --git a/src/java/org/apache/fop/pdf/PDFUri.java b/src/java/org/apache/fop/pdf/PDFUri.java index b01b50834..19617e368 100644 --- a/src/java/org/apache/fop/pdf/PDFUri.java +++ b/src/java/org/apache/fop/pdf/PDFUri.java @@ -45,7 +45,7 @@ public class PDFUri extends PDFAction { } /** - * @see org.apache.fop.pdf.PDFObject#toPDFString() + * {@inheritDoc} */ public String toPDFString() { throw new UnsupportedOperationException("This method should not be called"); diff --git a/src/java/org/apache/fop/pdf/PDFXMode.java b/src/java/org/apache/fop/pdf/PDFXMode.java index 971ce0523..05df3e32a 100644 --- a/src/java/org/apache/fop/pdf/PDFXMode.java +++ b/src/java/org/apache/fop/pdf/PDFXMode.java @@ -55,7 +55,7 @@ public final class PDFXMode { } } - /** @see java.lang.Object#toString() */ + /** {@inheritDoc} */ public String toString() { return name; } diff --git a/src/java/org/apache/fop/pdf/PDFXObject.java b/src/java/org/apache/fop/pdf/PDFXObject.java index c0306e2bf..3e70e20c5 100644 --- a/src/java/org/apache/fop/pdf/PDFXObject.java +++ b/src/java/org/apache/fop/pdf/PDFXObject.java @@ -82,7 +82,7 @@ public class PDFXObject extends AbstractPDFStream { } /** - * @see org.apache.fop.pdf.AbstractPDFStream#buildStreamDict(String) + * {@inheritDoc} */ protected String buildStreamDict(String lengthEntry) { String dictEntries = getFilterList().buildFilterDictEntries(); @@ -164,21 +164,21 @@ public class PDFXObject extends AbstractPDFStream { } /** - * @see org.apache.fop.pdf.PDFStream#outputRawStreamData(OutputStream) + * {@inheritDoc} */ protected void outputRawStreamData(OutputStream out) throws IOException { pdfimage.outputContents(out); } /** - * @see org.apache.fop.pdf.AbstractPDFStream#getSizeHint() + * {@inheritDoc} */ protected int getSizeHint() throws IOException { return 0; } /** - * @see org.apache.fop.pdf.AbstractPDFStream#prepareImplicitFilters() + * {@inheritDoc} */ protected void prepareImplicitFilters() { PDFFilter pdfFilter = pdfimage.getPDFFilter(); @@ -190,7 +190,7 @@ public class PDFXObject extends AbstractPDFStream { /** * This sets up the default filters for XObjects. It uses the PDFImage * instance to determine what default filters to apply. - * @see org.apache.fop.pdf.AbstractPDFStream#setupFilterList() + * {@inheritDoc} */ protected void setupFilterList() { if (!getFilterList().isInitialized()) { diff --git a/src/java/org/apache/fop/pdf/TempFileStreamCache.java b/src/java/org/apache/fop/pdf/TempFileStreamCache.java index c5f09ed81..e29595989 100644 --- a/src/java/org/apache/fop/pdf/TempFileStreamCache.java +++ b/src/java/org/apache/fop/pdf/TempFileStreamCache.java @@ -70,7 +70,7 @@ public class TempFileStreamCache implements StreamCache { } /** - * @see org.apache.fop.pdf.StreamCache#write(byte[]) + * {@inheritDoc} */ public void write(byte[] data) throws IOException { getOutputStream().write(data); diff --git a/src/java/org/apache/fop/render/AbstractGenericSVGHandler.java b/src/java/org/apache/fop/render/AbstractGenericSVGHandler.java index 350ed3350..7d21d78c0 100644 --- a/src/java/org/apache/fop/render/AbstractGenericSVGHandler.java +++ b/src/java/org/apache/fop/render/AbstractGenericSVGHandler.java @@ -59,7 +59,7 @@ public abstract class AbstractGenericSVGHandler implements XMLHandler, RendererC /** logging instance */ private static Log log = LogFactory.getLog(AbstractGenericSVGHandler.class); - /** @see org.apache.fop.render.XMLHandler */ + /** {@inheritDoc} */ public void handleXML(RendererContext context, Document doc, String ns) throws Exception { @@ -123,7 +123,7 @@ public abstract class AbstractGenericSVGHandler implements XMLHandler, RendererC x, y, wrappedContext.getWidth(), wrappedContext.getHeight()); } - /** @see org.apache.fop.render.XMLHandler#getNamespace() */ + /** {@inheritDoc} */ public String getNamespace() { return SVGDOMImplementation.SVG_NAMESPACE_URI; } diff --git a/src/java/org/apache/fop/render/AbstractPathOrientedRenderer.java b/src/java/org/apache/fop/render/AbstractPathOrientedRenderer.java index 443d33bdb..4e5edece6 100644 --- a/src/java/org/apache/fop/render/AbstractPathOrientedRenderer.java +++ b/src/java/org/apache/fop/render/AbstractPathOrientedRenderer.java @@ -403,9 +403,7 @@ public abstract class AbstractPathOrientedRenderer extends PrintRenderer { } - /** - * @see org.apache.fop.render.AbstractRenderer#renderBlockViewport(BlockViewport, List) - */ + /** {@inheritDoc} */ protected void renderBlockViewport(BlockViewport bv, List children) { // clip and position viewport if necessary @@ -693,9 +691,7 @@ public abstract class AbstractPathOrientedRenderer extends PrintRenderer { protected abstract void drawBorderLine(float x1, float y1, float x2, float y2, boolean horz, boolean startOrBefore, int style, Color col); - /** - * @see org.apache.fop.render.AbstractRenderer#renderForeignObject(ForeignObject, Rectangle2D) - */ + /** {@inheritDoc} */ public void renderForeignObject(ForeignObject fo, Rectangle2D pos) { endTextObject(); Document doc = fo.getDocument(); diff --git a/src/java/org/apache/fop/render/AbstractRenderer.java b/src/java/org/apache/fop/render/AbstractRenderer.java index e2d314885..1fff79f77 100644 --- a/src/java/org/apache/fop/render/AbstractRenderer.java +++ b/src/java/org/apache/fop/render/AbstractRenderer.java @@ -113,29 +113,29 @@ public abstract class AbstractRenderer private Set warnedXMLHandlers; /** - * @see org.apache.fop.render.Renderer#setupFontInfo(FontInfo) + * {@inheritDoc} */ public abstract void setupFontInfo(FontInfo fontInfo); /** - * @see org.apache.fop.render.Renderer#setUserAgent(FOUserAgent) + * {@inheritDoc} */ public void setUserAgent(FOUserAgent agent) { userAgent = agent; } /** - * @see org.apache.fop.render.Renderer#getUserAgent() + * @return the associated <code>FOUserAgent</code> */ public FOUserAgent getUserAgent() { return userAgent; } - /** @see org.apache.fop.render.Renderer#startRenderer(OutputStream) */ + /** {@inheritDoc} */ public void startRenderer(OutputStream outputStream) throws IOException { } - /** @see org.apache.fop.render.Renderer#stopRenderer() */ + /** {@inheritDoc} */ public void stopRenderer() throws IOException { } @@ -145,23 +145,22 @@ public abstract class AbstractRenderer * not ready will be prepared and a future page will be rendered. * * @return True if the renderer supports out of order rendering - * @see org.apache.fop.render.Renderer */ public boolean supportsOutOfOrder() { return false; } /** - * @see org.apache.fop.render.Renderer#processOffDocumentItem(OffDocumentItem) + * {@inheritDoc} */ public void processOffDocumentItem(OffDocumentItem odi) { } - /** @see org.apache.fop.render.Renderer#getGraphics2DAdapter() */ + /** {@inheritDoc} */ public Graphics2DAdapter getGraphics2DAdapter() { return null; } - /** @see org.apache.fop.render.Renderer#getImageAdapter() */ + /** {@inheritDoc} */ public ImageAdapter getImageAdapter() { return null; } @@ -178,7 +177,7 @@ public abstract class AbstractRenderer * page should not be rendered. The page will be rendered at a later time * by the call to render page. * - * @see org.apache.fop.render.Renderer#preparePage(PageViewport) + * {@inheritDoc} */ public void preparePage(PageViewport page) { } @@ -215,14 +214,14 @@ public abstract class AbstractRenderer return sb.toString(); } - /** @see org.apache.fop.render.Renderer#startPageSequence(LineArea) */ + /** {@inheritDoc} */ public void startPageSequence(LineArea seqTitle) { //do nothing } // normally this would be overriden to create a page in the // output - /** @see org.apache.fop.render.Renderer#renderPage(PageViewport) */ + /** {@inheritDoc} */ public void renderPage(PageViewport page) throws IOException, FOPException { diff --git a/src/java/org/apache/fop/render/DefaultFontResolver.java b/src/java/org/apache/fop/render/DefaultFontResolver.java index 27d8a2356..d25328b9f 100644 --- a/src/java/org/apache/fop/render/DefaultFontResolver.java +++ b/src/java/org/apache/fop/render/DefaultFontResolver.java @@ -39,7 +39,7 @@ public class DefaultFontResolver implements FontResolver { this.userAgent = userAgent; } - /** @see org.apache.fop.fonts.FontResolver#resolve(java.lang.String) */ + /** {@inheritDoc} */ public Source resolve(String href) { return userAgent.resolveURI(href, userAgent.getFontBaseURL()); } diff --git a/src/java/org/apache/fop/render/afp/AFPGraphics2DAdapter.java b/src/java/org/apache/fop/render/afp/AFPGraphics2DAdapter.java index d86de33a3..8fa0d0f72 100644 --- a/src/java/org/apache/fop/render/afp/AFPGraphics2DAdapter.java +++ b/src/java/org/apache/fop/render/afp/AFPGraphics2DAdapter.java @@ -37,7 +37,7 @@ public class AFPGraphics2DAdapter extends AbstractGraphics2DAdapter { public AFPGraphics2DAdapter() { } - /** @see org.apache.fop.render.Graphics2DAdapter */ + /** {@inheritDoc} */ public void paintImage(Graphics2DImagePainter painter, RendererContext context, int x, int y, int width, int height) throws IOException { diff --git a/src/java/org/apache/fop/render/afp/AFPRenderer.java b/src/java/org/apache/fop/render/afp/AFPRenderer.java index ea1087893..d741a24f4 100644 --- a/src/java/org/apache/fop/render/afp/AFPRenderer.java +++ b/src/java/org/apache/fop/render/afp/AFPRenderer.java @@ -298,14 +298,14 @@ public class AFPRenderer extends AbstractPathOrientedRenderer { } /** - * @see org.apache.fop.render.Renderer#setUserAgent(FOUserAgent) + * {@inheritDoc} */ public void setUserAgent(FOUserAgent agent) { super.setUserAgent(agent); } /** - * @see org.apache.fop.render.Renderer#startRenderer(java.io.OutputStream) + * {@inheritDoc} */ public void startRenderer(OutputStream outputStream) throws IOException { _currentPageFonts = new HashMap(); @@ -317,14 +317,14 @@ public class AFPRenderer extends AbstractPathOrientedRenderer { } /** - * @see org.apache.fop.render.Renderer#stopRenderer() + * {@inheritDoc} */ public void stopRenderer() throws IOException { _afpDataStream.endDocument(); } /** - * @see org.apache.fop.render.Renderer#supportsOutOfOrder() + * {@inheritDoc} */ public boolean supportsOutOfOrder() { //return false; @@ -338,7 +338,7 @@ public class AFPRenderer extends AbstractPathOrientedRenderer { * page should not be rendered. The page will be rendered at a later time * by the call to render page. * - * @see org.apache.fop.render.Renderer#preparePage(PageViewport) + * {@inheritDoc} */ public void preparePage(PageViewport page) { // initializeRootExtensions(page); @@ -368,26 +368,26 @@ public class AFPRenderer extends AbstractPathOrientedRenderer { } /** - * @see org.apache.fop.render.Renderer#processOffDocumentItem(OffDocumentItem) + * {@inheritDoc} */ public void processOffDocumentItem(OffDocumentItem odi) { // TODO } - /** @see org.apache.fop.render.Renderer#getGraphics2DAdapter() */ + /** {@inheritDoc} */ public Graphics2DAdapter getGraphics2DAdapter() { return new AFPGraphics2DAdapter(); } /** - * @see org.apache.fop.render.AbstractRenderer#startVParea(CTM, Rectangle2D) + * {@inheritDoc} */ public void startVParea(CTM ctm, Rectangle2D clippingRect) { // dummy not used } /** - * @see org.apache.fop.render.AbstractRenderer#endVParea() + * {@inheritDoc} */ public void endVParea() { // dummy not used @@ -436,7 +436,7 @@ public class AFPRenderer extends AbstractPathOrientedRenderer { } /** - * @see org.apache.fop.render.AbstractRenderer#renderBlockViewport(BlockViewport, List) + * {@inheritDoc} */ protected void renderBlockViewport(BlockViewport bv, List children) { // clip and position viewport if necessary @@ -546,7 +546,7 @@ public class AFPRenderer extends AbstractPathOrientedRenderer { } /** - * @see org.apache.fop.render.Renderer#renderPage(PageViewport) + * {@inheritDoc} */ public void renderPage(PageViewport page) { @@ -602,50 +602,42 @@ public class AFPRenderer extends AbstractPathOrientedRenderer { } /** - * Clip using the current path. - * @see org.apache.fop.render.AbstractPathOrientedRenderer#clip + * {@inheritDoc} */ public void clip() { // TODO } /** - * Clip using a rectangular area. - * @see org.apache.fop.render.AbstractPathOrientedRenderer#clipRect(float, float, float, float) + * {@inheritDoc} */ public void clipRect(float x, float y, float width, float height) { // TODO } /** - * Moves the current point to (x, y), omitting any connecting line segment. - * @see org.apache.fop.render.AbstractPathOrientedRenderer#moveTo(float, float) + * {@inheritDoc} */ public void moveTo(float x, float y) { // TODO } /** - * Appends a straight line segment from the current point to (x, y). The - * new current point is (x, y). - * @see org.apache.fop.render.AbstractPathOrientedRenderer#lineTo(float, float) + * {@inheritDoc} */ public void lineTo(float x, float y) { // TODO } /** - * Closes the current subpath by appending a straight line segment from - * the current point to the starting point of the subpath. - * @see org.apache.fop.render.AbstractPathOrientedRenderer#closePath + * {@inheritDoc} */ public void closePath() { // TODO } /** - * Fill a rectangular area. - * @see org.apache.fop.render.AbstractPathOrientedRenderer#fillRect(float, float, float, float) + * {@inheritDoc} */ public void fillRect(float x, float y, float width, float height) { /* @@ -668,9 +660,7 @@ public class AFPRenderer extends AbstractPathOrientedRenderer { } /** - * Draw a border segment of an XSL-FO style border. - * @see org.apache.fop.render.AbstractPathOrientedRenderer#drawBorderLine(float, float, float, float, - * boolean, boolean, int, Color) + * {@inheritDoc} */ public void drawBorderLine(float x1, float y1, float x2, float y2, boolean horz, boolean startOrBefore, int style, Color col) { @@ -862,8 +852,7 @@ public class AFPRenderer extends AbstractPathOrientedRenderer { } /** - * @see org.apache.fop.render.PrintRenderer#createRendererContext( - * int, int, int, int, java.util.Map) + * {@inheritDoc} */ protected RendererContext createRendererContext(int x, int y, int width, int height, Map foreignAttributes) { RendererContext context; @@ -874,8 +863,7 @@ public class AFPRenderer extends AbstractPathOrientedRenderer { } /** - * Draw an image at the indicated location. - * @see org.apache.fop.render.AbstractPathOrientedRenderer#drawImage(String, Rectangle2D, Map) + * {@inheritDoc} */ public void drawImage(String url, Rectangle2D pos, Map foreignAttributes) { String name = null; @@ -1062,7 +1050,7 @@ public class AFPRenderer extends AbstractPathOrientedRenderer { /** * Establishes a new foreground or fill color. - * @see org.apache.fop.render.AbstractPathOrientedRenderer#updateColor(Color, boolean) + * {@inheritDoc} */ public void updateColor(Color col, boolean fill) { if (fill) { @@ -1107,7 +1095,7 @@ public class AFPRenderer extends AbstractPathOrientedRenderer { } /** - * @see org.apache.fop.render.AbstractRenderer#renderImage(Image, Rectangle2D) + * {@inheritDoc} */ public void renderImage(Image image, Rectangle2D pos) { String url = image.getURL(); @@ -1115,7 +1103,7 @@ public class AFPRenderer extends AbstractPathOrientedRenderer { } /** - * @see org.apache.fop.render.AbstractRenderer#renderText(TextArea) + * {@inheritDoc} */ public void renderText(TextArea text) { renderInlineAreaBackAndBorders(text); @@ -1195,7 +1183,7 @@ public class AFPRenderer extends AbstractPathOrientedRenderer { } /** - * @see org.apache.fop.render.AbstractRenderer#renderWord(WordArea) + * {@inheritDoc} */ public void renderWord(WordArea word) { String name = getInternalFontNameForArea(word.getParentArea()); @@ -1210,7 +1198,7 @@ public class AFPRenderer extends AbstractPathOrientedRenderer { } /** - * @see org.apache.fop.render.AbstractRenderer#renderSpace(SpaceArea) + * {@inheritDoc} */ public void renderSpace(SpaceArea space) { String name = getInternalFontNameForArea(space.getParentArea()); @@ -1257,7 +1245,8 @@ public class AFPRenderer extends AbstractPathOrientedRenderer { } /** - * @see org.apache.fop.render.Renderer#setOptions(Map) + * Sets the AFPRenderer options + * @param options the <code>Map</code> containing the options */ public void setOptions(Map options) { diff --git a/src/java/org/apache/fop/render/afp/AFPRendererMaker.java b/src/java/org/apache/fop/render/afp/AFPRendererMaker.java index 70bbe9076..d283d992a 100644 --- a/src/java/org/apache/fop/render/afp/AFPRendererMaker.java +++ b/src/java/org/apache/fop/render/afp/AFPRendererMaker.java @@ -35,22 +35,22 @@ public class AFPRendererMaker extends AbstractRendererMaker { MimeConstants.MIME_AFP_ALT}; - /**@see org.apache.fop.render.AbstractRendererMaker */ + /**{@inheritDoc} */ public Renderer makeRenderer(FOUserAgent userAgent) { return new AFPRenderer(); } - /** @see org.apache.fop.render.AbstractRendererMaker#getConfigurator(FOUserAgent) */ + /** {@inheritDoc} */ public RendererConfigurator getConfigurator(FOUserAgent userAgent) { return new AFPRendererConfigurator(userAgent); } - /** @see org.apache.fop.render.AbstractRendererMaker#needsOutputStream() */ + /** {@inheritDoc} */ public boolean needsOutputStream() { return true; } - /** @see org.apache.fop.render.AbstractRendererMaker#getSupportedMimeTypes() */ + /** {@inheritDoc} */ public String[] getSupportedMimeTypes() { return MIMES; } diff --git a/src/java/org/apache/fop/render/afp/AFPSVGHandler.java b/src/java/org/apache/fop/render/afp/AFPSVGHandler.java index e04169d9a..e216244c5 100644 --- a/src/java/org/apache/fop/render/afp/AFPSVGHandler.java +++ b/src/java/org/apache/fop/render/afp/AFPSVGHandler.java @@ -30,7 +30,7 @@ import org.apache.fop.render.Renderer; */ public class AFPSVGHandler extends AbstractGenericSVGHandler { - /** @see org.apache.fop.render.XMLHandler#supportsRenderer(org.apache.fop.render.Renderer) */ + /** {@inheritDoc} */ public boolean supportsRenderer(Renderer renderer) { return (renderer instanceof AFPRenderer); } diff --git a/src/java/org/apache/fop/render/afp/extensions/AFPElement.java b/src/java/org/apache/fop/render/afp/extensions/AFPElement.java index 8ee8cca42..60eea5ec8 100755 --- a/src/java/org/apache/fop/render/afp/extensions/AFPElement.java +++ b/src/java/org/apache/fop/render/afp/extensions/AFPElement.java @@ -42,17 +42,17 @@ public class AFPElement extends AbstractAFPExtensionObject { super(parent, name); } - /** @see org.apache.fop.fo.FONode#getNamespaceURI() */ + /** {@inheritDoc} */ public String getNamespaceURI() { return AFPElementMapping.NAMESPACE; } - /** @see org.apache.fop.fo.FONode#getNormalNamespacePrefix() */ + /** {@inheritDoc} */ public String getNormalNamespacePrefix() { return "afp"; } - /** @see org.apache.fop.fo.FONode#startOfNode() */ + /** {@inheritDoc} */ protected void startOfNode() throws FOPException { super.startOfNode(); //if (!AFPElementMapping.NAMESPACE.equals(parent.getNamespaceURI()) diff --git a/src/java/org/apache/fop/render/afp/extensions/AFPPageSetup.java b/src/java/org/apache/fop/render/afp/extensions/AFPPageSetup.java index 415d1656b..1538b5548 100644 --- a/src/java/org/apache/fop/render/afp/extensions/AFPPageSetup.java +++ b/src/java/org/apache/fop/render/afp/extensions/AFPPageSetup.java @@ -78,12 +78,12 @@ public class AFPPageSetup implements ExtensionAttachment, Serializable { this.value = source; } - /** @see org.apache.fop.fo.extensions.ExtensionAttachment#getCategory() */ + /** {@inheritDoc} */ public String getCategory() { return CATEGORY; } - /** @see java.lang.Object#toString() */ + /** {@inheritDoc} */ public String toString() { return "AFPPageSetup(element-name=" + getElementName() + " name=" + getName() + ")"; } diff --git a/src/java/org/apache/fop/render/afp/extensions/AFPPageSetupElement.java b/src/java/org/apache/fop/render/afp/extensions/AFPPageSetupElement.java index 3dc5860ab..4971928f8 100644 --- a/src/java/org/apache/fop/render/afp/extensions/AFPPageSetupElement.java +++ b/src/java/org/apache/fop/render/afp/extensions/AFPPageSetupElement.java @@ -37,7 +37,7 @@ public class AFPPageSetupElement extends AbstractAFPExtensionObject { super(parent, "page"); } - /** @see org.apache.fop.fo.FONode#startOfNode() */ + /** {@inheritDoc} */ protected void startOfNode() throws FOPException { super.startOfNode(); if (parent.getNameId() != Constants.FO_SIMPLE_PAGE_MASTER) { diff --git a/src/java/org/apache/fop/render/afp/extensions/AbstractAFPExtensionObject.java b/src/java/org/apache/fop/render/afp/extensions/AbstractAFPExtensionObject.java index 54bdc9fb0..482981060 100644 --- a/src/java/org/apache/fop/render/afp/extensions/AbstractAFPExtensionObject.java +++ b/src/java/org/apache/fop/render/afp/extensions/AbstractAFPExtensionObject.java @@ -49,7 +49,7 @@ public abstract class AbstractAFPExtensionObject extends FONode { } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) + * {@inheritDoc} String, String) * here, blocks XSL FO's from having non-FO parents. */ protected void validateChildNode(Locator loc, String nsURI, String localName) @@ -59,22 +59,22 @@ public abstract class AbstractAFPExtensionObject extends FONode { } } - /** @see org.apache.fop.fo.FONode */ + /** {@inheritDoc} */ protected void addCharacters(char[] data, int start, int length, PropertyList pList, Locator locator) { } - /** @see org.apache.fop.fo.FONode#getNamespaceURI() */ + /** {@inheritDoc} */ public String getNamespaceURI() { return AFPElementMapping.NAMESPACE; } - /**@see org.apache.fop.fo.FONode#getNormalNamespacePrefix() */ + /**{@inheritDoc} */ public String getNormalNamespacePrefix() { return AFPElementMapping.NAMESPACE_PREFIX; } - /** @see org.apache.fop.fo.FONode#processNode */ + /** {@inheritDoc} */ public void processNode(String elementName, Locator locator, Attributes attlist, PropertyList propertyList) throws FOPException { @@ -102,17 +102,17 @@ public abstract class AbstractAFPExtensionObject extends FONode { } } - /** @see org.apache.fop.fo.FONode#endOfNode() */ + /** {@inheritDoc} */ protected void endOfNode() throws FOPException { super.endOfNode(); } - /** @see org.apache.fop.fo.FONode#getExtensionAttachment() */ + /** {@inheritDoc} */ public ExtensionAttachment getExtensionAttachment() { return this.setupCode; } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return _name; } diff --git a/src/java/org/apache/fop/render/afp/fonts/AFPFontReader.java b/src/java/org/apache/fop/render/afp/fonts/AFPFontReader.java index ad3a04d06..970d11cbd 100644 --- a/src/java/org/apache/fop/render/afp/fonts/AFPFontReader.java +++ b/src/java/org/apache/fop/render/afp/fonts/AFPFontReader.java @@ -194,7 +194,7 @@ public final class AFPFontReader { log.warn(msg); } - inputStream = inputStream = csfont[0].toURL().openStream(); + inputStream = csfont[0].toURL().openStream(); if (inputStream == null) { String msg = "Failed to open character set resource " + characterset; diff --git a/src/java/org/apache/fop/render/afp/modca/AFPDataStream.java b/src/java/org/apache/fop/render/afp/modca/AFPDataStream.java index ebf74b1c1..06eb29c59 100644 --- a/src/java/org/apache/fop/render/afp/modca/AFPDataStream.java +++ b/src/java/org/apache/fop/render/afp/modca/AFPDataStream.java @@ -574,9 +574,6 @@ public class AFPDataStream { * Start a new page group. When processing has finished on the current page * group the {@link #endPageGroup()}method must be invoked to mark the page * group ending. - * - * @param name - * the name of the page group */ public void startPageGroup() { diff --git a/src/java/org/apache/fop/render/afp/modca/AbstractAFPObject.java b/src/java/org/apache/fop/render/afp/modca/AbstractAFPObject.java index 1720229d2..ef1b988c0 100644 --- a/src/java/org/apache/fop/render/afp/modca/AbstractAFPObject.java +++ b/src/java/org/apache/fop/render/afp/modca/AbstractAFPObject.java @@ -50,7 +50,7 @@ public abstract class AbstractAFPObject { /** * Help method to write a set of AFPObjects to the AFP datastream. - * @afpObjects a list of AFPObjects + * @param afpObjects a list of AFPObjects * @param os The stream to write to * @throws java.io.IOException */ diff --git a/src/java/org/apache/fop/render/afp/modca/ImageContent.java b/src/java/org/apache/fop/render/afp/modca/ImageContent.java index 3c242c7de..e6f9f1857 100644 --- a/src/java/org/apache/fop/render/afp/modca/ImageContent.java +++ b/src/java/org/apache/fop/render/afp/modca/ImageContent.java @@ -101,7 +101,7 @@ public class ImageContent extends AbstractAFPObject { /** * Sets the image IDE color model. - * @param size The IDE color model. + * @param colorModel the IDE color model. */ public void setImageIDEColorModel(byte colorModel) { _colorModel = colorModel; diff --git a/src/java/org/apache/fop/render/afp/modca/ImageObject.java b/src/java/org/apache/fop/render/afp/modca/ImageObject.java index ffb036380..909139ef3 100644 --- a/src/java/org/apache/fop/render/afp/modca/ImageObject.java +++ b/src/java/org/apache/fop/render/afp/modca/ImageObject.java @@ -125,7 +125,7 @@ public class ImageObject extends AbstractNamedAFPObject { /** * Sets the image IDE color model. - * @param size The IDE color model. + * @param colorModel the IDE color model. */ public void setImageIDEColorModel(byte colorModel) { if (_imageSegment == null) { diff --git a/src/java/org/apache/fop/render/afp/modca/ImageSegment.java b/src/java/org/apache/fop/render/afp/modca/ImageSegment.java index 435a70e1b..3b2e71552 100644 --- a/src/java/org/apache/fop/render/afp/modca/ImageSegment.java +++ b/src/java/org/apache/fop/render/afp/modca/ImageSegment.java @@ -143,7 +143,7 @@ public class ImageSegment extends AbstractAFPObject { /** * Sets the image IDE color model. - * @param size The IDE color model. + * @param colorModel the IDE color model. */ public void setImageIDEColorModel(byte colorModel) { if (_imageContent == null) { diff --git a/src/java/org/apache/fop/render/awt/AWTRenderer.java b/src/java/org/apache/fop/render/awt/AWTRenderer.java index e83d8d220..e646f9b9c 100644 --- a/src/java/org/apache/fop/render/awt/AWTRenderer.java +++ b/src/java/org/apache/fop/render/awt/AWTRenderer.java @@ -94,7 +94,7 @@ public class AWTRenderer extends Java2DRenderer implements Pageable { this.previewAsMainWindow = previewAsMainWindow; } - /** @see org.apache.fop.render.Renderer#setUserAgent(org.apache.fop.apps.FOUserAgent) */ + /** {@inheritDoc} */ public void setUserAgent(FOUserAgent foUserAgent) { super.setUserAgent(foUserAgent); if (dialogDisplay) { @@ -122,7 +122,7 @@ public class AWTRenderer extends Java2DRenderer implements Pageable { } /** - * @see org.apache.fop.render.Renderer#renderPage(org.apache.fop.area.PageViewport) + * {@inheritDoc} */ public void renderPage(PageViewport pageViewport) throws IOException { @@ -132,7 +132,7 @@ public class AWTRenderer extends Java2DRenderer implements Pageable { } } - /** @see org.apache.fop.render.Renderer#stopRenderer() */ + /** {@inheritDoc} */ public void stopRenderer() throws IOException { super.stopRenderer(); if (statusListener != null) { @@ -160,7 +160,7 @@ public class AWTRenderer extends Java2DRenderer implements Pageable { return new Dimension(bitmapWidth, bitmapHeight); } - /** @see java.awt.print.Pageable#getPageFormat(int) */ + /** {@inheritDoc} */ public PageFormat getPageFormat(int pageIndex) throws IndexOutOfBoundsException { try { @@ -194,18 +194,18 @@ public class AWTRenderer extends Java2DRenderer implements Pageable { } } - /** @see java.awt.print.Pageable#getPrintable(int) */ + /** {@inheritDoc} */ public Printable getPrintable(int pageIndex) throws IndexOutOfBoundsException { return this; } - /** @see org.apache.fop.render.Renderer */ + /** {@inheritDoc} */ public boolean supportsOutOfOrder() { return true; // TODO true? } - /** @see org.apache.fop.render.AbstractRenderer */ + /** {@inheritDoc} */ public String getMimeType() { return MIME_TYPE; } @@ -214,7 +214,7 @@ public class AWTRenderer extends Java2DRenderer implements Pageable { * Draws the background and borders and adds a basic debug view // TODO * implement visual-debugging as standalone * - * @see org.apache.fop.render.java2d.Java2DRenderer#drawBackAndBorders(org.apache.fop.area.Area, + * {@inheritDoc} * float, float, float, float) * * @param area the area to get the traits from diff --git a/src/java/org/apache/fop/render/awt/AWTRendererMaker.java b/src/java/org/apache/fop/render/awt/AWTRendererMaker.java index 8b74a8bfa..77bfd9166 100644 --- a/src/java/org/apache/fop/render/awt/AWTRendererMaker.java +++ b/src/java/org/apache/fop/render/awt/AWTRendererMaker.java @@ -32,17 +32,17 @@ public class AWTRendererMaker extends AbstractRendererMaker { private static final String[] MIMES = new String[] {MimeConstants.MIME_FOP_AWT_PREVIEW};
- /** @see org.apache.fop.render.AbstractRendererMaker */
+ /** {@inheritDoc} */
public Renderer makeRenderer(FOUserAgent ua) {
return new AWTRenderer();
}
- /** @see org.apache.fop.render.AbstractRendererMaker#needsOutputStream() */
+ /** {@inheritDoc} */
public boolean needsOutputStream() {
return false;
}
- /** @see org.apache.fop.render.AbstractRendererMaker#getSupportedMimeTypes() */
+ /** {@inheritDoc} */
public String[] getSupportedMimeTypes() {
return MIMES;
}
diff --git a/src/java/org/apache/fop/render/awt/viewer/Command.java b/src/java/org/apache/fop/render/awt/viewer/Command.java index b7872a1ed..a56527516 100644 --- a/src/java/org/apache/fop/render/awt/viewer/Command.java +++ b/src/java/org/apache/fop/render/awt/viewer/Command.java @@ -71,7 +71,7 @@ public class Command extends AbstractAction { } /** - * @see java.awt.event.ActionListener#actionPerformed(ActionEvent) + * {@inheritDoc} */ public void actionPerformed(ActionEvent e) { doit(); diff --git a/src/java/org/apache/fop/render/awt/viewer/PreviewDialog.java b/src/java/org/apache/fop/render/awt/viewer/PreviewDialog.java index 55f876422..ee220d629 100644 --- a/src/java/org/apache/fop/render/awt/viewer/PreviewDialog.java +++ b/src/java/org/apache/fop/render/awt/viewer/PreviewDialog.java @@ -445,7 +445,7 @@ public class PreviewDialog extends JFrame implements StatusListener { return menuBar; } - /** @see org.apache.fop.render.awt.viewer.StatusListener#notifyRendererStopped() */ + /** {@inheritDoc} */ public void notifyRendererStopped() { reload(); } diff --git a/src/java/org/apache/fop/render/awt/viewer/PreviewDialogAboutBox.java b/src/java/org/apache/fop/render/awt/viewer/PreviewDialogAboutBox.java index f6e8028aa..b76675179 100644 --- a/src/java/org/apache/fop/render/awt/viewer/PreviewDialogAboutBox.java +++ b/src/java/org/apache/fop/render/awt/viewer/PreviewDialogAboutBox.java @@ -94,7 +94,7 @@ public class PreviewDialogAboutBox extends Dialog implements ActionListener { } /** - * @see java.awt.Window#processWindowEvent(WindowEvent) + * {@inheritDoc} */ protected void processWindowEvent(WindowEvent e) { if (e.getID() == WindowEvent.WINDOW_CLOSING) { @@ -108,7 +108,7 @@ public class PreviewDialogAboutBox extends Dialog implements ActionListener { } /** - * @see java.awt.event.ActionListener#actionPerformed(ActionEvent) + * {@inheritDoc} */ public void actionPerformed(ActionEvent e) { if (e.getSource() == okButton) { diff --git a/src/java/org/apache/fop/render/bitmap/PNGRenderer.java b/src/java/org/apache/fop/render/bitmap/PNGRenderer.java index 67bee3a8b..bedd2c499 100644 --- a/src/java/org/apache/fop/render/bitmap/PNGRenderer.java +++ b/src/java/org/apache/fop/render/bitmap/PNGRenderer.java @@ -52,12 +52,12 @@ public class PNGRenderer extends Java2DRenderer { /** Helper class for generating multiple files */ private MultiFileRenderingUtil multiFileUtil; - /** @see org.apache.fop.render.AbstractRenderer */ + /** {@inheritDoc} */ public String getMimeType() { return MIME_TYPE; } - /** @see org.apache.fop.render.Renderer#startRenderer(java.io.OutputStream) */ + /** {@inheritDoc} */ public void startRenderer(OutputStream outputStream) throws IOException { log.info("rendering areas to PNG"); multiFileUtil = new MultiFileRenderingUtil(PNG_FILE_EXTENSION, @@ -65,7 +65,7 @@ public class PNGRenderer extends Java2DRenderer { this.firstOutputStream = outputStream; } - /** @see org.apache.fop.render.Renderer#stopRenderer() */ + /** {@inheritDoc} */ public void stopRenderer() throws IOException { super.stopRenderer(); diff --git a/src/java/org/apache/fop/render/bitmap/PNGRendererMaker.java b/src/java/org/apache/fop/render/bitmap/PNGRendererMaker.java index 5fe35b667..6ef9e4a82 100644 --- a/src/java/org/apache/fop/render/bitmap/PNGRendererMaker.java +++ b/src/java/org/apache/fop/render/bitmap/PNGRendererMaker.java @@ -32,17 +32,17 @@ public class PNGRendererMaker extends AbstractRendererMaker { private static final String[] MIMES = new String[] {MimeConstants.MIME_PNG};
- /** @see org.apache.fop.render.AbstractRendererMaker */
+ /** {@inheritDoc} */
public Renderer makeRenderer(FOUserAgent ua) {
return new PNGRenderer();
}
- /** @see org.apache.fop.render.AbstractRendererMaker#needsOutputStream() */
+ /** {@inheritDoc} */
public boolean needsOutputStream() {
return true;
}
- /** @see org.apache.fop.render.AbstractRendererMaker#getSupportedMimeTypes() */
+ /** {@inheritDoc} */
public String[] getSupportedMimeTypes() {
return MIMES;
}
diff --git a/src/java/org/apache/fop/render/bitmap/PNGRenderer_onthefly.java b/src/java/org/apache/fop/render/bitmap/PNGRenderer_onthefly.java index e02c015ae..36dd093b2 100644 --- a/src/java/org/apache/fop/render/bitmap/PNGRenderer_onthefly.java +++ b/src/java/org/apache/fop/render/bitmap/PNGRenderer_onthefly.java @@ -58,17 +58,17 @@ public class PNGRenderer_onthefly extends Java2DRenderer { /** The OutputStream for the first Image */ private OutputStream firstOutputStream; - /** @see org.apache.fop.render.AbstractRenderer */ + /** {@inheritDoc} */ public String getMimeType() { return MIME_TYPE; } - /** @see org.apache.fop.render.Renderer#supportsOutOfOrder() */ + /** {@inheritDoc} */ public boolean supportsOutOfOrder() { return true; } - /** @see org.apache.fop.render.Renderer#startRenderer(java.io.OutputStream) */ + /** {@inheritDoc} */ public void startRenderer(OutputStream outputStream) throws IOException { log.info("rendering areas to PNG"); setOutputDirectory(); @@ -97,7 +97,7 @@ public class PNGRenderer_onthefly extends Java2DRenderer { } /** - * @see org.apache.fop.render.Renderer#renderPage(org.apache.fop.area.PageViewport) + * {@inheritDoc} */ public void renderPage(PageViewport pageViewport) throws IOException { diff --git a/src/java/org/apache/fop/render/bitmap/TIFFRenderer.java b/src/java/org/apache/fop/render/bitmap/TIFFRenderer.java index 5c22c8f34..4f64e45e1 100644 --- a/src/java/org/apache/fop/render/bitmap/TIFFRenderer.java +++ b/src/java/org/apache/fop/render/bitmap/TIFFRenderer.java @@ -89,7 +89,7 @@ public class TIFFRenderer extends Java2DRenderer { private OutputStream outputStream; - /** @see org.apache.fop.render.AbstractRenderer */ + /** {@inheritDoc} */ public String getMimeType() { return MIME_TYPE; } @@ -101,7 +101,7 @@ public class TIFFRenderer extends Java2DRenderer { } /** - * @see org.apache.fop.render.java2d.Java2DRenderer#setUserAgent( + * {@inheritDoc} * org.apache.fop.apps.FOUserAgent) */ public void setUserAgent(FOUserAgent foUserAgent) { @@ -112,13 +112,13 @@ public class TIFFRenderer extends Java2DRenderer { writerParams.setResolution(dpi); } - /** @see org.apache.fop.render.Renderer#startRenderer(java.io.OutputStream) */ + /** {@inheritDoc} */ public void startRenderer(OutputStream outputStream) throws IOException { this.outputStream = outputStream; super.startRenderer(outputStream); } - /** @see org.apache.fop.render.Renderer#stopRenderer() */ + /** {@inheritDoc} */ public void stopRenderer() throws IOException { super.stopRenderer(); log.debug("Starting TIFF encoding ..."); @@ -156,7 +156,7 @@ public class TIFFRenderer extends Java2DRenderer { log.debug("TIFF encoding done."); } - /** @see org.apache.fop.render.java2d.Java2DRenderer#getBufferedImage(int, int) */ + /** {@inheritDoc} */ protected BufferedImage getBufferedImage(int bitmapWidth, int bitmapHeight) { return new BufferedImage(bitmapWidth, bitmapHeight, bufferedImageType); } diff --git a/src/java/org/apache/fop/render/bitmap/TIFFRendererConfigurator.java b/src/java/org/apache/fop/render/bitmap/TIFFRendererConfigurator.java index 2e4e29691..41b05ecd7 100644 --- a/src/java/org/apache/fop/render/bitmap/TIFFRendererConfigurator.java +++ b/src/java/org/apache/fop/render/bitmap/TIFFRendererConfigurator.java @@ -45,7 +45,7 @@ public class TIFFRendererConfigurator extends PrintRendererConfigurator { * compression * @param renderer tiff renderer * @throws FOPException fop exception - * @see org.apache.fop.render.PrintRendererConfigurator#configure(Renderer) + * {@inheritDoc} */ public void configure(Renderer renderer) throws FOPException { Configuration cfg = super.getRendererConfig(renderer); diff --git a/src/java/org/apache/fop/render/bitmap/TIFFRendererMaker.java b/src/java/org/apache/fop/render/bitmap/TIFFRendererMaker.java index 5e9f18261..09af92b05 100644 --- a/src/java/org/apache/fop/render/bitmap/TIFFRendererMaker.java +++ b/src/java/org/apache/fop/render/bitmap/TIFFRendererMaker.java @@ -32,22 +32,22 @@ public class TIFFRendererMaker extends AbstractRendererMaker { private static final String[] MIMES = new String[] {MimeConstants.MIME_TIFF};
- /** @see org.apache.fop.render.AbstractRendererMaker#makeRenderer(FOUserAgent) */
+ /** {@inheritDoc} */
public Renderer makeRenderer(FOUserAgent userAgent) {
return new TIFFRenderer();
}
- /** @see org.apache.fop.render.AbstractRendererMaker#getConfigurator(FOUserAgent) */
+ /** {@inheritDoc} */
public RendererConfigurator getConfigurator(FOUserAgent userAgent) {
return new TIFFRendererConfigurator(userAgent);
}
- /** @see org.apache.fop.render.AbstractRendererMaker#needsOutputStream() */
+ /** {@inheritDoc} */
public boolean needsOutputStream() {
return true;
}
- /** @see org.apache.fop.render.AbstractRendererMaker#getSupportedMimeTypes() */
+ /** {@inheritDoc} */
public String[] getSupportedMimeTypes() {
return MIMES;
}
diff --git a/src/java/org/apache/fop/render/java2d/FontMetricsMapper.java b/src/java/org/apache/fop/render/java2d/FontMetricsMapper.java index 249b1d832..67476b46a 100644 --- a/src/java/org/apache/fop/render/java2d/FontMetricsMapper.java +++ b/src/java/org/apache/fop/render/java2d/FontMetricsMapper.java @@ -73,56 +73,56 @@ public class FontMetricsMapper extends Typeface implements FontMetrics { } /** - * @see org.apache.fop.fonts.FontMetrics#getFontName() + * {@inheritDoc} */ public String getFontName() { return family; } /** - * @see org.apache.fop.fonts.FontMetrics#getFontType() + * {@inheritDoc} */ public FontType getFontType() { return FontType.OTHER; } /** - * @see org.apache.fop.fonts.FontMetrics#getMaxAscent(int) + * {@inheritDoc} */ public int getMaxAscent(int size) { return metric.getMaxAscent(family, style, size); } /** - * @see org.apache.fop.fonts.FontMetrics#getAscender(int) + * {@inheritDoc} */ public int getAscender(int size) { return metric.getAscender(family, style, size); } /** - * @see org.apache.fop.fonts.FontMetrics#getCapHeight(int) + * {@inheritDoc} */ public int getCapHeight(int size) { return metric.getCapHeight(family, style, size); } /** - * @see org.apache.fop.fonts.FontMetrics#getDescender(int) + * {@inheritDoc} */ public int getDescender(int size) { return metric.getDescender(family, style, size); } /** - * @see org.apache.fop.fonts.FontMetrics#getXHeight(int) + * {@inheritDoc} */ public int getXHeight(int size) { return metric.getXHeight(family, style, size); } /** - * @see org.apache.fop.fonts.FontMetrics#getWidth(int, int) + * {@inheritDoc} */ public int getWidth(int i, int size) { return metric.width(i, family, style, size); @@ -130,7 +130,7 @@ public class FontMetricsMapper extends Typeface implements FontMetrics { /** - * @see org.apache.fop.fonts.FontMetrics#getWidths() + * {@inheritDoc} */ public int[] getWidths() { return metric.getWidths(family, style, Java2DFontMetrics.FONT_SIZE); @@ -147,30 +147,30 @@ public class FontMetricsMapper extends Typeface implements FontMetrics { } /** - * @see org.apache.fop.fonts.FontMetrics#getKerningInfo() + * {@inheritDoc} */ public Map getKerningInfo() { return java.util.Collections.EMPTY_MAP; } /** - * @see org.apache.fop.fonts.FontMetrics#hasKerningInfo() + * {@inheritDoc} */ public boolean hasKerningInfo() { return false; } - /** @see org.apache.fop.fonts.Typeface#getEncoding() */ + /** {@inheritDoc} */ public String getEncoding() { return null; //Not applicable to Java2D rendering } - /** @see org.apache.fop.fonts.Typeface#mapChar(char) */ + /** {@inheritDoc} */ public char mapChar(char c) { return c; } - /** @see org.apache.fop.fonts.Typeface#hasChar(char) */ + /** {@inheritDoc} */ public boolean hasChar(char c) { return metric.hasChar(family, style, Java2DFontMetrics.FONT_SIZE, c); } diff --git a/src/java/org/apache/fop/render/java2d/Java2DGraphics2DAdapter.java b/src/java/org/apache/fop/render/java2d/Java2DGraphics2DAdapter.java index 050a249fd..f74df6cff 100644 --- a/src/java/org/apache/fop/render/java2d/Java2DGraphics2DAdapter.java +++ b/src/java/org/apache/fop/render/java2d/Java2DGraphics2DAdapter.java @@ -44,7 +44,7 @@ public class Java2DGraphics2DAdapter implements Graphics2DAdapter { this.state = state;
}
- /** @see org.apache.fop.render.Graphics2DAdapter */
+ /** {@inheritDoc} */
public void paintImage(Graphics2DImagePainter painter,
RendererContext context,
int x, int y, int width, int height) throws IOException {
diff --git a/src/java/org/apache/fop/render/java2d/Java2DGraphicsState.java b/src/java/org/apache/fop/render/java2d/Java2DGraphicsState.java index a24bdfbde..31da90c95 100644 --- a/src/java/org/apache/fop/render/java2d/Java2DGraphicsState.java +++ b/src/java/org/apache/fop/render/java2d/Java2DGraphicsState.java @@ -250,7 +250,7 @@ public class Java2DGraphicsState { /** * Composes an AffineTransform object with the Transform in this Graphics2D * according to the rule last-specified-first-applied. - * @see java.awt.Graphics2D#transform(AffineTransform tf). + * @see java.awt.Graphics2D#transform(AffineTransform) * * @param tf the transform to concatonate to the current level transform */ @@ -268,7 +268,7 @@ public class Java2DGraphicsState { return getGraph().getTransform(); } - /** @see java.lang.Object#toString() */ + /** {@inheritDoc} */ public String toString() { String s = "AWTGraphicsState " + currentGraphics.toString() + ", Stroke (width: " + currentStrokeWidth + " style: " diff --git a/src/java/org/apache/fop/render/java2d/Java2DRenderer.java b/src/java/org/apache/fop/render/java2d/Java2DRenderer.java index 7d837e699..aa9b0337a 100644 --- a/src/java/org/apache/fop/render/java2d/Java2DRenderer.java +++ b/src/java/org/apache/fop/render/java2d/Java2DRenderer.java @@ -149,7 +149,7 @@ public abstract class Java2DRenderer extends AbstractPathOrientedRenderer implem } /** - * @see org.apache.fop.render.Renderer#setUserAgent(org.apache.fop.apps.FOUserAgent) + * {@inheritDoc} */ public void setUserAgent(FOUserAgent foUserAgent) { super.setUserAgent(foUserAgent); @@ -167,7 +167,7 @@ public abstract class Java2DRenderer extends AbstractPathOrientedRenderer implem } /** - * @see org.apache.fop.render.Renderer#setupFontInfo(org.apache.fop.fonts.FontInfo) + * {@inheritDoc} */ public void setupFontInfo(FontInfo inFontInfo) { //Don't call super.setupFontInfo() here! Java2D needs a special font setup @@ -182,7 +182,7 @@ public abstract class Java2DRenderer extends AbstractPathOrientedRenderer implem FontSetup.setup(fontInfo, g); } - /** @see org.apache.fop.render.Renderer#getGraphics2DAdapter() */ + /** {@inheritDoc} */ public Graphics2DAdapter getGraphics2DAdapter() { return new Java2DGraphics2DAdapter(state); } @@ -200,12 +200,12 @@ public abstract class Java2DRenderer extends AbstractPathOrientedRenderer implem return scaleFactor; } - /** @see org.apache.fop.render.Renderer#startRenderer(java.io.OutputStream) */ + /** {@inheritDoc} */ public void startRenderer(OutputStream out) throws IOException { // do nothing by default } - /** @see org.apache.fop.render.Renderer#stopRenderer() */ + /** {@inheritDoc} */ public void stopRenderer() throws IOException { log.debug("Java2DRenderer stopped"); renderingDone = true; @@ -403,7 +403,7 @@ public abstract class Java2DRenderer extends AbstractPathOrientedRenderer implem } /** - * @see org.apache.fop.render.AbstractRenderer#startVParea(CTM, Rectangle2D) + * {@inheritDoc} */ protected void startVParea(CTM ctm, Rectangle2D clippingRect) { @@ -422,14 +422,14 @@ public abstract class Java2DRenderer extends AbstractPathOrientedRenderer implem } /** - * @see org.apache.fop.render.AbstractRenderer#endVParea() + * {@inheritDoc} */ protected void endVParea() { restoreGraphicsState(); } /** - * @see org.apache.fop.render.AbstractPathOrientedRenderer#breakOutOfStateStack() + * {@inheritDoc} */ protected List breakOutOfStateStack() { log.debug("Block.FIXED --> break out"); @@ -444,7 +444,7 @@ public abstract class Java2DRenderer extends AbstractPathOrientedRenderer implem } /** - * @see org.apache.fop.render.AbstractPathOrientedRenderer#restoreStateStackAfterBreakOut( + * {@inheritDoc} * java.util.List) */ protected void restoreStateStackAfterBreakOut(List breakOutList) { @@ -459,14 +459,14 @@ public abstract class Java2DRenderer extends AbstractPathOrientedRenderer implem } /** - * @see org.apache.fop.render.AbstractPathOrientedRenderer#updateColor(Color, boolean) + * {@inheritDoc} */ protected void updateColor(Color col, boolean fill) { state.updateColor(col); } /** - * @see org.apache.fop.render.AbstractPathOrientedRenderer#clip() + * {@inheritDoc} */ protected void clip() { if (currentPath == null) { @@ -477,14 +477,14 @@ public abstract class Java2DRenderer extends AbstractPathOrientedRenderer implem } /** - * @see org.apache.fop.render.AbstractPathOrientedRenderer#closePath() + * {@inheritDoc} */ protected void closePath() { currentPath.closePath(); } /** - * @see org.apache.fop.render.AbstractPathOrientedRenderer#lineTo(float, float) + * {@inheritDoc} */ protected void lineTo(float x, float y) { if (currentPath == null) { @@ -494,7 +494,7 @@ public abstract class Java2DRenderer extends AbstractPathOrientedRenderer implem } /** - * @see org.apache.fop.render.AbstractPathOrientedRenderer#moveTo(float, float) + * {@inheritDoc} */ protected void moveTo(float x, float y) { if (currentPath == null) { @@ -504,21 +504,21 @@ public abstract class Java2DRenderer extends AbstractPathOrientedRenderer implem } /** - * @see org.apache.fop.render.AbstractPathOrientedRenderer#clipRect(float, float, float, float) + * {@inheritDoc} */ protected void clipRect(float x, float y, float width, float height) { state.updateClip(new Rectangle2D.Float(x, y, width, height)); } /** - * @see org.apache.fop.render.AbstractPathOrientedRenderer#fillRect(float, float, float, float) + * {@inheritDoc} */ protected void fillRect(float x, float y, float width, float height) { state.getGraph().fill(new Rectangle2D.Float(x, y, width, height)); } /** - * @see org.apache.fop.render.AbstractPathOrientedRenderer#drawBorderLine(float, float, float, float, boolean, boolean, int, Color) + * {@inheritDoc} */ protected void drawBorderLine(float x1, float y1, float x2, float y2, boolean horz, boolean startOrBefore, int style, Color col) { @@ -689,7 +689,7 @@ public abstract class Java2DRenderer extends AbstractPathOrientedRenderer implem } /** - * @see org.apache.fop.render.AbstractRenderer#renderText(TextArea) + * {@inheritDoc} */ public void renderText(TextArea text) { renderInlineAreaBackAndBorders(text); @@ -873,8 +873,7 @@ public abstract class Java2DRenderer extends AbstractPathOrientedRenderer implem } /** - * @see org.apache.fop.render.AbstractRenderer#renderImage(Image, - * Rectangle2D) + * {@inheritDoc} */ public void renderImage(Image image, Rectangle2D pos) { // endTextObject(); @@ -883,8 +882,7 @@ public abstract class Java2DRenderer extends AbstractPathOrientedRenderer implem } /** - * @see org.apache.fop.render.AbstractPathOrientedRenderer#drawImage( - * java.lang.String, java.awt.geom.Rectangle2D, java.util.Map) + * {@inheritDoc} */ protected void drawImage(String url, Rectangle2D pos, Map foreignAttributes) { @@ -954,8 +952,7 @@ public abstract class Java2DRenderer extends AbstractPathOrientedRenderer implem } /** - * @see org.apache.fop.render.PrintRenderer#createRendererContext( - * int, int, int, int, java.util.Map) + * {@inheritDoc} */ protected RendererContext createRendererContext(int x, int y, int width, int height, Map foreignAttributes) { @@ -966,8 +963,7 @@ public abstract class Java2DRenderer extends AbstractPathOrientedRenderer implem } /** - * @see java.awt.print.Printable#print(java.awt.Graphics, - * java.awt.print.PageFormat, int) + * {@inheritDoc} */ public int print(Graphics g, PageFormat pageFormat, int pageIndex) throws PrinterException { @@ -998,12 +994,12 @@ public abstract class Java2DRenderer extends AbstractPathOrientedRenderer implem } } - /** @see org.apache.fop.render.AbstractPathOrientedRenderer#beginTextObject() */ + /** {@inheritDoc} */ protected void beginTextObject() { //not necessary in Java2D } - /** @see org.apache.fop.render.AbstractPathOrientedRenderer#endTextObject() */ + /** {@inheritDoc} */ protected void endTextObject() { //not necessary in Java2D } diff --git a/src/java/org/apache/fop/render/java2d/Java2DSVGHandler.java b/src/java/org/apache/fop/render/java2d/Java2DSVGHandler.java index 3b20ebd23..51b458cfe 100644 --- a/src/java/org/apache/fop/render/java2d/Java2DSVGHandler.java +++ b/src/java/org/apache/fop/render/java2d/Java2DSVGHandler.java @@ -54,7 +54,7 @@ public class Java2DSVGHandler implements XMLHandler, Java2DRendererContextConsta //nop } - /** @see org.apache.fop.render.XMLHandler */ + /** {@inheritDoc} */ public void handleXML(RendererContext context, Document doc, String ns) throws Exception { Java2DInfo pdfi = getJava2DInfo(context); @@ -95,7 +95,7 @@ public class Java2DSVGHandler implements XMLHandler, Java2DRendererContextConsta /** see Java2D_YPOS */ public int currentYPosition; - /** @see java.lang.Object#toString() */ + /** {@inheritDoc} */ public String toString() { return "Java2DInfo {" + "state = " + state + ", " @@ -164,13 +164,13 @@ public class Java2DSVGHandler implements XMLHandler, Java2DRendererContextConsta info.state.getGraph().setTransform(origTransform); } - /** @see org.apache.fop.render.XMLHandler#supportsRenderer(Renderer) */ + /** {@inheritDoc} */ public boolean supportsRenderer(Renderer renderer) { return (renderer instanceof Java2DRenderer); } - /** @see org.apache.fop.render.XMLHandler#getNamespace() */ + /** {@inheritDoc} */ public String getNamespace() { return SVGDOMImplementation.SVG_NAMESPACE_URI; } diff --git a/src/java/org/apache/fop/render/pcl/DefaultMonochromeBitmapConverter.java b/src/java/org/apache/fop/render/pcl/DefaultMonochromeBitmapConverter.java index ee46706c4..10fcfde3d 100644 --- a/src/java/org/apache/fop/render/pcl/DefaultMonochromeBitmapConverter.java +++ b/src/java/org/apache/fop/render/pcl/DefaultMonochromeBitmapConverter.java @@ -32,12 +32,12 @@ import java.awt.image.RenderedImage; public class DefaultMonochromeBitmapConverter implements MonochromeBitmapConverter { - /** @see MonochromeBitmapConverter#setHint(java.lang.String, java.lang.String) */ + /** {@inheritDoc} */ public void setHint(String name, String value) { //ignore, not supported } - /** @see MonochromeBitmapConverter#convertToMonochrome(java.awt.image.BufferedImage) */ + /** {@inheritDoc} */ public RenderedImage convertToMonochrome(BufferedImage img) { BufferedImage buf = new BufferedImage(img.getWidth(), img.getHeight(), BufferedImage.TYPE_BYTE_BINARY); diff --git a/src/java/org/apache/fop/render/pcl/JAIMonochromeBitmapConverter.java b/src/java/org/apache/fop/render/pcl/JAIMonochromeBitmapConverter.java index ff3fb0b74..89e54b917 100644 --- a/src/java/org/apache/fop/render/pcl/JAIMonochromeBitmapConverter.java +++ b/src/java/org/apache/fop/render/pcl/JAIMonochromeBitmapConverter.java @@ -47,14 +47,14 @@ public class JAIMonochromeBitmapConverter implements private boolean isErrorDiffusion = false; - /** @see MonochromeBitmapConverter#setHint(java.lang.String, java.lang.String) */ + /** {@inheritDoc} */ public void setHint(String name, String value) { if ("quality".equalsIgnoreCase(name)) { isErrorDiffusion = "true".equalsIgnoreCase(value); } } - /** @see MonochromeBitmapConverter#convertToMonochrome(java.awt.image.BufferedImage) */ + /** {@inheritDoc} */ public RenderedImage convertToMonochrome(BufferedImage img) { if (img.getColorModel().getColorSpace().getNumComponents() != 1) { throw new IllegalArgumentException("Source image must be a grayscale image!"); diff --git a/src/java/org/apache/fop/render/pcl/PCLGraphics2D.java b/src/java/org/apache/fop/render/pcl/PCLGraphics2D.java index 825a29bd3..ef777e20a 100644 --- a/src/java/org/apache/fop/render/pcl/PCLGraphics2D.java +++ b/src/java/org/apache/fop/render/pcl/PCLGraphics2D.java @@ -76,14 +76,14 @@ public class PCLGraphics2D extends AbstractGraphics2D { this.gen = g.gen; } - /** @see java.awt.Graphics#create() */ + /** {@inheritDoc} */ public Graphics create() { PCLGraphics2D copy = new PCLGraphics2D(this); copy.setGraphicContext((GraphicContext)getGraphicContext().clone()); return copy; } - /** @see java.awt.Graphics#dispose() */ + /** {@inheritDoc} */ public void dispose() { this.gen = null; } @@ -125,7 +125,7 @@ public class PCLGraphics2D extends AbstractGraphics2D { } } - /** @see java.awt.Graphics2D#getDeviceConfiguration() */ + /** {@inheritDoc} */ public GraphicsConfiguration getDeviceConfiguration() { return GraphicsEnvironment.getLocalGraphicsEnvironment(). getDefaultScreenDevice().getDefaultConfiguration(); @@ -262,7 +262,7 @@ public class PCLGraphics2D extends AbstractGraphics2D { } } - /** @see java.awt.Graphics2D#draw(java.awt.Shape) */ + /** {@inheritDoc} */ public void draw(Shape s) { try { AffineTransform trans = getTransform(); @@ -284,7 +284,7 @@ public class PCLGraphics2D extends AbstractGraphics2D { } } - /** @see java.awt.Graphics2D#fill(java.awt.Shape) */ + /** {@inheritDoc} */ public void fill(Shape s) { try { AffineTransform trans = getTransform(); @@ -482,7 +482,7 @@ public class PCLGraphics2D extends AbstractGraphics2D { sb.append("PU;"); } - /** @see java.awt.Graphics2D#drawString(java.lang.String, float, float) */ + /** {@inheritDoc} */ public void drawString(String s, float x, float y) { java.awt.Font awtFont = getFont(); FontRenderContext frc = getFontRenderContext(); @@ -491,42 +491,31 @@ public class PCLGraphics2D extends AbstractGraphics2D { fill(glyphOutline); } - /** @see java.awt.Graphics2D#drawString(java.text.AttributedCharacterIterator, float, float) */ + /** {@inheritDoc} */ public void drawString(AttributedCharacterIterator iterator, float x, float y) { // TODO Auto-generated method stub handleUnsupportedFeature("drawString NYI"); } - /** - * @see java.awt.Graphics2D#drawRenderedImage(java.awt.image.RenderedImage, - * java.awt.geom.AffineTransform) - */ + /** {@inheritDoc} */ public void drawRenderedImage(RenderedImage img, AffineTransform xform) { handleUnsupportedFeature("Bitmap images are not supported"); } - /** - * @see java.awt.Graphics2D#drawRenderableImage(java.awt.image.renderable.RenderableImage, - * java.awt.geom.AffineTransform) - */ + /** {@inheritDoc} */ public void drawRenderableImage(RenderableImage img, AffineTransform xform) { handleUnsupportedFeature("Bitmap images are not supported"); } - /** - * @see java.awt.Graphics#drawImage(java.awt.Image, int, int, int, int, - * java.awt.image.ImageObserver) - */ + /** {@inheritDoc} */ public boolean drawImage(Image img, int x, int y, int width, int height, ImageObserver observer) { handleUnsupportedFeature("Bitmap images are not supported"); return false; } - /** - * @see java.awt.Graphics#drawImage(java.awt.Image, int, int, java.awt.image.ImageObserver) - */ + /** {@inheritDoc} */ public boolean drawImage(Image img, int x, int y, ImageObserver observer) { handleUnsupportedFeature("Bitmap images are not supported"); return false; @@ -574,13 +563,13 @@ public class PCLGraphics2D extends AbstractGraphics2D { return true;*/ } - /** @see java.awt.Graphics#copyArea(int, int, int, int, int, int) */ + /** {@inheritDoc} */ public void copyArea(int x, int y, int width, int height, int dx, int dy) { // TODO Auto-generated method stub handleUnsupportedFeature("copyArea NYI"); } - /** @see java.awt.Graphics#setXORMode(java.awt.Color) */ + /** {@inheritDoc} */ public void setXORMode(Color c1) { // TODO Auto-generated method stub handleUnsupportedFeature("setXORMode NYI"); @@ -608,7 +597,7 @@ public class PCLGraphics2D extends AbstractGraphics2D { BufferedImage.TYPE_BYTE_GRAY); } - /** @see java.awt.Graphics#getFontMetrics(java.awt.Font) */ + /** {@inheritDoc} */ public java.awt.FontMetrics getFontMetrics(java.awt.Font f) { return fmg.getFontMetrics(f); } diff --git a/src/java/org/apache/fop/render/pcl/PCLGraphics2DAdapter.java b/src/java/org/apache/fop/render/pcl/PCLGraphics2DAdapter.java index 106417ab9..80c010afc 100644 --- a/src/java/org/apache/fop/render/pcl/PCLGraphics2DAdapter.java +++ b/src/java/org/apache/fop/render/pcl/PCLGraphics2DAdapter.java @@ -48,7 +48,7 @@ public class PCLGraphics2DAdapter extends AbstractGraphics2DAdapter { public PCLGraphics2DAdapter() { } - /** @see org.apache.fop.render.Graphics2DAdapter */ + /** {@inheritDoc} */ public void paintImage(Graphics2DImagePainter painter, RendererContext context, int x, int y, int width, int height) throws IOException { diff --git a/src/java/org/apache/fop/render/pcl/PCLPageDefinition.java b/src/java/org/apache/fop/render/pcl/PCLPageDefinition.java index dc5d5fd32..ebff61f0f 100644 --- a/src/java/org/apache/fop/render/pcl/PCLPageDefinition.java +++ b/src/java/org/apache/fop/render/pcl/PCLPageDefinition.java @@ -91,7 +91,7 @@ public class PCLPageDefinition { && (Math.abs(this.physicalPageSize.height - height) < errorMargin); } - /** @see java.lang.Object#toString() */ + /** {@inheritDoc} */ public String toString() { return getName(); } diff --git a/src/java/org/apache/fop/render/pcl/PCLRenderer.java b/src/java/org/apache/fop/render/pcl/PCLRenderer.java index 733212e48..9ac5d503e 100644 --- a/src/java/org/apache/fop/render/pcl/PCLRenderer.java +++ b/src/java/org/apache/fop/render/pcl/PCLRenderer.java @@ -146,7 +146,7 @@ public class PCLRenderer extends PrintRenderer { } /** - * @see org.apache.fop.render.Renderer#setupFontInfo(org.apache.fop.fonts.FontInfo) + * {@inheritDoc} */ public void setupFontInfo(FontInfo inFontInfo) { //Don't call super.setupFontInfo() here! @@ -173,7 +173,7 @@ public class PCLRenderer extends PrintRenderer { } } - /** @see org.apache.fop.render.Renderer#getGraphics2DAdapter() */ + /** {@inheritDoc} */ public Graphics2DAdapter getGraphics2DAdapter() { return new PCLGraphics2DAdapter(); } @@ -312,7 +312,7 @@ public class PCLRenderer extends PrintRenderer { return true; } - /** @see org.apache.fop.render.Renderer#startRenderer(java.io.OutputStream) */ + /** {@inheritDoc} */ public void startRenderer(OutputStream outputStream) throws IOException { log.debug("Rendering areas to PCL..."); this.out = outputStream; @@ -330,20 +330,20 @@ public class PCLRenderer extends PrintRenderer { gen.setRasterGraphicsResolution(getResolution()); } - /** @see org.apache.fop.render.Renderer#stopRenderer() */ + /** {@inheritDoc} */ public void stopRenderer() throws IOException { gen.separateJobs(); gen.resetPrinter(); gen.universalEndOfLanguage(); } - /** @see org.apache.fop.render.AbstractRenderer */ + /** {@inheritDoc} */ public String getMimeType() { return MIME_TYPE; } /** - * @see org.apache.fop.render.AbstractRenderer#renderPage(org.apache.fop.area.PageViewport) + * {@inheritDoc} */ public void renderPage(PageViewport page) throws IOException, FOPException { saveGraphicsState(); @@ -492,7 +492,7 @@ public class PCLRenderer extends PrintRenderer { } /** - * @see org.apache.fop.render.AbstractRenderer#startVParea(CTM, Rectangle2D) + * {@inheritDoc} */ protected void startVParea(CTM ctm, Rectangle2D clippingRect) { saveGraphicsState(); @@ -505,7 +505,7 @@ public class PCLRenderer extends PrintRenderer { } /** - * @see org.apache.fop.render.AbstractRenderer#endVParea() + * {@inheritDoc} */ protected void endVParea() { restoreGraphicsState(); @@ -544,7 +544,7 @@ public class PCLRenderer extends PrintRenderer { } /** - * @see org.apache.fop.render.AbstractRenderer#renderText(TextArea) + * {@inheritDoc} */ protected void renderText(final TextArea text) { renderInlineAreaBackAndBorders(text); @@ -694,9 +694,7 @@ public class PCLRenderer extends PrintRenderer { } } - /** - * @see org.apache.fop.render.AbstractPathOrientedRenderer#clip() - */ + /** Clip using the current path. */ protected void clip() { if (currentPath == null) { throw new IllegalStateException("No current path available!"); @@ -706,14 +704,18 @@ public class PCLRenderer extends PrintRenderer { } /** - * @see org.apache.fop.render.AbstractPathOrientedRenderer#closePath() + * Closes the current subpath by appending a straight line segment from + * the current point to the starting point of the subpath. */ protected void closePath() { currentPath.closePath(); } /** - * @see org.apache.fop.render.AbstractPathOrientedRenderer#lineTo(float, float) + * Appends a straight line segment from the current point to (x, y). The + * new current point is (x, y). + * @param x x coordinate + * @param y y coordinate */ protected void lineTo(float x, float y) { if (currentPath == null) { @@ -723,7 +725,9 @@ public class PCLRenderer extends PrintRenderer { } /** - * @see org.apache.fop.render.AbstractPathOrientedRenderer#moveTo(float, float) + * Moves the current point to (x, y), omitting any connecting line segment. + * @param x x coordinate + * @param y y coordinate */ protected void moveTo(float x, float y) { if (currentPath == null) { @@ -758,7 +762,7 @@ public class PCLRenderer extends PrintRenderer { } /** - * @see org.apache.fop.render.AbstractRenderer#renderWord(org.apache.fop.area.inline.WordArea) + * {@inheritDoc} */ protected void renderWord(WordArea word) { //Font font = getFontFromArea(word.getParentArea()); @@ -775,7 +779,7 @@ public class PCLRenderer extends PrintRenderer { } /** - * @see org.apache.fop.render.AbstractRenderer#renderSpace(org.apache.fop.area.inline.SpaceArea) + * {@inheritDoc} */ protected void renderSpace(SpaceArea space) { AbstractTextArea textArea = (AbstractTextArea)space.getParentArea(); @@ -832,7 +836,7 @@ public class PCLRenderer extends PrintRenderer { } /** - * @see org.apache.fop.render.AbstractRenderer#renderBlockViewport(BlockViewport, List) + * {@inheritDoc} */ protected void renderBlockViewport(BlockViewport bv, List children) { // clip and position viewport if necessary @@ -959,7 +963,7 @@ public class PCLRenderer extends PrintRenderer { } /** - * @see org.apache.fop.render.AbstractRenderer#renderImage(Image, Rectangle2D) + * {@inheritDoc} */ public void renderImage(Image image, Rectangle2D pos) { drawImage(image.getURL(), pos, image.getForeignAttributes()); @@ -1037,7 +1041,7 @@ public class PCLRenderer extends PrintRenderer { } /** - * @see org.apache.fop.render.AbstractRenderer#renderForeignObject(ForeignObject, Rectangle2D) + * {@inheritDoc} */ public void renderForeignObject(ForeignObject fo, Rectangle2D pos) { Document doc = fo.getDocument(); diff --git a/src/java/org/apache/fop/render/pcl/PCLRendererConfigurator.java b/src/java/org/apache/fop/render/pcl/PCLRendererConfigurator.java index 814b6837c..e0f0023c1 100644 --- a/src/java/org/apache/fop/render/pcl/PCLRendererConfigurator.java +++ b/src/java/org/apache/fop/render/pcl/PCLRendererConfigurator.java @@ -39,11 +39,10 @@ public class PCLRendererConfigurator extends PrintRendererConfigurator { } /** - * Configure the TIFF renderer. Get the configuration to be used for - * compression + * Configure the PCL renderer. + * * @param renderer PCL renderer * @throws FOPException fop exception - * @see org.apache.fop.render.PrintRendererConfigurator#configure(Renderer) */ public void configure(Renderer renderer) throws FOPException { Configuration cfg = super.getRendererConfig(renderer); diff --git a/src/java/org/apache/fop/render/pcl/PCLRendererMaker.java b/src/java/org/apache/fop/render/pcl/PCLRendererMaker.java index b7b395341..025a1cb4b 100644 --- a/src/java/org/apache/fop/render/pcl/PCLRendererMaker.java +++ b/src/java/org/apache/fop/render/pcl/PCLRendererMaker.java @@ -35,22 +35,22 @@ public class PCLRendererMaker extends AbstractRendererMaker { MimeConstants.MIME_PCL_ALT
};
- /**@see org.apache.fop.render.AbstractRendererMaker#makeRenderer(FOUserAgent) */
+ /**{@inheritDoc} */
public Renderer makeRenderer(FOUserAgent userAgent) {
return new PCLRenderer();
}
- /** @see org.apache.fop.render.AbstractRendererMaker#getConfigurator(FOUserAgent) */
+ /** {@inheritDoc} */
public RendererConfigurator getConfigurator(FOUserAgent userAgent) {
return new PCLRendererConfigurator(userAgent);
}
- /** @see org.apache.fop.render.AbstractRendererMaker#needsOutputStream() */
+ /** {@inheritDoc} */
public boolean needsOutputStream() {
return true;
}
- /** @see org.apache.fop.render.AbstractRendererMaker#getSupportedMimeTypes() */
+ /** {@inheritDoc} */
public String[] getSupportedMimeTypes() {
return MIMES;
}
diff --git a/src/java/org/apache/fop/render/pcl/PCLSVGHandler.java b/src/java/org/apache/fop/render/pcl/PCLSVGHandler.java index 7a7d0b6d4..8c9179063 100644 --- a/src/java/org/apache/fop/render/pcl/PCLSVGHandler.java +++ b/src/java/org/apache/fop/render/pcl/PCLSVGHandler.java @@ -31,7 +31,7 @@ import org.apache.fop.render.Renderer; */ public class PCLSVGHandler extends AbstractGenericSVGHandler { - /** @see org.apache.fop.render.XMLHandler#supportsRenderer(org.apache.fop.render.Renderer) */ + /** {@inheritDoc} */ public boolean supportsRenderer(Renderer renderer) { return (renderer instanceof PCLRenderer); } diff --git a/src/java/org/apache/fop/render/pcl/extensions/PCLElementMapping.java b/src/java/org/apache/fop/render/pcl/extensions/PCLElementMapping.java index 9a7916b65..863140688 100644 --- a/src/java/org/apache/fop/render/pcl/extensions/PCLElementMapping.java +++ b/src/java/org/apache/fop/render/pcl/extensions/PCLElementMapping.java @@ -39,7 +39,7 @@ public class PCLElementMapping extends ElementMapping { this.namespaceURI = NAMESPACE; } - /** @see org.apache.fop.fo.ElementMapping#initialize() */ + /** {@inheritDoc} */ protected void initialize() { if (foObjs == null) { diff --git a/src/java/org/apache/fop/render/pdf/CTMHelper.java b/src/java/org/apache/fop/render/pdf/CTMHelper.java index 002ee857d..e2d29f768 100644 --- a/src/java/org/apache/fop/render/pdf/CTMHelper.java +++ b/src/java/org/apache/fop/render/pdf/CTMHelper.java @@ -31,8 +31,6 @@ import org.apache.fop.pdf.PDFNumber; * as it's default user space and PDF uses points. * * @see org.apache.fop.area.CTM - * - * @author <a href="kevin@rocketred.com>Kevin O'Neill</a> */ public final class CTMHelper { /** diff --git a/src/java/org/apache/fop/render/pdf/FopPDFImage.java b/src/java/org/apache/fop/render/pdf/FopPDFImage.java index e78ecbdba..6f16561bc 100644 --- a/src/java/org/apache/fop/render/pdf/FopPDFImage.java +++ b/src/java/org/apache/fop/render/pdf/FopPDFImage.java @@ -74,7 +74,7 @@ public class FopPDFImage implements PDFImage { } /** - * @see org.apache.fop.pdf.PDFImage#getKey() + * {@inheritDoc} */ public String getKey() { // key to look up XObject @@ -82,7 +82,7 @@ public class FopPDFImage implements PDFImage { } /** - * @see org.apache.fop.pdf.PDFImage#setup(PDFDocument) + * {@inheritDoc} */ public void setup(PDFDocument doc) { if ("image/jpeg".equals(fopImage.getMimeType())) { @@ -175,21 +175,21 @@ public class FopPDFImage implements PDFImage { } /** - * @see org.apache.fop.pdf.PDFImage#getWidth() + * {@inheritDoc} */ public int getWidth() { return fopImage.getWidth(); } /** - * @see org.apache.fop.pdf.PDFImage#getHeight() + * {@inheritDoc} */ public int getHeight() { return fopImage.getHeight(); } /** - * @see org.apache.fop.pdf.PDFImage#getColorSpace() + * {@inheritDoc} */ public PDFDeviceColorSpace getColorSpace() { // DeviceGray, DeviceRGB, or DeviceCMYK @@ -201,7 +201,7 @@ public class FopPDFImage implements PDFImage { } /** - * @see org.apache.fop.pdf.PDFImage#getBitsPerPixel() + * {@inheritDoc} */ public int getBitsPerPixel() { if (isCCF) { @@ -214,14 +214,14 @@ public class FopPDFImage implements PDFImage { } /** - * @see org.apache.fop.pdf.PDFImage#isTransparent() + * {@inheritDoc} */ public boolean isTransparent() { return fopImage.isTransparent(); } /** - * @see org.apache.fop.pdf.PDFImage#getTransparentColor() + * {@inheritDoc} */ public PDFColor getTransparentColor() { return new PDFColor(fopImage.getTransparentColor().getRed(), @@ -230,14 +230,14 @@ public class FopPDFImage implements PDFImage { } /** - * @see org.apache.fop.pdf.PDFImage#getMask() + * {@inheritDoc} */ public String getMask() { return maskRef; } /** - * @see org.apache.fop.pdf.PDFImage#getSoftMask() + * {@inheritDoc} */ public String getSoftMask() { return softMaskRef; @@ -249,21 +249,21 @@ public class FopPDFImage implements PDFImage { } /** - * @see org.apache.fop.pdf.PDFImage#isPS() + * {@inheritDoc} */ public boolean isPS() { return isPS; } /** - * @see org.apache.fop.pdf.PDFImage#getPDFFilter() + * {@inheritDoc} */ public PDFFilter getPDFFilter() { return pdfFilter; } /** - * @see org.apache.fop.pdf.PDFImage#outputContents(OutputStream) + * {@inheritDoc} */ public void outputContents(OutputStream out) throws IOException { if (isPS) { @@ -324,7 +324,7 @@ public class FopPDFImage implements PDFImage { } /** - * @see org.apache.fop.pdf.PDFImage#getICCStream() + * {@inheritDoc} */ public PDFICCStream getICCStream() { return pdfICCStream; @@ -356,7 +356,7 @@ public class FopPDFImage implements PDFImage { } /** - * @see org.apache.fop.pdf.PDFImage#getFilterHint() + * {@inheritDoc} */ public String getFilterHint() { if (isPS) { diff --git a/src/java/org/apache/fop/render/pdf/PDFGraphics2DAdapter.java b/src/java/org/apache/fop/render/pdf/PDFGraphics2DAdapter.java index ce8c23149..eb0e4b378 100644 --- a/src/java/org/apache/fop/render/pdf/PDFGraphics2DAdapter.java +++ b/src/java/org/apache/fop/render/pdf/PDFGraphics2DAdapter.java @@ -49,7 +49,7 @@ public class PDFGraphics2DAdapter extends AbstractGraphics2DAdapter { this.renderer = renderer;
}
- /** @see org.apache.fop.render.Graphics2DAdapter */
+ /** {@inheritDoc} */
public void paintImage(Graphics2DImagePainter painter,
RendererContext context,
int x, int y, int width, int height) throws IOException {
@@ -117,10 +117,7 @@ public class PDFGraphics2DAdapter extends AbstractGraphics2DAdapter { pdfInfo.pdfState.pop();
}
- /**
- * @see org.apache.fop.render.AbstractGraphics2DAdapter#setRenderingHintsForBufferedImage(
- * java.awt.Graphics2D)
- */
+ /** {@inheritDoc} */
protected void setRenderingHintsForBufferedImage(Graphics2D g2d) {
super.setRenderingHintsForBufferedImage(g2d);
g2d.setRenderingHint(RenderingHints.KEY_ANTIALIASING,
diff --git a/src/java/org/apache/fop/render/pdf/PDFRenderer.java b/src/java/org/apache/fop/render/pdf/PDFRenderer.java index 73c38878e..d626d57e4 100644 --- a/src/java/org/apache/fop/render/pdf/PDFRenderer.java +++ b/src/java/org/apache/fop/render/pdf/PDFRenderer.java @@ -273,7 +273,7 @@ public class PDFRenderer extends AbstractPathOrientedRenderer { } /** - * @see org.apache.fop.render.Renderer#setUserAgent(FOUserAgent) + * {@inheritDoc} */ public void setUserAgent(FOUserAgent agent) { super.setUserAgent(agent); @@ -341,7 +341,7 @@ public class PDFRenderer extends AbstractPathOrientedRenderer { } /** - * @see org.apache.fop.render.Renderer#startRenderer(OutputStream) + * {@inheritDoc} */ public void startRenderer(OutputStream stream) throws IOException { if (userAgent == null) { @@ -497,7 +497,7 @@ public class PDFRenderer extends AbstractPathOrientedRenderer { } /** - * @see org.apache.fop.render.Renderer#stopRenderer() + * {@inheritDoc} */ public void stopRenderer() throws IOException { finishOpenGoTos(); @@ -524,7 +524,7 @@ public class PDFRenderer extends AbstractPathOrientedRenderer { } /** - * @see org.apache.fop.render.Renderer#supportsOutOfOrder() + * {@inheritDoc} */ public boolean supportsOutOfOrder() { //return false; @@ -532,7 +532,7 @@ public class PDFRenderer extends AbstractPathOrientedRenderer { } /** - * @see org.apache.fop.render.Renderer#processOffDocumentItem(OffDocumentItem) + * {@inheritDoc} */ public void processOffDocumentItem(OffDocumentItem odi) { if (odi instanceof DestinationData) { @@ -618,7 +618,7 @@ public class PDFRenderer extends AbstractPathOrientedRenderer { pdfDoc.getRoot().setMetadata(pdfMetadata); } - /** @see org.apache.fop.render.Renderer#getGraphics2DAdapter() */ + /** {@inheritDoc} */ public Graphics2DAdapter getGraphics2DAdapter() { return new PDFGraphics2DAdapter(this); } @@ -724,7 +724,7 @@ public class PDFRenderer extends AbstractPathOrientedRenderer { * This method creates a pdf stream for the current page * uses it as the contents of a new page. The page is written * immediately to the output stream. - * @see org.apache.fop.render.Renderer#renderPage(PageViewport) + * {@inheritDoc} */ public void renderPage(PageViewport page) throws IOException, FOPException { @@ -767,7 +767,7 @@ public class PDFRenderer extends AbstractPathOrientedRenderer { } /** - * @see org.apache.fop.render.AbstractRenderer#startVParea(CTM, Rectangle2D) + * {@inheritDoc} */ protected void startVParea(CTM ctm, Rectangle2D clippingRect) { // Set the given CTM in the graphics state @@ -787,7 +787,7 @@ public class PDFRenderer extends AbstractPathOrientedRenderer { } /** - * @see org.apache.fop.render.AbstractRenderer#endVParea() + * {@inheritDoc} */ protected void endVParea() { restoreGraphicsState(); @@ -814,7 +814,7 @@ public class PDFRenderer extends AbstractPathOrientedRenderer { return PDFNumber.doubleOut(value); } - /** @see org.apache.fop.render.AbstractPathOrientedRenderer */ + /** {@inheritDoc} */ protected void drawBorderLine(float x1, float y1, float x2, float y2, boolean horz, boolean startOrBefore, int style, Color col) { float w = x2 - x1; @@ -1046,7 +1046,7 @@ public class PDFRenderer extends AbstractPathOrientedRenderer { } /** - * @see org.apache.fop.render.AbstractPathOrientedRenderer#fillRect(float, float, float, float) + * {@inheritDoc} */ protected void fillRect(float x, float y, float w, float h) { if (w != 0 && h != 0) { @@ -1293,7 +1293,7 @@ public class PDFRenderer extends AbstractPathOrientedRenderer { } /** - * @see org.apache.fop.render.AbstractRenderer#renderBlock(Block) + * {@inheritDoc} */ protected void renderBlock(Block block) { saveBlockPosIfTargetable(block); @@ -1301,7 +1301,7 @@ public class PDFRenderer extends AbstractPathOrientedRenderer { } /** - * @see org.apache.fop.render.AbstractRenderer#renderLineArea(LineArea) + * {@inheritDoc} */ protected void renderLineArea(LineArea line) { super.renderLineArea(line); @@ -1309,7 +1309,7 @@ public class PDFRenderer extends AbstractPathOrientedRenderer { } /** - * @see org.apache.fop.render.AbstractRenderer#renderInlineArea(InlineArea) + * {@inheritDoc} */ protected void renderInlineArea(InlineArea inlineArea) { saveInlinePosIfTargetable(inlineArea); @@ -1395,7 +1395,7 @@ public class PDFRenderer extends AbstractPathOrientedRenderer { } /** - * @see org.apache.fop.render.AbstractRenderer#renderText(TextArea) + * {@inheritDoc} */ public void renderText(TextArea text) { renderInlineAreaBackAndBorders(text); @@ -1434,7 +1434,7 @@ public class PDFRenderer extends AbstractPathOrientedRenderer { } /** - * @see org.apache.fop.render.AbstractRenderer#renderWord(WordArea) + * {@inheritDoc} */ public void renderWord(WordArea word) { Font font = getFontFromArea(word.getParentArea()); @@ -1453,7 +1453,7 @@ public class PDFRenderer extends AbstractPathOrientedRenderer { } /** - * @see org.apache.fop.render.AbstractRenderer#renderSpace(SpaceArea) + * {@inheritDoc} */ public void renderSpace(SpaceArea space) { Font font = getFontFromArea(space.getParentArea()); @@ -1626,7 +1626,7 @@ public class PDFRenderer extends AbstractPathOrientedRenderer { } } - /** @see org.apache.fop.render.AbstractPathOrientedRenderer */ + /** {@inheritDoc} */ protected void updateColor(Color col, boolean fill) { updateColor(col, fill, null); } @@ -1644,7 +1644,7 @@ public class PDFRenderer extends AbstractPathOrientedRenderer { } /** - * @see org.apache.fop.render.AbstractRenderer#renderImage(Image, Rectangle2D) + * {@inheritDoc} */ public void renderImage(Image image, Rectangle2D pos) { endTextObject(); @@ -1652,7 +1652,7 @@ public class PDFRenderer extends AbstractPathOrientedRenderer { putImage(url, pos); } - /** @see org.apache.fop.render.AbstractPathOrientedRenderer */ + /** {@inheritDoc} */ protected void drawImage(String url, Rectangle2D pos, Map foreignAttributes) { endTextObject(); putImage(url, pos); @@ -1758,7 +1758,7 @@ public class PDFRenderer extends AbstractPathOrientedRenderer { } /** - * @see org.apache.fop.render.PrintRenderer#createRendererContext( + * {@inheritDoc} * int, int, int, int, java.util.Map) */ protected RendererContext createRendererContext(int x, int y, int width, int height, @@ -1851,7 +1851,7 @@ public class PDFRenderer extends AbstractPathOrientedRenderer { super.renderLeader(area); } - /** @see org.apache.fop.render.AbstractRenderer */ + /** {@inheritDoc} */ public String getMimeType() { return MIME_TYPE; } diff --git a/src/java/org/apache/fop/render/pdf/PDFRendererMaker.java b/src/java/org/apache/fop/render/pdf/PDFRendererMaker.java index 00fc1a88f..0e36e177b 100644 --- a/src/java/org/apache/fop/render/pdf/PDFRendererMaker.java +++ b/src/java/org/apache/fop/render/pdf/PDFRendererMaker.java @@ -32,22 +32,22 @@ public class PDFRendererMaker extends AbstractRendererMaker { private static final String[] MIMES = new String[] {MimeConstants.MIME_PDF};
- /** @see org.apache.fop.render.AbstractRendererMaker#makeRenderer(FOUserAgent) */
+ /** {@inheritDoc} */
public Renderer makeRenderer(FOUserAgent userAgent) {
return new PDFRenderer();
}
- /** @see org.apache.fop.render.AbstractRendererMaker#getConfigurator(FOUserAgent) */
+ /** {@inheritDoc} */
public RendererConfigurator getConfigurator(FOUserAgent userAgent) {
return new PDFRendererConfigurator(userAgent);
}
- /** @see org.apache.fop.render.AbstractRendererMaker#needsOutputStream() */
+ /** {@inheritDoc} */
public boolean needsOutputStream() {
return true;
}
- /** @see org.apache.fop.render.AbstractRendererMaker#getSupportedMimeTypes() */
+ /** {@inheritDoc} */
public String[] getSupportedMimeTypes() {
return MIMES;
}
diff --git a/src/java/org/apache/fop/render/pdf/PDFSVGHandler.java b/src/java/org/apache/fop/render/pdf/PDFSVGHandler.java index cca185a04..7b5c671ed 100644 --- a/src/java/org/apache/fop/render/pdf/PDFSVGHandler.java +++ b/src/java/org/apache/fop/render/pdf/PDFSVGHandler.java @@ -136,8 +136,7 @@ public class PDFSVGHandler extends AbstractGenericSVGHandler } /** - * @see org.apache.fop.render.AbstractGenericSVGHandler#renderSVGDocument( - * org.apache.fop.render.RendererContext, org.w3c.dom.Document) + * {@inheritDoc} */ protected void renderSVGDocument(RendererContext context, Document doc) { @@ -267,7 +266,7 @@ public class PDFSVGHandler extends AbstractGenericSVGHandler pdfInfo.currentStream.add("%SVG end\n"); } - /** @see org.apache.fop.render.XMLHandler#supportsRenderer(org.apache.fop.render.Renderer) */ + /** {@inheritDoc} */ public boolean supportsRenderer(Renderer renderer) { return (renderer instanceof PDFRenderer); } diff --git a/src/java/org/apache/fop/render/print/PrintRenderer.java b/src/java/org/apache/fop/render/print/PrintRenderer.java index 20d46ee4a..e4c159815 100644 --- a/src/java/org/apache/fop/render/print/PrintRenderer.java +++ b/src/java/org/apache/fop/render/print/PrintRenderer.java @@ -185,7 +185,7 @@ public class PrintRenderer extends Java2DRenderer implements Pageable { return vec; } - /** @see java.awt.print.Pageable#getPageFormat(int) */ + /** {@inheritDoc} */ public PageFormat getPageFormat(int pageIndex) throws IndexOutOfBoundsException { try { diff --git a/src/java/org/apache/fop/render/print/PrintRendererMaker.java b/src/java/org/apache/fop/render/print/PrintRendererMaker.java index 6ad2cb3d1..4b0523458 100644 --- a/src/java/org/apache/fop/render/print/PrintRendererMaker.java +++ b/src/java/org/apache/fop/render/print/PrintRendererMaker.java @@ -33,22 +33,22 @@ public class PrintRendererMaker extends AbstractRendererMaker { private static final String[] MIMES = new String[] {MimeConstants.MIME_FOP_PRINT};
- /**@see org.apache.fop.render.AbstractRendererMaker#makeRenderer(FOUserAgent) */
+ /**{@inheritDoc} */
public Renderer makeRenderer(FOUserAgent userAgent) {
return new PrintRenderer();
}
- /** @see org.apache.fop.render.AbstractRendererMaker#getConfigurator(FOUserAgent) */
+ /** {@inheritDoc} */
public RendererConfigurator getConfigurator(FOUserAgent userAgent) {
return new PrintRendererConfigurator(userAgent);
}
- /** @see org.apache.fop.render.AbstractRendererMaker#needsOutputStream() */
+ /** {@inheritDoc} */
public boolean needsOutputStream() {
return false;
}
- /** @see org.apache.fop.render.AbstractRendererMaker#getSupportedMimeTypes() */
+ /** {@inheritDoc} */
public String[] getSupportedMimeTypes() {
return MIMES;
}
diff --git a/src/java/org/apache/fop/render/ps/AbstractPSTranscoder.java b/src/java/org/apache/fop/render/ps/AbstractPSTranscoder.java index 9795bd54a..e7ed181e4 100644 --- a/src/java/org/apache/fop/render/ps/AbstractPSTranscoder.java +++ b/src/java/org/apache/fop/render/ps/AbstractPSTranscoder.java @@ -146,7 +146,7 @@ public abstract class AbstractPSTranscoder extends AbstractFOPTranscoder { return stroke; } - /** @see org.apache.batik.transcoder.SVGAbstractTranscoder#createBridgeContext() */ + /** {@inheritDoc} */ protected BridgeContext createBridgeContext() { BridgeContext ctx = new BridgeContext(userAgent); diff --git a/src/java/org/apache/fop/render/ps/EPSTranscoder.java b/src/java/org/apache/fop/render/ps/EPSTranscoder.java index a6d6c12a2..c34772196 100644 --- a/src/java/org/apache/fop/render/ps/EPSTranscoder.java +++ b/src/java/org/apache/fop/render/ps/EPSTranscoder.java @@ -58,7 +58,7 @@ public class EPSTranscoder extends AbstractPSTranscoder { super(); } - /** @see AbstractPSTranscoder#createDocumentGraphics2D() */ + /** {@inheritDoc} */ protected AbstractPSDocumentGraphics2D createDocumentGraphics2D() { return new EPSDocumentGraphics2D(false); } diff --git a/src/java/org/apache/fop/render/ps/NativeTextHandler.java b/src/java/org/apache/fop/render/ps/NativeTextHandler.java index 5cda145b9..360cf6d6e 100644 --- a/src/java/org/apache/fop/render/ps/NativeTextHandler.java +++ b/src/java/org/apache/fop/render/ps/NativeTextHandler.java @@ -87,14 +87,14 @@ public class NativeTextHandler implements TextHandler { return this.g2d.getPSGenerator(); } - /** @see org.apache.xmlgraphics.java2d.ps.TextHandler#writeSetup() */ + /** {@inheritDoc} */ public void writeSetup() throws IOException { if (fontInfo != null) { PSFontUtils.writeFontDict(getPSGenerator(), fontInfo); } } - /** @see org.apache.xmlgraphics.java2d.ps.TextHandler#writePageSetup() */ + /** {@inheritDoc} */ public void writePageSetup() throws IOException { if (fontInfo != null) { getPSGenerator().writeln("FOPFonts begin"); @@ -104,7 +104,7 @@ public class NativeTextHandler implements TextHandler { /** * Draw a string to the PostScript document. The text is painted using * text operations. - * @see org.apache.xmlgraphics.java2d.ps.TextHandler#drawString(java.lang.String, float, float) + * {@inheritDoc} */ public void drawString(String s, float x, float y) throws IOException { g2d.preparePainting(); diff --git a/src/java/org/apache/fop/render/ps/PSGraphics2DAdapter.java b/src/java/org/apache/fop/render/ps/PSGraphics2DAdapter.java index fa94d9a24..286bbca80 100644 --- a/src/java/org/apache/fop/render/ps/PSGraphics2DAdapter.java +++ b/src/java/org/apache/fop/render/ps/PSGraphics2DAdapter.java @@ -45,7 +45,7 @@ public class PSGraphics2DAdapter implements Graphics2DAdapter { this.renderer = renderer;
}
- /** @see org.apache.fop.render.Graphics2DAdapter */
+ /** {@inheritDoc} */
public void paintImage(Graphics2DImagePainter painter,
RendererContext context,
int x, int y, int width, int height) throws IOException {
diff --git a/src/java/org/apache/fop/render/ps/PSRenderer.java b/src/java/org/apache/fop/render/ps/PSRenderer.java index ad5b0b3ce..bb77dd55a 100644 --- a/src/java/org/apache/fop/render/ps/PSRenderer.java +++ b/src/java/org/apache/fop/render/ps/PSRenderer.java @@ -143,7 +143,7 @@ public class PSRenderer extends AbstractPathOrientedRenderer implements ImageAda private Map formResources; /** - * @see org.apache.fop.render.Renderer#setUserAgent(FOUserAgent) + * {@inheritDoc} */ public void setUserAgent(FOUserAgent agent) { super.setUserAgent(agent); @@ -196,12 +196,12 @@ public class PSRenderer extends AbstractPathOrientedRenderer implements ImageAda return this.autoRotateLandscape; } - /** @see org.apache.fop.render.Renderer#getGraphics2DAdapter() */ + /** {@inheritDoc} */ public Graphics2DAdapter getGraphics2DAdapter() { return new PSGraphics2DAdapter(this); } - /** @see org.apache.fop.render.Renderer#getImageAdapter() */ + /** {@inheritDoc} */ public ImageAdapter getImageAdapter() { return this; } @@ -250,7 +250,7 @@ public class PSRenderer extends AbstractPathOrientedRenderer implements ImageAda moveTo(this.currentIPPosition, this.currentBPPosition); } - /** @see org.apache.fop.render.AbstractPathOrientedRenderer#clip() */ + /** {@inheritDoc} */ protected void clip() { writeln("clip newpath"); } @@ -273,7 +273,7 @@ public class PSRenderer extends AbstractPathOrientedRenderer implements ImageAda } } - /** @see org.apache.fop.render.AbstractPathOrientedRenderer#moveTo(float, float) */ + /** {@inheritDoc} */ protected void moveTo(float x, float y) { writeln(gen.formatDouble(x) + " " + gen.formatDouble(y) + " M"); } @@ -288,17 +288,17 @@ public class PSRenderer extends AbstractPathOrientedRenderer implements ImageAda writeln(gen.formatDouble(x) + " " + gen.formatDouble(y) + " RM"); } - /** @see org.apache.fop.render.AbstractPathOrientedRenderer#lineTo(float, float) */ + /** {@inheritDoc} */ protected void lineTo(float x, float y) { writeln(gen.formatDouble(x) + " " + gen.formatDouble(y) + " lineto"); } - /** @see org.apache.fop.render.AbstractPathOrientedRenderer#closePath() */ + /** {@inheritDoc} */ protected void closePath() { writeln("cp"); } - /** @see org.apache.fop.render.AbstractPathOrientedRenderer */ + /** {@inheritDoc} */ protected void fillRect(float x, float y, float width, float height) { if (width != 0 && height != 0) { try { @@ -310,7 +310,7 @@ public class PSRenderer extends AbstractPathOrientedRenderer implements ImageAda } } - /** @see org.apache.fop.render.AbstractPathOrientedRenderer */ + /** {@inheritDoc} */ protected void updateColor(Color col, boolean fill) { try { useColor(col); @@ -319,7 +319,7 @@ public class PSRenderer extends AbstractPathOrientedRenderer implements ImageAda } } - /** @see org.apache.fop.render.AbstractPathOrientedRenderer */ + /** {@inheritDoc} */ protected void drawImage(String uri, Rectangle2D pos, Map foreignAttributes) { endTextObject(); uri = ImageFactory.getURL(uri); @@ -386,7 +386,7 @@ public class PSRenderer extends AbstractPathOrientedRenderer implements ImageAda return !this.twoPassGeneration; } - /** @see org.apache.fop.render.ImageAdapter */ + /** {@inheritDoc} */ public void paintImage(RenderedImage image, RendererContext context, int x, int y, int width, int height) throws IOException { float fx = (float)x / 1000f; @@ -516,7 +516,7 @@ public class PSRenderer extends AbstractPathOrientedRenderer implements ImageAda gen.useRGBColor(col); } - /** @see org.apache.fop.render.AbstractPathOrientedRenderer#drawBackAndBorders( + /** {@inheritDoc} * Area, float, float, float, float) */ protected void drawBackAndBorders(Area area, float startx, float starty, float width, float height) { @@ -532,7 +532,7 @@ public class PSRenderer extends AbstractPathOrientedRenderer implements ImageAda } } - /** @see org.apache.fop.render.AbstractPathOrientedRenderer */ + /** {@inheritDoc} */ protected void drawBorderLine(float x1, float y1, float x2, float y2, boolean horz, boolean startOrBefore, int style, Color col) { try { @@ -687,7 +687,7 @@ public class PSRenderer extends AbstractPathOrientedRenderer implements ImageAda } /** - * @see org.apache.fop.render.Renderer#startRenderer(OutputStream) + * {@inheritDoc} */ public void startRenderer(OutputStream outputStream) throws IOException { @@ -731,7 +731,7 @@ public class PSRenderer extends AbstractPathOrientedRenderer implements ImageAda } /** - * @see org.apache.fop.render.Renderer#stopRenderer() + * {@inheritDoc} */ public void stopRenderer() throws IOException { //Notify resource usage for font which are not supplied @@ -789,7 +789,7 @@ public class PSRenderer extends AbstractPathOrientedRenderer implements ImageAda } } - /** @see org.apache.fop.render.Renderer */ + /** {@inheritDoc} */ public void processOffDocumentItem(OffDocumentItem oDI) { if (log.isDebugEnabled()) { log.debug("Handling OffDocumentItem: " + oDI.getName()); @@ -807,7 +807,7 @@ public class PSRenderer extends AbstractPathOrientedRenderer implements ImageAda super.processOffDocumentItem(oDI); } - /** @see org.apache.fop.render.Renderer#startPageSequence(org.apache.fop.area.LineArea) */ + /** {@inheritDoc} */ public void startPageSequence(LineArea seqTitle) { super.startPageSequence(seqTitle); if (!firstPageSequenceReceived) { @@ -865,7 +865,7 @@ public class PSRenderer extends AbstractPathOrientedRenderer implements ImageAda } /** - * @see org.apache.fop.render.Renderer#renderPage(PageViewport) + * {@inheritDoc} */ public void renderPage(PageViewport page) throws IOException, FOPException { @@ -960,7 +960,7 @@ public class PSRenderer extends AbstractPathOrientedRenderer implements ImageAda gen.getResourceTracker().writeResources(true, gen); } - /** @see org.apache.fop.render.AbstractRenderer */ + /** {@inheritDoc} */ protected void renderRegionViewport(RegionViewport port) { if (port != null) { comment("%FOPBeginRegionViewport: " + port.getRegionReference().getRegionName()); @@ -988,7 +988,7 @@ public class PSRenderer extends AbstractPathOrientedRenderer implements ImageAda } /** - * @see org.apache.fop.render.AbstractRenderer#renderText(TextArea) + * {@inheritDoc} */ public void renderText(TextArea area) { renderInlineAreaBackAndBorders(area); @@ -1022,7 +1022,7 @@ public class PSRenderer extends AbstractPathOrientedRenderer implements ImageAda } /** - * @see org.apache.fop.render.AbstractRenderer#renderWord(org.apache.fop.area.inline.WordArea) + * {@inheritDoc} */ protected void renderWord(WordArea word) { renderText((TextArea)word.getParentArea(), word.getWord(), word.getLetterAdjustArray()); @@ -1030,7 +1030,7 @@ public class PSRenderer extends AbstractPathOrientedRenderer implements ImageAda } /** - * @see org.apache.fop.render.AbstractRenderer#renderSpace(org.apache.fop.area.inline.SpaceArea) + * {@inheritDoc} */ protected void renderSpace(SpaceArea space) { AbstractTextArea textArea = (AbstractTextArea)space.getParentArea(); @@ -1101,7 +1101,7 @@ public class PSRenderer extends AbstractPathOrientedRenderer implements ImageAda } - /** @see org.apache.fop.render.AbstractPathOrientedRenderer#breakOutOfStateStack() */ + /** {@inheritDoc} */ protected List breakOutOfStateStack() { try { List breakOutList = new java.util.ArrayList(); @@ -1124,7 +1124,7 @@ public class PSRenderer extends AbstractPathOrientedRenderer implements ImageAda } } - /** @see org.apache.fop.render.AbstractPathOrientedRenderer */ + /** {@inheritDoc} */ protected void restoreStateStackAfterBreakOut(List breakOutList) { try { comment("------ restoring context after break-out..."); @@ -1142,7 +1142,7 @@ public class PSRenderer extends AbstractPathOrientedRenderer implements ImageAda } /** - * @see org.apache.fop.render.AbstractRenderer#startVParea(CTM, Rectangle2D) + * {@inheritDoc} */ protected void startVParea(CTM ctm, Rectangle2D clippingRect) { saveGraphicsState(); @@ -1160,27 +1160,27 @@ public class PSRenderer extends AbstractPathOrientedRenderer implements ImageAda } /** - * @see org.apache.fop.render.AbstractRenderer#endVParea() + * {@inheritDoc} */ protected void endVParea() { endTextObject(); restoreGraphicsState(); } - /** @see org.apache.fop.render.AbstractRenderer */ + /** {@inheritDoc} */ protected void renderBlockViewport(BlockViewport bv, List children) { comment("%FOPBeginBlockViewport: " + bv.toString()); super.renderBlockViewport(bv, children); comment("%FOPEndBlockViewport"); } - /** @see org.apache.fop.render.AbstractRenderer */ + /** {@inheritDoc} */ protected void renderInlineParent(InlineParent ip) { super.renderInlineParent(ip); } /** - * @see org.apache.fop.render.AbstractRenderer#renderLeader(org.apache.fop.area.inline.Leader) + * {@inheritDoc} */ public void renderLeader(Leader area) { renderInlineAreaBackAndBorders(area); @@ -1251,14 +1251,14 @@ public class PSRenderer extends AbstractPathOrientedRenderer implements ImageAda } /** - * @see org.apache.fop.render.AbstractRenderer#renderImage(Image, Rectangle2D) + * {@inheritDoc} */ public void renderImage(Image image, Rectangle2D pos) { drawImage(image.getURL(), pos); } /** - * @see org.apache.fop.render.PrintRenderer#createRendererContext( + * {@inheritDoc} * int, int, int, int, java.util.Map) */ protected RendererContext createRendererContext(int x, int y, int width, int height, @@ -1270,7 +1270,7 @@ public class PSRenderer extends AbstractPathOrientedRenderer implements ImageAda return context; } - /** @see org.apache.fop.render.AbstractRenderer */ + /** {@inheritDoc} */ public String getMimeType() { return MIME_TYPE; } diff --git a/src/java/org/apache/fop/render/ps/PSRendererMaker.java b/src/java/org/apache/fop/render/ps/PSRendererMaker.java index 0db4281d0..d879c054c 100644 --- a/src/java/org/apache/fop/render/ps/PSRendererMaker.java +++ b/src/java/org/apache/fop/render/ps/PSRendererMaker.java @@ -32,22 +32,22 @@ public class PSRendererMaker extends AbstractRendererMaker { private static final String[] MIMES = new String[] {MimeConstants.MIME_POSTSCRIPT};
- /** @see org.apache.fop.render.AbstractRendererMaker#makeRenderer(FOUserAgent) */
+ /** {@inheritDoc} */
public Renderer makeRenderer(FOUserAgent userAgent) {
return new PSRenderer();
}
- /** @see org.apache.fop.render.AbstractRendererMaker#getConfigurator(FOUserAgent) */
+ /** {@inheritDoc} */
public RendererConfigurator getConfigurator(FOUserAgent userAgent) {
return new PSRendererConfigurator(userAgent);
}
- /** @see org.apache.fop.render.AbstractRendererMaker#needsOutputStream() */
+ /** {@inheritDoc} */
public boolean needsOutputStream() {
return true;
}
- /** @see org.apache.fop.render.AbstractRendererMaker#getSupportedMimeTypes() */
+ /** {@inheritDoc} */
public String[] getSupportedMimeTypes() {
return MIMES;
}
diff --git a/src/java/org/apache/fop/render/ps/PSSVGHandler.java b/src/java/org/apache/fop/render/ps/PSSVGHandler.java index 191fee5d9..5cfe617c8 100644 --- a/src/java/org/apache/fop/render/ps/PSSVGHandler.java +++ b/src/java/org/apache/fop/render/ps/PSSVGHandler.java @@ -68,7 +68,7 @@ public class PSSVGHandler implements XMLHandler, PSRendererContextConstants { public PSSVGHandler() { } - /** @see org.apache.fop.render.XMLHandler */ + /** {@inheritDoc} */ public void handleXML(RendererContext context, Document doc, String ns) throws Exception { PSInfo psi = getPSInfo(context); @@ -334,12 +334,12 @@ public class PSSVGHandler implements XMLHandler, PSRendererContextConstants { } } - /** @see org.apache.fop.render.XMLHandler#supportsRenderer(org.apache.fop.render.Renderer) */ + /** {@inheritDoc} */ public boolean supportsRenderer(Renderer renderer) { return (renderer instanceof PSRenderer); } - /** @see org.apache.fop.render.XMLHandler#getNamespace() */ + /** {@inheritDoc} */ public String getNamespace() { return SVGDOMImplementation.SVG_NAMESPACE_URI; } diff --git a/src/java/org/apache/fop/render/ps/PSTranscoder.java b/src/java/org/apache/fop/render/ps/PSTranscoder.java index bc33bae87..fd252b447 100644 --- a/src/java/org/apache/fop/render/ps/PSTranscoder.java +++ b/src/java/org/apache/fop/render/ps/PSTranscoder.java @@ -58,7 +58,7 @@ public class PSTranscoder extends AbstractPSTranscoder { super(); } - /** @see AbstractPSTranscoder#createDocumentGraphics2D() */ + /** {@inheritDoc} */ protected AbstractPSDocumentGraphics2D createDocumentGraphics2D() { return new PSDocumentGraphics2D(false); } diff --git a/src/java/org/apache/fop/render/ps/extensions/AbstractPSExtensionObject.java b/src/java/org/apache/fop/render/ps/extensions/AbstractPSExtensionObject.java index c583672de..6823d75d9 100644 --- a/src/java/org/apache/fop/render/ps/extensions/AbstractPSExtensionObject.java +++ b/src/java/org/apache/fop/render/ps/extensions/AbstractPSExtensionObject.java @@ -43,8 +43,7 @@ public abstract class AbstractPSExtensionObject extends FONode { } /** - * @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String) - * here, blocks XSL FO's from having non-FO parents. + * {@inheritDoc} */ protected void validateChildNode(Locator loc, String nsURI, String localName) throws ValidationException { @@ -53,7 +52,7 @@ public abstract class AbstractPSExtensionObject extends FONode { } } - /** @see org.apache.fop.fo.FONode */ + /** {@inheritDoc} */ protected void addCharacters(char[] data, int start, int length, PropertyList pList, Locator locator) { if (setupCode.getContent() != null) { @@ -65,17 +64,17 @@ public abstract class AbstractPSExtensionObject extends FONode { } } - /** @see org.apache.fop.fo.FONode#getNamespaceURI() */ + /** {@inheritDoc} */ public String getNamespaceURI() { return PSExtensionElementMapping.NAMESPACE; } - /**@see org.apache.fop.fo.FONode#getNormalNamespacePrefix() */ + /**{@inheritDoc} */ public String getNormalNamespacePrefix() { return "fox"; } - /** @see org.apache.fop.fo.FONode#processNode */ + /** {@inheritDoc} */ public void processNode(String elementName, Locator locator, Attributes attlist, PropertyList propertyList) throws FOPException { @@ -85,7 +84,7 @@ public abstract class AbstractPSExtensionObject extends FONode { } } - /** @see org.apache.fop.fo.FONode#endOfNode() */ + /** {@inheritDoc} */ protected void endOfNode() throws FOPException { super.endOfNode(); String s = setupCode.getContent(); @@ -94,7 +93,7 @@ public abstract class AbstractPSExtensionObject extends FONode { } } - /** @see org.apache.fop.fo.FONode#getExtensionAttachment() */ + /** {@inheritDoc} */ public ExtensionAttachment getExtensionAttachment() { return this.setupCode; } diff --git a/src/java/org/apache/fop/render/ps/extensions/PSExtensionElementMapping.java b/src/java/org/apache/fop/render/ps/extensions/PSExtensionElementMapping.java index 44b22284d..a2aed74ff 100644 --- a/src/java/org/apache/fop/render/ps/extensions/PSExtensionElementMapping.java +++ b/src/java/org/apache/fop/render/ps/extensions/PSExtensionElementMapping.java @@ -35,7 +35,7 @@ public class PSExtensionElementMapping extends ElementMapping { this.namespaceURI = NAMESPACE; } - /** @see org.apache.fop.fo.ElementMapping#initialize() */ + /** {@inheritDoc} */ protected void initialize() { if (foObjs == null) { foObjs = new java.util.HashMap(); diff --git a/src/java/org/apache/fop/render/ps/extensions/PSExtensionHandler.java b/src/java/org/apache/fop/render/ps/extensions/PSExtensionHandler.java index cd9f6b67d..071ec1c25 100644 --- a/src/java/org/apache/fop/render/ps/extensions/PSExtensionHandler.java +++ b/src/java/org/apache/fop/render/ps/extensions/PSExtensionHandler.java @@ -42,7 +42,7 @@ public class PSExtensionHandler extends DefaultHandler private PSSetupCode returnedObject; private ObjectBuiltListener listener; - /** @see org.xml.sax.helpers.DefaultHandler */ + /** {@inheritDoc} */ public void startElement(String uri, String localName, String qName, Attributes attributes) throws SAXException { boolean handled = false; @@ -66,7 +66,7 @@ public class PSExtensionHandler extends DefaultHandler } } - /** @see org.xml.sax.helpers.DefaultHandler */ + /** {@inheritDoc} */ public void endElement(String uri, String localName, String qName) throws SAXException { if (PSSetupCode.CATEGORY.equals(uri)) { if ("ps-setup-code".equals(localName)) { @@ -77,13 +77,13 @@ public class PSExtensionHandler extends DefaultHandler content.setLength(0); //Reset text buffer (see characters()) } - /** @see org.xml.sax.helpers.DefaultHandler#characters(char[], int, int) */ + /** {@inheritDoc} */ public void characters(char[] ch, int start, int length) throws SAXException { content.append(ch, start, length); } /** - * @see org.xml.sax.helpers.DefaultHandler#endDocument() + * {@inheritDoc} */ public void endDocument() throws SAXException { if (listener != null) { @@ -92,14 +92,14 @@ public class PSExtensionHandler extends DefaultHandler } /** - * @see org.apache.fop.util.ContentHandlerFactory.ObjectSource#getObject() + * {@inheritDoc} */ public Object getObject() { return returnedObject; } /** - * @see org.apache.fop.util.ContentHandlerFactory.ObjectSource + * {@inheritDoc} */ public void setObjectBuiltListener(ObjectBuiltListener listener) { this.listener = listener; diff --git a/src/java/org/apache/fop/render/ps/extensions/PSExtensionHandlerFactory.java b/src/java/org/apache/fop/render/ps/extensions/PSExtensionHandlerFactory.java index f268a4940..655c96260 100644 --- a/src/java/org/apache/fop/render/ps/extensions/PSExtensionHandlerFactory.java +++ b/src/java/org/apache/fop/render/ps/extensions/PSExtensionHandlerFactory.java @@ -29,12 +29,12 @@ public class PSExtensionHandlerFactory implements ContentHandlerFactory { private static final String[] NAMESPACES = new String[] {PSSetupCode.CATEGORY}; - /** @see org.apache.fop.util.ContentHandlerFactory#getSupportedNamespaces() */ + /** {@inheritDoc} */ public String[] getSupportedNamespaces() { return NAMESPACES; } - /** @see org.apache.fop.util.ContentHandlerFactory#createContentHandler() */ + /** {@inheritDoc} */ public ContentHandler createContentHandler() { return new PSExtensionHandler(); } diff --git a/src/java/org/apache/fop/render/ps/extensions/PSPageSetupCodeElement.java b/src/java/org/apache/fop/render/ps/extensions/PSPageSetupCodeElement.java index 4c7d7122c..98163a0bb 100644 --- a/src/java/org/apache/fop/render/ps/extensions/PSPageSetupCodeElement.java +++ b/src/java/org/apache/fop/render/ps/extensions/PSPageSetupCodeElement.java @@ -37,7 +37,7 @@ public class PSPageSetupCodeElement extends AbstractPSExtensionObject { super(parent); } - /** @see org.apache.fop.fo.FONode#startOfNode() */ + /** {@inheritDoc} */ protected void startOfNode() throws FOPException { super.startOfNode(); if (parent.getNameId() != Constants.FO_SIMPLE_PAGE_MASTER) { @@ -45,7 +45,7 @@ public class PSPageSetupCodeElement extends AbstractPSExtensionObject { } } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "ps-page-setup-code"; } diff --git a/src/java/org/apache/fop/render/ps/extensions/PSSetupCode.java b/src/java/org/apache/fop/render/ps/extensions/PSSetupCode.java index d18403974..7ad66427c 100644 --- a/src/java/org/apache/fop/render/ps/extensions/PSSetupCode.java +++ b/src/java/org/apache/fop/render/ps/extensions/PSSetupCode.java @@ -81,12 +81,12 @@ public class PSSetupCode implements ExtensionAttachment, Serializable, XMLizable this.name = name; } - /** @see org.apache.fop.fo.extensions.ExtensionAttachment#getCategory() */ + /** {@inheritDoc} */ public String getCategory() { return CATEGORY; } - /** @see java.lang.Object#toString() */ + /** {@inheritDoc} */ public String toString() { return "PSSetupCode(name=" + getName() + ")"; } @@ -94,7 +94,7 @@ public class PSSetupCode implements ExtensionAttachment, Serializable, XMLizable private static final String ATT_NAME = "name"; private static final String ELEMENT = "ps-setup-code"; - /** @see org.apache.fop.util.XMLizable#toSAX(org.xml.sax.ContentHandler) */ + /** {@inheritDoc} */ public void toSAX(ContentHandler handler) throws SAXException { AttributesImpl atts = new AttributesImpl(); if (name != null && name.length() > 0) { diff --git a/src/java/org/apache/fop/render/ps/extensions/PSSetupCodeElement.java b/src/java/org/apache/fop/render/ps/extensions/PSSetupCodeElement.java index 69158625f..a4f25323c 100644 --- a/src/java/org/apache/fop/render/ps/extensions/PSSetupCodeElement.java +++ b/src/java/org/apache/fop/render/ps/extensions/PSSetupCodeElement.java @@ -37,7 +37,7 @@ public class PSSetupCodeElement extends AbstractPSExtensionObject { super(parent); } - /** @see org.apache.fop.fo.FONode#startOfNode() */ + /** {@inheritDoc} */ protected void startOfNode() throws FOPException { super.startOfNode(); if (parent.getNameId() != Constants.FO_DECLARATIONS) { @@ -45,7 +45,7 @@ public class PSSetupCodeElement extends AbstractPSExtensionObject { } } - /** @see org.apache.fop.fo.FONode#getLocalName() */ + /** {@inheritDoc} */ public String getLocalName() { return "ps-setup-code"; } diff --git a/src/java/org/apache/fop/render/rtf/RTFFOEventHandlerMaker.java b/src/java/org/apache/fop/render/rtf/RTFFOEventHandlerMaker.java index 5d3be985d..40583253d 100644 --- a/src/java/org/apache/fop/render/rtf/RTFFOEventHandlerMaker.java +++ b/src/java/org/apache/fop/render/rtf/RTFFOEventHandlerMaker.java @@ -38,7 +38,7 @@ public class RTFFOEventHandlerMaker extends AbstractFOEventHandlerMaker { /**
- * @see org.apache.fop.render.AbstractFOEventHandlerMaker
+ * {@inheritDoc}
* @param ua FOUserAgent
* @param out OutputStream
* @return created RTFHandler
@@ -48,7 +48,7 @@ public class RTFFOEventHandlerMaker extends AbstractFOEventHandlerMaker { }
/**
- * @see org.apache.fop.render.AbstractFOEventHandlerMaker#needsOutputStream()
+ * {@inheritDoc}
* @return true, if an outputstream is needed
*/
public boolean needsOutputStream() {
@@ -56,7 +56,7 @@ public class RTFFOEventHandlerMaker extends AbstractFOEventHandlerMaker { }
/**
- * @see org.apache.fop.render.AbstractFOEventHandlerMaker#getSupportedMimeTypes()
+ * {@inheritDoc}
* @return array of MIME types
*/
public String[] getSupportedMimeTypes() {
diff --git a/src/java/org/apache/fop/render/rtf/RTFHandler.java b/src/java/org/apache/fop/render/rtf/RTFHandler.java index 4a142cffe..985e6dfd4 100644 --- a/src/java/org/apache/fop/render/rtf/RTFHandler.java +++ b/src/java/org/apache/fop/render/rtf/RTFHandler.java @@ -158,8 +158,7 @@ public class RTFHandler extends FOEventHandler { } /** - * @see org.apache.fop.fo.FOEventHandler#startDocument() - * @throws SAXException In case of a IO-problem + * {@inheritDoc} */ public void startDocument() throws SAXException { // TODO sections should be created @@ -173,8 +172,7 @@ public class RTFHandler extends FOEventHandler { } /** - * @see org.apache.fop.fo.FOEventHandler#endDocument() - * @throws SAXException In case of a IO-problem + * {@inheritDoc} */ public void endDocument() throws SAXException { try { @@ -186,8 +184,7 @@ public class RTFHandler extends FOEventHandler { } /** - * @see org.apache.fop.fo.FOEventHandler - * @param pageSeq PageSequence that is starting + * {@inheritDoc} */ public void startPageSequence(PageSequence pageSeq) { try { @@ -237,8 +234,7 @@ public class RTFHandler extends FOEventHandler { } /** - * @see org.apache.fop.fo.FOEventHandler#endPageSequence(PageSequence) - * @param pageSeq PageSequence that is ending + * {@inheritDoc} */ public void endPageSequence(PageSequence pageSeq) { if (bDefer) { @@ -258,8 +254,7 @@ public class RTFHandler extends FOEventHandler { } /** - * @see org.apache.fop.fo.FOEventHandler#startFlow(Flow) - * @param fl Flow that is starting + * {@inheritDoc} */ public void startFlow(Flow fl) { if (bDefer) { @@ -350,8 +345,7 @@ public class RTFHandler extends FOEventHandler { } /** - * @see org.apache.fop.fo.FOEventHandler#endFlow(Flow) - * @param fl Flow that is ending + * {@inheritDoc} */ public void endFlow(Flow fl) { if (bDefer) { @@ -378,8 +372,7 @@ public class RTFHandler extends FOEventHandler { } /** - * @see org.apache.fop.fo.FOEventHandler#startBlock(Block) - * @param bl Block that is starting + * {@inheritDoc} */ public void startBlock(Block bl) { if (bDefer) { @@ -412,8 +405,7 @@ public class RTFHandler extends FOEventHandler { /** - * @see org.apache.fop.fo.FOEventHandler#endBlock(Block) - * @param bl Block that is ending + * {@inheritDoc} */ public void endBlock(Block bl) { @@ -442,8 +434,7 @@ public class RTFHandler extends FOEventHandler { } /** - * @see org.apache.fop.fo.FOEventHandler#startBlockContainer(BlockContainer) - * @param blc BlockContainer that is starting + * {@inheritDoc} */ public void startBlockContainer(BlockContainer blc) { if (bDefer) { @@ -474,8 +465,7 @@ public class RTFHandler extends FOEventHandler { } /** - * @see org.apache.fop.fo.FOEventHandler#endBlockContainer(BlockContainer) - * @param bl BlockContainer that is ending + * {@inheritDoc} */ public void endBlockContainer(BlockContainer bl) { if (bDefer) { @@ -503,8 +493,7 @@ public class RTFHandler extends FOEventHandler { } /** - * @see org.apache.fop.fo.FOEventHandler#startTable(Table) - * @param tbl Table that is starting + * {@inheritDoc} */ public void startTable(Table tbl) { if (bDefer) { @@ -548,8 +537,7 @@ public class RTFHandler extends FOEventHandler { } /** - * @see org.apache.fop.fo.FOEventHandler#endTable(Table) - * @param tbl Table that is ending + * {@inheritDoc} */ public void endTable(Table tbl) { if (bDefer) { @@ -615,29 +603,25 @@ public class RTFHandler extends FOEventHandler { } /** - * @see org.apache.fop.fo.FOEventHandler#startHeader(TableBody) - * @param th TableBody that is starting + * {@inheritDoc} */ public void startHeader(TableBody th) { } /** - * @see org.apache.fop.fo.FOEventHandler#endHeader(TableBody) - * @param th TableBody that is ending + * {@inheritDoc} */ public void endHeader(TableBody th) { } /** - * @see org.apache.fop.fo.FOEventHandler#startFooter(TableBody) - * @param tf TableFooter that is starting + * {@inheritDoc} */ public void startFooter(TableBody tf) { } /** - * @see org.apache.fop.fo.FOEventHandler#endFooter(TableBody) - * @param tf TableFooter that is ending + * {@inheritDoc} */ public void endFooter(TableBody tf) { } @@ -700,8 +684,7 @@ public class RTFHandler extends FOEventHandler { } /** - * @see org.apache.fop.fo.FOEventHandler#startBody(TableBody) - * @param tb TableBody that is starting + * {@inheritDoc} */ public void startBody(TableBody tb) { if (bDefer) { @@ -720,8 +703,7 @@ public class RTFHandler extends FOEventHandler { } /** - * @see org.apache.fop.fo.FOEventHandler#endBody(TableBody) - * @param tb TableBody that is ending + * {@inheritDoc} */ public void endBody(TableBody tb) { if (bDefer) { @@ -738,8 +720,7 @@ public class RTFHandler extends FOEventHandler { } /** - * @see org.apache.fop.fo.FOEventHandler#startRow(TableRow) - * @param tr TableRow that is starting + * {@inheritDoc} */ public void startRow(TableRow tr) { if (bDefer) { @@ -769,8 +750,7 @@ public class RTFHandler extends FOEventHandler { } /** - * @see org.apache.fop.fo.FOEventHandler#endRow(TableRow) - * @param tr TableRow that is ending + * {@inheritDoc} */ public void endRow(TableRow tr) { if (bDefer) { @@ -807,8 +787,7 @@ public class RTFHandler extends FOEventHandler { } /** - * @see org.apache.fop.fo.FOEventHandler#startCell(TableCell) - * @param tc TableCell that is starting + * {@inheritDoc} */ public void startCell(TableCell tc) { if (bDefer) { @@ -896,8 +875,7 @@ public class RTFHandler extends FOEventHandler { } /** - * @see org.apache.fop.fo.FOEventHandler#endCell(TableCell) - * @param tc TableCell that is ending + * {@inheritDoc} */ public void endCell(TableCell tc) { if (bDefer) { @@ -910,8 +888,7 @@ public class RTFHandler extends FOEventHandler { // Lists /** - * @see org.apache.fop.fo.FOEventHandler#startList(ListBlock) - * @param lb ListBlock that is starting + * {@inheritDoc} */ public void startList(ListBlock lb) { if (bDefer) { @@ -939,8 +916,7 @@ public class RTFHandler extends FOEventHandler { } /** - * @see org.apache.fop.fo.FOEventHandler#endList(ListBlock) - * @param lb ListBlock that is ending + * {@inheritDoc} */ public void endList(ListBlock lb) { if (bDefer) { @@ -951,8 +927,7 @@ public class RTFHandler extends FOEventHandler { } /** - * @see org.apache.fop.fo.FOEventHandler#startListItem(ListItem) - * @param li ListItem that is starting + * {@inheritDoc} */ public void startListItem(ListItem li) { if (bDefer) { @@ -993,8 +968,7 @@ public class RTFHandler extends FOEventHandler { } /** - * @see org.apache.fop.fo.FOEventHandler#endListItem(ListItem) - * @param li ListItem that is ending + * {@inheritDoc} */ public void endListItem(ListItem li) { if (bDefer) { @@ -1005,7 +979,7 @@ public class RTFHandler extends FOEventHandler { } /** - * @see org.apache.fop.fo.FOEventHandler#startListLabel() + * {@inheritDoc} */ public void startListLabel() { if (bDefer) { @@ -1028,7 +1002,7 @@ public class RTFHandler extends FOEventHandler { } /** - * @see org.apache.fop.fo.FOEventHandler#endListLabel() + * {@inheritDoc} */ public void endListLabel() { if (bDefer) { @@ -1039,45 +1013,44 @@ public class RTFHandler extends FOEventHandler { } /** - * @see org.apache.fop.fo.FOEventHandler#startListBody() + * {@inheritDoc} */ public void startListBody() { } /** - * @see org.apache.fop.fo.FOEventHandler#endListBody() + * {@inheritDoc} */ public void endListBody() { } // Static Regions /** - * @see org.apache.fop.fo.FOEventHandler#startStatic() + * {@inheritDoc} */ public void startStatic() { } /** - * @see org.apache.fop.fo.FOEventHandler#endStatic() + * {@inheritDoc} */ public void endStatic() { } /** - * @see org.apache.fop.fo.FOEventHandler#startMarkup() + * {@inheritDoc} */ public void startMarkup() { } /** - * @see org.apache.fop.fo.FOEventHandler#endMarkup() + * {@inheritDoc} */ public void endMarkup() { } /** - * @see org.apache.fop.fo.FOEventHandler#startLink(BasicLink basicLink) - * @param basicLink BasicLink that is starting + * {@inheritDoc} */ public void startLink(BasicLink basicLink) { if (bDefer) { @@ -1111,7 +1084,7 @@ public class RTFHandler extends FOEventHandler { } /** - * @see org.apache.fop.fo.FOEventHandler#endLink() + * {@inheritDoc} */ public void endLink() { if (bDefer) { @@ -1122,8 +1095,7 @@ public class RTFHandler extends FOEventHandler { } /** - * @see org.apache.fop.fo.FOEventHandler#image(ExternalGraphic) - * @param eg ExternalGraphic that is starting + * {@inheritDoc} */ public void image(ExternalGraphic eg) { if (bDefer) { @@ -1155,8 +1127,7 @@ public class RTFHandler extends FOEventHandler { } /** - * @see org.apache.fop.fo.FOEventHandler#foreignObject(InstreamForeignObject) - * @param ifo InstreamForeignObject that is starting + * {@inheritDoc} */ public void foreignObject(InstreamForeignObject ifo) { if (bDefer) { @@ -1330,14 +1301,13 @@ public class RTFHandler extends FOEventHandler { } /** - * @see org.apache.fop.fo.FOEventHandler#pageRef() + * {@inheritDoc} */ public void pageRef() { } /** - * @see org.apache.fop.fo.FOEventHandler#startFootnote(Footnote) - * @param footnote Footnote that is starting + * {@inheritDoc} */ public void startFootnote(Footnote footnote) { if (bDefer) { @@ -1366,8 +1336,7 @@ public class RTFHandler extends FOEventHandler { } /** - * @see org.apache.fop.fo.FOEventHandler#endFootnote(Footnote) - * @param footnote Footnote that is ending + * {@inheritDoc} */ public void endFootnote(Footnote footnote) { if (bDefer) { @@ -1378,8 +1347,7 @@ public class RTFHandler extends FOEventHandler { } /** - * @see org.apache.fop.fo.FOEventHandler#startFootnoteBody(FootnoteBody) - * @param body FootnoteBody that is starting + * {@inheritDoc} */ public void startFootnoteBody(FootnoteBody body) { if (bDefer) { @@ -1404,8 +1372,7 @@ public class RTFHandler extends FOEventHandler { } /** - * @see org.apache.fop.fo.FOEventHandler#endFootnoteBody(FootnoteBody) - * @param body FootnoteBody that is ending + * {@inheritDoc} */ public void endFootnoteBody(FootnoteBody body) { if (bDefer) { @@ -1430,8 +1397,7 @@ public class RTFHandler extends FOEventHandler { } /** - * @see org.apache.fop.fo.FOEventHandler#leader(Leader) - * @param l Leader that is starting + * {@inheritDoc} */ public void leader(Leader l) { } diff --git a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfExternalGraphic.java b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfExternalGraphic.java index eccac81c1..a79679450 100644 --- a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfExternalGraphic.java +++ b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfExternalGraphic.java @@ -563,7 +563,7 @@ public class RtfExternalGraphic extends RtfElement { /** * Sets the binary imagedata of the image. * - * @param imagedata Binary imagedata as read from file. + * @param data binary imagedata as read from file. * @throws IOException On error */ public void setImageData(byte[] data) throws IOException { diff --git a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfGenerator.java b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfGenerator.java index bc3fae7b0..8e07ae86a 100644 --- a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfGenerator.java +++ b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfGenerator.java @@ -33,7 +33,7 @@ public class RtfGenerator extends RtfElement { } /** - * @see org.apache.fop.render.rtf.rtflib.rtfdoc.RtfElement#writeRtfContent() + * {@inheritDoc} */ protected void writeRtfContent() throws IOException { newLine(); @@ -45,7 +45,7 @@ public class RtfGenerator extends RtfElement { } /** - * @see org.apache.fop.render.rtf.rtflib.rtfdoc.RtfElement#isEmpty() + * {@inheritDoc} */ public boolean isEmpty() { return false; diff --git a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfListStyleBullet.java b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfListStyleBullet.java index c39797924..15ffc9163 100644 --- a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfListStyleBullet.java +++ b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfListStyleBullet.java @@ -40,7 +40,7 @@ public class RtfListStyleBullet extends RtfListStyle { /** * Gets called before a RtfListItem has to be written. * @param item RtfListItem whose prefix has to be written - * @see org.apache.fop.render.rtf.rtflib.rtfdoc.RtfListStyle#writeListPrefix(RtfListItem) + * {@inheritDoc} * @throws IOException Thrown when an IO-problem occurs */ public void writeListPrefix(RtfListItem item) throws IOException { @@ -62,7 +62,7 @@ public class RtfListStyleBullet extends RtfListStyle { /** * Gets called before a paragraph, which is contained by a RtfListItem has to be written. * @param element RtfElement in whose context is to be written - * @see org.apache.fop.render.rtf.rtflib.rtfdoc.RtfListStyle#writeParagraphPrefix(RtfElement) + * {@inheritDoc} * @throws IOException Thrown when an IO-problem occurs */ public void writeParagraphPrefix(RtfElement element) throws IOException { @@ -75,7 +75,7 @@ public class RtfListStyleBullet extends RtfListStyle { * Gets called when the list table has to be written. * * @param element RtfElement in whose context is to be written - * @see org.apache.fop.render.rtf.rtflib.rtfdoc.RtfListStyle#writeLevelGroup(RtfElement) + * {@inheritDoc} * @throws IOException Thrown when an IO-problem occurs */ public void writeLevelGroup(RtfElement element) throws IOException { diff --git a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfListStyleNumber.java b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfListStyleNumber.java index 874d909fe..926614f8a 100644 --- a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfListStyleNumber.java +++ b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfListStyleNumber.java @@ -40,7 +40,7 @@ public class RtfListStyleNumber extends RtfListStyle { /** * Gets called before a RtfListItem has to be written. * @param item RtfListItem whose prefix has to be written - * @see org.apache.fop.render.rtf.rtflib.rtfdoc.RtfListStyle#writeListPrefix(RtfListItem) + * {@inheritDoc} * @throws IOException Thrown when an IO-problem occurs */ public void writeListPrefix(RtfListItem item) @@ -59,7 +59,7 @@ public class RtfListStyleNumber extends RtfListStyle { * Gets called before a paragraph, which is contained by a RtfListItem has to be written. * * @param element RtfElement in whose context is to be written - * @see org.apache.fop.render.rtf.rtflib.rtfdoc.RtfListStyle#writeParagraphPrefix(RtfElement) + * {@inheritDoc} * @throws IOException Thrown when an IO-problem occurs */ public void writeParagraphPrefix(RtfElement element) @@ -76,7 +76,7 @@ public class RtfListStyleNumber extends RtfListStyle { * Gets called when the list table has to be written. * * @param element RtfElement in whose context is to be written - * @see org.apache.fop.render.rtf.rtflib.rtfdoc.RtfListStyle#writeLevelGroup(RtfElement) + * {@inheritDoc} * @throws IOException Thrown when an IO-problem occurs */ public void writeLevelGroup(RtfElement element) diff --git a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfListStyleText.java b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfListStyleText.java index a637ec4b7..48c987d2d 100644 --- a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfListStyleText.java +++ b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfListStyleText.java @@ -49,7 +49,7 @@ public class RtfListStyleText extends RtfListStyle { /** * Gets called before a RtfListItem has to be written. * @param item RtfListItem whose prefix has to be written - * @see org.apache.fop.render.rtf.rtflib.rtfdoc.RtfListStyle#writeListPrefix(RtfListItem) + * {@inheritDoc} * @throws IOException Thrown when an IO-problem occurs */ public void writeListPrefix(RtfListItem item) @@ -73,7 +73,7 @@ public class RtfListStyleText extends RtfListStyle { * Gets called before a paragraph, which is contained by a RtfListItem has to be written. * * @param element RtfElement in whose context is to be written - * @see org.apache.fop.render.rtf.rtflib.rtfdoc.RtfListStyle#writeParagraphPrefix(RtfElement) + * {@inheritDoc} * @throws IOException Thrown when an IO-problem occurs */ public void writeParagraphPrefix(RtfElement element) @@ -87,7 +87,7 @@ public class RtfListStyleText extends RtfListStyle { * Gets called when the list table has to be written. * * @param element RtfElement in whose context is to be written - * @see org.apache.fop.render.rtf.rtflib.rtfdoc.RtfListStyle#writeLevelGroup(RtfElement) + * {@inheritDoc} * @throws IOException Thrown when an IO-problem occurs */ public void writeLevelGroup(RtfElement element) diff --git a/src/java/org/apache/fop/render/txt/Helper.java b/src/java/org/apache/fop/render/txt/Helper.java index e00e930c2..f2bd14914 100644 --- a/src/java/org/apache/fop/render/txt/Helper.java +++ b/src/java/org/apache/fop/render/txt/Helper.java @@ -110,7 +110,7 @@ public final class Helper { * @param y integer, fraction denominator * @return the largest integer that is less than or equal to * the argument and is equal to <code>x/y</code> fraction - * @see java.lang.Math#ceil(double) + * @see java.lang.Math#floor(double) */ public static int floorPosition(int x, int y) { return floor(x, y) / y; diff --git a/src/java/org/apache/fop/render/txt/TXTRenderer.java b/src/java/org/apache/fop/render/txt/TXTRenderer.java index cec1dbc4b..f1d959553 100644 --- a/src/java/org/apache/fop/render/txt/TXTRenderer.java +++ b/src/java/org/apache/fop/render/txt/TXTRenderer.java @@ -109,7 +109,7 @@ public class TXTRenderer extends AbstractPathOrientedRenderer { public TXTRenderer() { } - /** @see org.apache.fop.render.AbstractRenderer#getMimeType() */ + /** {@inheritDoc} */ public String getMimeType() { return "text/plain"; } @@ -195,7 +195,7 @@ public class TXTRenderer extends AbstractPathOrientedRenderer { } /** - * @see org.apache.fop.render.Renderer#renderPage(PageViewport) + * {@inheritDoc} */ public void renderPage(PageViewport page) throws IOException, FOPException { if (firstPage) { @@ -282,7 +282,7 @@ public class TXTRenderer extends AbstractPathOrientedRenderer { } /** - * @see org.apache.fop.render.Renderer#startRenderer(java.io.OutputStream) + * {@inheritDoc} */ public void startRenderer(OutputStream os) throws IOException { log.info("Rendering areas to TEXT."); @@ -293,7 +293,7 @@ public class TXTRenderer extends AbstractPathOrientedRenderer { } /** - * @see org.apache.fop.render.Renderer#stopRenderer() + * {@inheritDoc} */ public void stopRenderer() throws IOException { log.info("writing out TEXT"); @@ -303,7 +303,7 @@ public class TXTRenderer extends AbstractPathOrientedRenderer { /** * Does nothing. - * @see org.apache.fop.render.AbstractPathOrientedRenderer + * {@inheritDoc} */ protected void restoreStateStackAfterBreakOut(List breakOutList) { } @@ -311,7 +311,7 @@ public class TXTRenderer extends AbstractPathOrientedRenderer { /** * Does nothing. * @return null - * @see org.apache.fop.render.AbstractPathOrientedRenderer + * {@inheritDoc} */ protected List breakOutOfStateStack() { return null; @@ -319,63 +319,63 @@ public class TXTRenderer extends AbstractPathOrientedRenderer { /** * Does nothing. - * @see org.apache.fop.render.AbstractPathOrientedRenderer + * {@inheritDoc} */ protected void saveGraphicsState() { } /** * Does nothing. - * @see org.apache.fop.render.AbstractPathOrientedRenderer + * {@inheritDoc} */ protected void restoreGraphicsState() { } /** * Does nothing. - * @see org.apache.fop.render.AbstractPathOrientedRenderer + * {@inheritDoc} */ protected void beginTextObject() { } /** * Does nothing. - * @see org.apache.fop.render.AbstractPathOrientedRenderer + * {@inheritDoc} */ protected void endTextObject() { } /** * Does nothing. - * @see org.apache.fop.render.AbstractPathOrientedRenderer + * {@inheritDoc} */ protected void clip() { } /** * Does nothing. - * @see org.apache.fop.render.AbstractPathOrientedRenderer + * {@inheritDoc} */ protected void clipRect(float x, float y, float width, float height) { } /** * Does nothing. - * @see org.apache.fop.render.AbstractPathOrientedRenderer + * {@inheritDoc} */ protected void moveTo(float x, float y) { } /** * Does nothing. - * @see org.apache.fop.render.AbstractPathOrientedRenderer + * {@inheritDoc} */ protected void lineTo(float x, float y) { } /** * Does nothing. - * @see org.apache.fop.render.AbstractPathOrientedRenderer + * {@inheritDoc} */ protected void closePath() { } @@ -401,7 +401,7 @@ public class TXTRenderer extends AbstractPathOrientedRenderer { /** * Fills a rectangular area with the current filling char. - * @see org.apache.fop.render.AbstractPathOrientedRenderer + * {@inheritDoc} */ protected void fillRect(float x, float y, float width, float height) { fillRect(bm.getStartX(), bm.getStartY(), bm.getWidth(), bm.getHeight(), @@ -410,7 +410,7 @@ public class TXTRenderer extends AbstractPathOrientedRenderer { /** * Changes current filling char. - * @see org.apache.fop.render.AbstractPathOrientedRenderer + * {@inheritDoc} */ protected void updateColor(Color col, boolean fill) { if (col == null) { @@ -438,17 +438,16 @@ public class TXTRenderer extends AbstractPathOrientedRenderer { } } - /** - * @see org.apache.fop.render.AbstractPathOrientedRenderer#drawImage( - * java.lang.String, java.awt.geom.Rectangle2D, java.util.Map) - */ + /** {@inheritDoc} */ protected void drawImage(String url, Rectangle2D pos, Map foreignAttributes) { //No images are painted here } /** * Fills image rectangle with a <code>IMAGE_CHAR</code>. - * @see org.apache.fop.render.AbstractPathOrientedRenderer + * + * @param image the base image + * @param pos the position of the image */ public void renderImage(Image image, Rectangle2D pos) { int x1 = Helper.ceilPosition(currentIPPosition, CHAR_WIDTH); @@ -488,7 +487,7 @@ public class TXTRenderer extends AbstractPathOrientedRenderer { } /** - * @see org.apache.fop.render.AbstractPathOrientedRenderer + * {@inheritDoc} */ protected void drawBorderLine(float x1, float y1, float x2, float y2, boolean horz, boolean startOrBefore, int style, Color col) { @@ -540,7 +539,7 @@ public class TXTRenderer extends AbstractPathOrientedRenderer { } /** - * @see org.apache.fop.render.AbstractPathOrientedRenderer + * {@inheritDoc} */ protected void drawBackAndBorders(Area area, float startx, float starty, float width, float height) { @@ -553,14 +552,14 @@ public class TXTRenderer extends AbstractPathOrientedRenderer { } /** - * @see org.apache.fop.render.AbstractRenderer#startVParea(CTM, Rectangle2D) + * {@inheritDoc} */ protected void startVParea(CTM ctm, Rectangle2D clippingRect) { currentState.push(ctm); } /** - * @see org.apache.fop.render.AbstractRenderer#endVParea() + * {@inheritDoc} */ protected void endVParea() { currentState.pop(); diff --git a/src/java/org/apache/fop/render/txt/TXTRendererMaker.java b/src/java/org/apache/fop/render/txt/TXTRendererMaker.java index 8a92ed11d..b18c3faa0 100644 --- a/src/java/org/apache/fop/render/txt/TXTRendererMaker.java +++ b/src/java/org/apache/fop/render/txt/TXTRendererMaker.java @@ -32,22 +32,22 @@ public class TXTRendererMaker extends AbstractRendererMaker { private static final String[] MIMES = new String[] {MimeConstants.MIME_PLAIN_TEXT};
- /**@see org.apache.fop.render.AbstractRendererMaker#makeRenderer(FOUserAgent) */
+ /**{@inheritDoc} */
public Renderer makeRenderer(FOUserAgent userAgent) {
return new TXTRenderer();
}
- /**@see org.apache.fop.render.AbstractRendererMaker#getConfigurator(FOUserAgent) */
+ /**{@inheritDoc} */
public RendererConfigurator getConfigurator(FOUserAgent userAgent) {
return new TXTRendererConfigurator(userAgent);
}
- /** @see org.apache.fop.render.AbstractRendererMaker#needsOutputStream() */
+ /** {@inheritDoc} */
public boolean needsOutputStream() {
return true;
}
- /** @see org.apache.fop.render.AbstractRendererMaker#getSupportedMimeTypes() */
+ /** {@inheritDoc} */
public String[] getSupportedMimeTypes() {
return MIMES;
}
diff --git a/src/java/org/apache/fop/render/txt/border/DashedBorderElement.java b/src/java/org/apache/fop/render/txt/border/DashedBorderElement.java index 97c98388a..d91179845 100644 --- a/src/java/org/apache/fop/render/txt/border/DashedBorderElement.java +++ b/src/java/org/apache/fop/render/txt/border/DashedBorderElement.java @@ -125,7 +125,7 @@ public class DashedBorderElement extends AbstractBorderElement { } /** - * @see org.apache.fop.render.txt.border.AbstractBorderElement#convert2Char() + * {@inheritDoc} */ public char convert2Char() { int key = 0; diff --git a/src/java/org/apache/fop/render/txt/border/DottedBorderElement.java b/src/java/org/apache/fop/render/txt/border/DottedBorderElement.java index b3871658c..e5930fcb3 100644 --- a/src/java/org/apache/fop/render/txt/border/DottedBorderElement.java +++ b/src/java/org/apache/fop/render/txt/border/DottedBorderElement.java @@ -38,7 +38,7 @@ public class DottedBorderElement extends AbstractBorderElement { } /** - * @see org.apache.fop.render.txt.border.AbstractBorderElement#convert2Char() + * {@inheritDoc} */ public char convert2Char() { return MIDDLE_DOT; diff --git a/src/java/org/apache/fop/render/txt/border/SolidAndDoubleBorderElement.java b/src/java/org/apache/fop/render/txt/border/SolidAndDoubleBorderElement.java index f41ca092f..b14ecabe7 100644 --- a/src/java/org/apache/fop/render/txt/border/SolidAndDoubleBorderElement.java +++ b/src/java/org/apache/fop/render/txt/border/SolidAndDoubleBorderElement.java @@ -264,7 +264,7 @@ public class SolidAndDoubleBorderElement extends AbstractBorderElement { } /** - * @see org.apache.fop.render.txt.border.AbstractBorderElement#convert2Char() + * {@inheritDoc} */ public char convert2Char() { char ch = map2Char(); diff --git a/src/java/org/apache/fop/render/xml/XMLRenderer.java b/src/java/org/apache/fop/render/xml/XMLRenderer.java index b95ea7e18..9e5fd8dbc 100644 --- a/src/java/org/apache/fop/render/xml/XMLRenderer.java +++ b/src/java/org/apache/fop/render/xml/XMLRenderer.java @@ -93,8 +93,8 @@ import org.apache.fop.util.XMLizable; * Renderer that renders areas to XML for debugging purposes. * This creates an xml that contains the information of the area * tree. It does not output any state or derived information. - * The output can be used to build a new area tree (@see AreaTreeBuilder) - * which can be rendered to any renderer. + * The output can be used to build a new area tree which can be + * rendered to any renderer. */ public class XMLRenderer extends PrintRenderer { @@ -137,7 +137,7 @@ public class XMLRenderer extends PrintRenderer { } /** - * @see org.apache.fop.render.Renderer#setUserAgent(FOUserAgent) + * {@inheritDoc} */ public void setUserAgent(FOUserAgent agent) { super.setUserAgent(agent); @@ -159,7 +159,7 @@ public class XMLRenderer extends PrintRenderer { this.mimic = renderer; } - /** @see org.apache.fop.render.PrintRenderer#setupFontInfo(org.apache.fop.fonts.FontInfo) */ + /** {@inheritDoc} */ public void setupFontInfo(FontInfo inFontInfo) { if (mimic != null) { mimic.setupFontInfo(inFontInfo); @@ -415,7 +415,7 @@ public class XMLRenderer extends PrintRenderer { } } - /** @see org.apache.fop.render.AbstractRenderer#processOffDocumentItem(OffDocumentItem) */ + /** {@inheritDoc} */ public void processOffDocumentItem(OffDocumentItem oDI) { if (oDI instanceof BookmarkData) { renderBookmarkTree((BookmarkData) oDI); @@ -466,7 +466,7 @@ public class XMLRenderer extends PrintRenderer { } /** - * @see org.apache.fop.render.Renderer#startRenderer(OutputStream) + * {@inheritDoc} */ public void startRenderer(OutputStream outputStream) throws IOException { @@ -499,7 +499,7 @@ public class XMLRenderer extends PrintRenderer { } /** - * @see org.apache.fop.render.Renderer#stopRenderer() + * {@inheritDoc} */ public void stopRenderer() throws IOException { endPageSequence(); @@ -516,7 +516,7 @@ public class XMLRenderer extends PrintRenderer { } /** - * @see org.apache.fop.render.Renderer#renderPage(PageViewport) + * {@inheritDoc} */ public void renderPage(PageViewport page) throws IOException, FOPException { atts.clear(); @@ -565,7 +565,7 @@ public class XMLRenderer extends PrintRenderer { } /** - * @see org.apache.fop.render.Renderer#startPageSequence(LineArea) + * {@inheritDoc} */ public void startPageSequence(LineArea seqTitle) { handleDocumentExtensionAttachments(); @@ -596,7 +596,7 @@ public class XMLRenderer extends PrintRenderer { } /** - * @see org.apache.fop.render.AbstractRenderer#renderRegionViewport(RegionViewport) + * {@inheritDoc} */ protected void renderRegionViewport(RegionViewport port) { if (port != null) { @@ -644,18 +644,18 @@ public class XMLRenderer extends PrintRenderer { } } - /** @see org.apache.fop.render.AbstractRenderer */ + /** {@inheritDoc} */ protected void startVParea(CTM ctm, Rectangle2D clippingRect) { //only necessary for graphical output } - /** @see org.apache.fop.render.AbstractRenderer#endVParea() */ + /** {@inheritDoc} */ protected void endVParea() { //only necessary for graphical output } /** - * @see org.apache.fop.render.AbstractRenderer#renderInlineAreaBackAndBorders( + * {@inheritDoc} * org.apache.fop.area.inline.InlineArea) */ protected void renderInlineAreaBackAndBorders(InlineArea area) { @@ -663,7 +663,7 @@ public class XMLRenderer extends PrintRenderer { } /** - * @see org.apache.fop.render.AbstractRenderer#renderBeforeFloat(BeforeFloat) + * {@inheritDoc} */ protected void renderBeforeFloat(BeforeFloat bf) { startElement("beforeFloat"); @@ -672,7 +672,7 @@ public class XMLRenderer extends PrintRenderer { } /** - * @see org.apache.fop.render.AbstractRenderer#renderFootnote(Footnote) + * {@inheritDoc} */ protected void renderFootnote(Footnote footnote) { startElement("footnote"); @@ -681,7 +681,7 @@ public class XMLRenderer extends PrintRenderer { } /** - * @see org.apache.fop.render.AbstractRenderer#renderMainReference(MainReference) + * {@inheritDoc} */ protected void renderMainReference(MainReference mr) { atts.clear(); @@ -714,7 +714,7 @@ public class XMLRenderer extends PrintRenderer { } /** - * @see org.apache.fop.render.AbstractRenderer#renderFlow(NormalFlow) + * {@inheritDoc} */ protected void renderFlow(NormalFlow flow) { // the normal flow reference area contains stacked blocks @@ -727,7 +727,7 @@ public class XMLRenderer extends PrintRenderer { } /** - * @see org.apache.fop.render.AbstractRenderer#renderBlock(Block) + * {@inheritDoc} */ protected void renderBlock(Block block) { atts.clear(); @@ -775,7 +775,7 @@ public class XMLRenderer extends PrintRenderer { } /** - * @see org.apache.fop.render.AbstractRenderer#renderLineArea(LineArea) + * {@inheritDoc} */ protected void renderLineArea(LineArea line) { atts.clear(); @@ -787,7 +787,7 @@ public class XMLRenderer extends PrintRenderer { } /** - * @see org.apache.fop.render.AbstractRenderer#renderInlineArea(InlineArea) + * {@inheritDoc} */ protected void renderInlineArea(InlineArea inlineArea) { atts.clear(); @@ -805,7 +805,7 @@ public class XMLRenderer extends PrintRenderer { } /** - * @see org.apache.fop.render.AbstractRenderer#renderViewport(Viewport) + * {@inheritDoc} */ protected void renderViewport(Viewport viewport) { atts.clear(); @@ -822,7 +822,7 @@ public class XMLRenderer extends PrintRenderer { } /** - * @see org.apache.fop.render.AbstractRenderer + * {@inheritDoc} */ public void renderImage(Image image, Rectangle2D pos) { atts.clear(); @@ -835,7 +835,7 @@ public class XMLRenderer extends PrintRenderer { } /** - * @see org.apache.fop.render.AbstractRenderer#renderContainer(Container) + * {@inheritDoc} */ public void renderContainer(Container cont) { startElement("container"); @@ -863,7 +863,7 @@ public class XMLRenderer extends PrintRenderer { } /** - * @see org.apache.fop.render.AbstractRenderer#renderInlineSpace(Space) + * {@inheritDoc} */ protected void renderInlineSpace(Space space) { atts.clear(); @@ -875,7 +875,7 @@ public class XMLRenderer extends PrintRenderer { } /** - * @see org.apache.fop.render.AbstractRenderer#renderText(TextArea) + * {@inheritDoc} */ protected void renderText(TextArea text) { atts.clear(); @@ -895,7 +895,7 @@ public class XMLRenderer extends PrintRenderer { } /** - * @see org.apache.fop.render.AbstractRenderer#renderWord(WordArea) + * {@inheritDoc} */ protected void renderWord(WordArea word) { atts.clear(); @@ -922,7 +922,7 @@ public class XMLRenderer extends PrintRenderer { } /** - * @see org.apache.fop.render.AbstractRenderer#renderSpace(SpaceArea) + * {@inheritDoc} */ protected void renderSpace(SpaceArea space) { atts.clear(); @@ -937,7 +937,7 @@ public class XMLRenderer extends PrintRenderer { } /** - * @see org.apache.fop.render.AbstractRenderer#renderInlineParent(InlineParent) + * {@inheritDoc} */ protected void renderInlineParent(InlineParent ip) { atts.clear(); @@ -950,7 +950,7 @@ public class XMLRenderer extends PrintRenderer { } /** - * @see org.apache.fop.render.AbstractRenderer#renderInlineBlockParent(InlineBlockParent) + * {@inheritDoc} */ protected void renderInlineBlockParent(InlineBlockParent ibp) { atts.clear(); @@ -963,7 +963,7 @@ public class XMLRenderer extends PrintRenderer { } /** - * @see org.apache.fop.render.AbstractRenderer#renderLeader(Leader) + * {@inheritDoc} */ protected void renderLeader(Leader area) { atts.clear(); @@ -977,7 +977,7 @@ public class XMLRenderer extends PrintRenderer { super.renderLeader(area); } - /** @see org.apache.fop.render.AbstractRenderer#getMimeType() */ + /** {@inheritDoc} */ public String getMimeType() { return XML_MIME_TYPE; } diff --git a/src/java/org/apache/fop/render/xml/XMLRendererMaker.java b/src/java/org/apache/fop/render/xml/XMLRendererMaker.java index 582cfb9be..3ed62a6e1 100644 --- a/src/java/org/apache/fop/render/xml/XMLRendererMaker.java +++ b/src/java/org/apache/fop/render/xml/XMLRendererMaker.java @@ -33,22 +33,22 @@ public class XMLRendererMaker extends AbstractRendererMaker { private static final String[] MIMES = new String[] {MimeConstants.MIME_FOP_AREA_TREE};
- /**@see org.apache.fop.render.AbstractRendererMaker#makeRenderer(FOUserAgent) */
+ /**{@inheritDoc} */
public Renderer makeRenderer(FOUserAgent userAgent) {
return new XMLRenderer();
}
- /**@see org.apache.fop.render.AbstractRendererMaker#getConfigurator(FOUserAgent) */
+ /**{@inheritDoc} */
public RendererConfigurator getConfigurator(FOUserAgent userAgent) {
return new PrintRendererConfigurator(userAgent);
}
- /** @see org.apache.fop.render.AbstractRendererMaker#needsOutputStream() */
+ /** {@inheritDoc} */
public boolean needsOutputStream() {
return true;
}
- /** @see org.apache.fop.render.AbstractRendererMaker#getSupportedMimeTypes() */
+ /** {@inheritDoc} */
public String[] getSupportedMimeTypes() {
return MIMES;
}
diff --git a/src/java/org/apache/fop/render/xml/XMLXMLHandler.java b/src/java/org/apache/fop/render/xml/XMLXMLHandler.java index 50815966d..d1cf1cf9a 100644 --- a/src/java/org/apache/fop/render/xml/XMLXMLHandler.java +++ b/src/java/org/apache/fop/render/xml/XMLXMLHandler.java @@ -34,7 +34,7 @@ public class XMLXMLHandler implements XMLHandler { /** Key for getting the TransformerHandler from the RendererContext */ public static final String HANDLER = "handler"; - /** @see org.apache.fop.render.XMLHandler */ + /** {@inheritDoc} */ public void handleXML(RendererContext context, org.w3c.dom.Document doc, String ns) throws Exception { ContentHandler handler = (ContentHandler) context.getProperty(HANDLER); @@ -42,12 +42,12 @@ public class XMLXMLHandler implements XMLHandler { new DOM2SAX(handler).writeDocument(doc, true); } - /** @see org.apache.fop.render.XMLHandler#supportsRenderer(org.apache.fop.render.Renderer) */ + /** {@inheritDoc} */ public boolean supportsRenderer(Renderer renderer) { return (renderer instanceof XMLRenderer); } - /** @see org.apache.fop.render.XMLHandler#getNamespace() */ + /** {@inheritDoc} */ public String getNamespace() { return null; //Handle all XML content } diff --git a/src/java/org/apache/fop/servlet/FopPrintServlet.java b/src/java/org/apache/fop/servlet/FopPrintServlet.java index 096975c30..f99468743 100644 --- a/src/java/org/apache/fop/servlet/FopPrintServlet.java +++ b/src/java/org/apache/fop/servlet/FopPrintServlet.java @@ -62,8 +62,7 @@ import org.apache.fop.apps.MimeConstants; public class FopPrintServlet extends FopServlet { /** - * @see org.apache.fop.servlet.FopServlet#render(javax.xml.transform.Source, - * javax.xml.transform.Transformer, javax.servlet.http.HttpServletResponse) + * {@inheritDoc} */ protected void render(Source src, Transformer transformer, HttpServletResponse response) throws FOPException, TransformerException, IOException { diff --git a/src/java/org/apache/fop/servlet/FopServlet.java b/src/java/org/apache/fop/servlet/FopServlet.java index 4fc888391..173e622dd 100644 --- a/src/java/org/apache/fop/servlet/FopServlet.java +++ b/src/java/org/apache/fop/servlet/FopServlet.java @@ -88,7 +88,7 @@ public class FopServlet extends HttpServlet { protected URIResolver uriResolver; /** - * @see javax.servlet.GenericServlet#init() + * {@inheritDoc} */ public void init() throws ServletException { this.log = new SimpleLog("FOP/Servlet"); @@ -111,7 +111,7 @@ public class FopServlet extends HttpServlet { } /** - * @see javax.servlet.http.HttpServlet#doGet(HttpServletRequest, HttpServletResponse) + * {@inheritDoc} */ public void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException { diff --git a/src/java/org/apache/fop/servlet/ServletContextURIResolver.java b/src/java/org/apache/fop/servlet/ServletContextURIResolver.java index 57f716d35..48bd2d6cb 100644 --- a/src/java/org/apache/fop/servlet/ServletContextURIResolver.java +++ b/src/java/org/apache/fop/servlet/ServletContextURIResolver.java @@ -48,7 +48,7 @@ public class ServletContextURIResolver implements URIResolver { this.servletContext = servletContext; } - /** @see javax.xml.transform.URIResolver#resolve(java.lang.String, java.lang.String) */ + /** {@inheritDoc} */ public Source resolve(String href, String base) throws TransformerException { if (href.startsWith(SERVLET_CONTEXT_PROTOCOL)) { return resolveServletContextURI(href.substring(SERVLET_CONTEXT_PROTOCOL.length())); diff --git a/src/java/org/apache/fop/svg/AbstractFOPTranscoder.java b/src/java/org/apache/fop/svg/AbstractFOPTranscoder.java index b11615853..3a03db023 100644 --- a/src/java/org/apache/fop/svg/AbstractFOPTranscoder.java +++ b/src/java/org/apache/fop/svg/AbstractFOPTranscoder.java @@ -137,7 +137,7 @@ public abstract class AbstractFOPTranscoder extends SVGAbstractTranscoder protected class FOPErrorHandler implements ErrorHandler { /** - * @see org.apache.batik.transcoder.ErrorHandler#error(TranscoderException) + * {@inheritDoc} */ public void error(TranscoderException te) throws TranscoderException { @@ -145,7 +145,7 @@ public abstract class AbstractFOPTranscoder extends SVGAbstractTranscoder } /** - * @see org.apache.batik.transcoder.ErrorHandler#fatalError(TranscoderException) + * {@inheritDoc} */ public void fatalError(TranscoderException te) throws TranscoderException { @@ -153,7 +153,7 @@ public abstract class AbstractFOPTranscoder extends SVGAbstractTranscoder } /** - * @see org.apache.batik.transcoder.ErrorHandler#warning(TranscoderException) + * {@inheritDoc} */ public void warning(TranscoderException te) throws TranscoderException { diff --git a/src/java/org/apache/fop/svg/FOPSAXSVGDocumentFactory.java b/src/java/org/apache/fop/svg/FOPSAXSVGDocumentFactory.java index 8efb858b2..e265613fa 100644 --- a/src/java/org/apache/fop/svg/FOPSAXSVGDocumentFactory.java +++ b/src/java/org/apache/fop/svg/FOPSAXSVGDocumentFactory.java @@ -52,7 +52,7 @@ public class FOPSAXSVGDocumentFactory extends SAXSVGDocumentFactory { } /** - * @see org.xml.sax.EntityResolver#resolveEntity(String, String) + * {@inheritDoc} */ public InputSource resolveEntity(String publicId, String systemId) throws SAXException { diff --git a/src/java/org/apache/fop/svg/PDFBridgeContext.java b/src/java/org/apache/fop/svg/PDFBridgeContext.java index 3d5fc4e6d..3353bc0f2 100644 --- a/src/java/org/apache/fop/svg/PDFBridgeContext.java +++ b/src/java/org/apache/fop/svg/PDFBridgeContext.java @@ -79,7 +79,7 @@ public class PDFBridgeContext extends BridgeContext { this(userAgent, fontInfo, null); } - /** @see org.apache.batik.bridge.BridgeContext#registerSVGBridges() */ + /** {@inheritDoc} */ public void registerSVGBridges() { super.registerSVGBridges(); diff --git a/src/java/org/apache/fop/svg/PDFDocumentGraphics2D.java b/src/java/org/apache/fop/svg/PDFDocumentGraphics2D.java index 9c72ade1a..420e46cb8 100644 --- a/src/java/org/apache/fop/svg/PDFDocumentGraphics2D.java +++ b/src/java/org/apache/fop/svg/PDFDocumentGraphics2D.java @@ -48,8 +48,6 @@ import java.io.StringWriter; * is used to create a full document around the pdf rendering from * <tt>PDFGraphics2D</tt>. * - * @author <a href="mailto:keiron@aftexsw.com">Keiron Liddle</a> - * @version $Id$ * @see org.apache.fop.svg.PDFGraphics2D */ public class PDFDocumentGraphics2D extends PDFGraphics2D { diff --git a/src/java/org/apache/fop/svg/PDFImageElementBridge.java b/src/java/org/apache/fop/svg/PDFImageElementBridge.java index bb314495c..1545fc475 100644 --- a/src/java/org/apache/fop/svg/PDFImageElementBridge.java +++ b/src/java/org/apache/fop/svg/PDFImageElementBridge.java @@ -101,7 +101,7 @@ public class PDFImageElementBridge extends SVGImageElementBridge { } /** - * @see org.apache.batik.bridge.SVGImageElementBridge + * @see org.apache.batik.bridge.SVGImageElementBridge#createGraphicsNode(BridgeContext, Element) */ protected GraphicsNode superCreateGraphicsNode (BridgeContext ctx, Element imageElement, ParsedURL purl) { diff --git a/src/java/org/apache/fop/svg/PDFTranscoder.java b/src/java/org/apache/fop/svg/PDFTranscoder.java index f6a986d0c..e213379cb 100644 --- a/src/java/org/apache/fop/svg/PDFTranscoder.java +++ b/src/java/org/apache/fop/svg/PDFTranscoder.java @@ -90,7 +90,7 @@ public class PDFTranscoder extends AbstractFOPTranscoder } /** - * @see org.apache.fop.svg.AbstractFOPTranscoder#createUserAgent() + * {@inheritDoc} */ protected UserAgent createUserAgent() { return new AbstractFOPTranscoder.FOPTranscoderUserAgent() { @@ -103,7 +103,7 @@ public class PDFTranscoder extends AbstractFOPTranscoder } /** - * @see org.apache.avalon.framework.configuration.Configurable#configure(Configuration) + * {@inheritDoc} */ public void configure(Configuration cfg) throws ConfigurationException { this.cfg = cfg; @@ -188,7 +188,7 @@ public class PDFTranscoder extends AbstractFOPTranscoder } } - /** @see org.apache.batik.transcoder.SVGAbstractTranscoder#createBridgeContext() */ + /** {@inheritDoc} */ protected BridgeContext createBridgeContext() { BridgeContext ctx = new PDFBridgeContext(userAgent, graphics.getFontInfo()); return ctx; diff --git a/src/java/org/apache/fop/text/linebreak/LineBreakStatus.java b/src/java/org/apache/fop/text/linebreak/LineBreakStatus.java index 29583a9d0..2f513c59c 100644 --- a/src/java/org/apache/fop/text/linebreak/LineBreakStatus.java +++ b/src/java/org/apache/fop/text/linebreak/LineBreakStatus.java @@ -21,7 +21,7 @@ package org.apache.fop.text.linebreak; /** * This class is meant for supporting the Unicode line breaking algorithm. - * See <a href="http://unicode.org/reports/tr14/">UTR 14</a>. + * See: <a href="http://unicode.org/reports/tr14/">UTR 14</a> * */ public class LineBreakStatus { diff --git a/src/java/org/apache/fop/tools/anttasks/Fop.java b/src/java/org/apache/fop/tools/anttasks/Fop.java index 2010c372e..6f9b2fc34 100644 --- a/src/java/org/apache/fop/tools/anttasks/Fop.java +++ b/src/java/org/apache/fop/tools/anttasks/Fop.java @@ -277,7 +277,7 @@ public class Fop extends Task { } /** - * @see org.apache.tools.ant.Task#execute() + * {@inheritDoc} */ public void execute() throws BuildException { int logLevel = SimpleLog.LOG_LEVEL_INFO; @@ -419,7 +419,7 @@ class FOPTaskStarter { } /** - * @see org.apache.fop.apps.Starter#run() + * {@inheritDoc} */ public void run() throws FOPException { //Set base directory diff --git a/src/java/org/apache/fop/tools/anttasks/RunTest.java b/src/java/org/apache/fop/tools/anttasks/RunTest.java index 91d217f7b..b11c75242 100644 --- a/src/java/org/apache/fop/tools/anttasks/RunTest.java +++ b/src/java/org/apache/fop/tools/anttasks/RunTest.java @@ -83,7 +83,7 @@ public class RunTest extends Task { /** * This creates the reference output, if required, then tests * the current build. - * @see org.apache.tools.ant.Task#execute() + * {@inheritDoc} */ public void execute() throws BuildException { runReference(); diff --git a/src/java/org/apache/fop/tools/anttasks/SerializeHyphPattern.java b/src/java/org/apache/fop/tools/anttasks/SerializeHyphPattern.java index b0877eaf6..0aefb8422 100644 --- a/src/java/org/apache/fop/tools/anttasks/SerializeHyphPattern.java +++ b/src/java/org/apache/fop/tools/anttasks/SerializeHyphPattern.java @@ -45,7 +45,7 @@ public class SerializeHyphPattern extends Task { private boolean errorDump = false; /** - * @see org.apache.tools.ant.Task#execute() + * {@inheritDoc} */ public void execute() throws org.apache.tools.ant.BuildException { // deal with the filesets diff --git a/src/java/org/apache/fop/traits/BorderProps.java b/src/java/org/apache/fop/traits/BorderProps.java index 64c31ff88..d00bdb09d 100644 --- a/src/java/org/apache/fop/traits/BorderProps.java +++ b/src/java/org/apache/fop/traits/BorderProps.java @@ -129,12 +129,12 @@ public class BorderProps implements Serializable { } } - /** @see java.lang.Object#hashCode() */ + /** {@inheritDoc} */ public int hashCode() { return toString().hashCode(); } - /** @see java.lang.Object#equals(java.lang.Object) */ + /** {@inheritDoc} */ public boolean equals(Object obj) { if (obj == null) { return false; @@ -188,7 +188,7 @@ public class BorderProps implements Serializable { } } - /** @see java.lang.Object#toString() */ + /** {@inheritDoc} */ public String toString() { StringBuffer sbuf = new StringBuffer(); sbuf.append('('); diff --git a/src/java/org/apache/fop/traits/MinOptMax.java b/src/java/org/apache/fop/traits/MinOptMax.java index 835e39cfe..33d10a8a5 100644 --- a/src/java/org/apache/fop/traits/MinOptMax.java +++ b/src/java/org/apache/fop/traits/MinOptMax.java @@ -75,7 +75,7 @@ public class MinOptMax implements java.io.Serializable, Cloneable { // TODO: remove this. /** - * @see java.lang.Object#clone() + * {@inheritDoc} */ public Object clone() { try { @@ -174,7 +174,7 @@ public class MinOptMax implements java.io.Serializable, Cloneable { return (min != opt || opt != max); } - /** @see java.lang.Object#toString() */ + /** {@inheritDoc} */ public String toString() { StringBuffer sb = new StringBuffer(); sb.append("MinOptMax[min="); diff --git a/src/java/org/apache/fop/util/DelegatingContentHandler.java b/src/java/org/apache/fop/util/DelegatingContentHandler.java index d6c772735..0b371483f 100644 --- a/src/java/org/apache/fop/util/DelegatingContentHandler.java +++ b/src/java/org/apache/fop/util/DelegatingContentHandler.java @@ -275,7 +275,7 @@ public class DelegatingContentHandler } /** - * {@inheritDoc} int, int) + * {@inheritDoc} */ public void comment(char[] ch, int start, int length) throws SAXException { if (lexicalHandler != null) { |