From: Simon Steiner Date: Wed, 16 Aug 2017 10:50:04 +0000 (+0000) Subject: Fix javadocs under java 8 X-Git-Tag: fop-2_3~43 X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=7eba11e048e90797e2a34d698b6f29fe82fae5d7;p=xmlgraphics-fop.git Fix javadocs under java 8 git-svn-id: https://svn.apache.org/repos/asf/xmlgraphics/fop/trunk@1805173 13f79535-47bb-0310-9956-ffa450edef68 --- diff --git a/fop-core/src/main/java/org/apache/fop/apps/FopFactory.java b/fop-core/src/main/java/org/apache/fop/apps/FopFactory.java index 91d42313a..100b028e9 100644 --- a/fop-core/src/main/java/org/apache/fop/apps/FopFactory.java +++ b/fop-core/src/main/java/org/apache/fop/apps/FopFactory.java @@ -163,7 +163,6 @@ public final class FopFactory implements ImageContext { * are particular to a rendering run. Don't reuse instances over multiple rendering runs but * instead create a new one each time and reuse the FopFactory. * @return the newly created FOUserAgent instance initialized with default values - * @throws FOPException */ public FOUserAgent newFOUserAgent() { FOUserAgent userAgent = new FOUserAgent(this, resolver); diff --git a/fop-core/src/main/java/org/apache/fop/apps/FopFactoryBuilder.java b/fop-core/src/main/java/org/apache/fop/apps/FopFactoryBuilder.java index cff8e4ecb..92f0e8a17 100644 --- a/fop-core/src/main/java/org/apache/fop/apps/FopFactoryBuilder.java +++ b/fop-core/src/main/java/org/apache/fop/apps/FopFactoryBuilder.java @@ -63,7 +63,7 @@ public final class FopFactoryBuilder { /** * A builder class for {@link FopFactory} which can be used for setting configuration. This is * a helper constructor that uses the default URI resolver implementation that FOP packages - * provide ({@link org.apache.fop.apps.io.ResourceResolverFactory.DefaultResourceResolver}). + * provide. * * @param defaultBaseURI the default base URI for resolving URIs against */ diff --git a/fop-core/src/main/java/org/apache/fop/area/Block.java b/fop-core/src/main/java/org/apache/fop/area/Block.java index 565146415..247aae7fb 100644 --- a/fop-core/src/main/java/org/apache/fop/area/Block.java +++ b/fop-core/src/main/java/org/apache/fop/area/Block.java @@ -169,7 +169,7 @@ public class Block extends BlockParent { /** * Sets the location in the source XML of the FO that generated this area. * - * @location the line and column location + * @param location the line and column location */ public void setLocation(String location) { this.location = location; diff --git a/fop-core/src/main/java/org/apache/fop/area/BookmarkData.java b/fop-core/src/main/java/org/apache/fop/area/BookmarkData.java index 495fd1901..873d30e3c 100644 --- a/fop-core/src/main/java/org/apache/fop/area/BookmarkData.java +++ b/fop-core/src/main/java/org/apache/fop/area/BookmarkData.java @@ -95,7 +95,7 @@ public class BookmarkData extends AbstractOffDocumentItem implements Resolvable /** * Create a new bookmark data root object. * This constructor is called by the AreaTreeParser when the - * element is read from the XML file + * <bookmarkTree> element is read from the XML file */ public BookmarkData() { idRef = null; @@ -106,7 +106,7 @@ public class BookmarkData extends AbstractOffDocumentItem implements Resolvable /** * Create a new bookmark data object. * This constructor is called by the AreaTreeParser when a - * element is read from the XML file. + * <bookmark> element is read from the XML file. * * @param title the bookmark's title * @param showChildren whether to initially display the bookmark's children diff --git a/fop-core/src/main/java/org/apache/fop/area/Resolvable.java b/fop-core/src/main/java/org/apache/fop/area/Resolvable.java index 3ab3ef309..f52d943b3 100644 --- a/fop-core/src/main/java/org/apache/fop/area/Resolvable.java +++ b/fop-core/src/main/java/org/apache/fop/area/Resolvable.java @@ -23,7 +23,7 @@ import java.util.List; /** * Resolvable Interface. Classes that implement this interface contain - * idrefs (see Section 5.11 of spec for definition of datatype) + * idrefs (see Section 5.11 of spec for definition of <idref> datatype) * that are resolved when their target IDs are added to the area tree. */ public interface Resolvable { diff --git a/fop-core/src/main/java/org/apache/fop/area/inline/InlineArea.java b/fop-core/src/main/java/org/apache/fop/area/inline/InlineArea.java index 1733f7b3d..d8f157323 100644 --- a/fop-core/src/main/java/org/apache/fop/area/inline/InlineArea.java +++ b/fop-core/src/main/java/org/apache/fop/area/inline/InlineArea.java @@ -291,7 +291,7 @@ public class InlineArea extends Area { * elements. * * @return the offset that this area would have if the before-edge of its - * content-rectangle were coinciding with the beforest before-edge of its + * content-rectangle were coinciding with the beforest before-edge of its * children allocation-rectangles. * @see #getVirtualBPD() * @see BasicLinkArea diff --git a/fop-core/src/main/java/org/apache/fop/area/inline/InlineParent.java b/fop-core/src/main/java/org/apache/fop/area/inline/InlineParent.java index 66075b641..f69c3da73 100644 --- a/fop-core/src/main/java/org/apache/fop/area/inline/InlineParent.java +++ b/fop-core/src/main/java/org/apache/fop/area/inline/InlineParent.java @@ -42,11 +42,11 @@ public class InlineParent extends InlineArea { /** Controls whether the IPD is automatically adjusted based on the area's children. */ protected transient boolean autoSize; - /** The offset of the beforest child area of this area. */ + /** The offset of the beforest child area of this area. */ protected int minChildOffset; /** - * The offset of the afterest child area of this area. Offset from the + * The offset of the afterest child area of this area. Offset from the * before-edge of this area's content-rectangle and the after-edge of the child area's * allocation-rectangle. */ diff --git a/fop-core/src/main/java/org/apache/fop/cli/AreaTreeInputHandler.java b/fop-core/src/main/java/org/apache/fop/cli/AreaTreeInputHandler.java index 72dd6c2f8..a79b8971c 100644 --- a/fop-core/src/main/java/org/apache/fop/cli/AreaTreeInputHandler.java +++ b/fop-core/src/main/java/org/apache/fop/cli/AreaTreeInputHandler.java @@ -41,7 +41,7 @@ import org.apache.fop.fonts.FontInfo; public class AreaTreeInputHandler extends InputHandler { /** - * Constructor for XML->XSLT->area tree XML input + * Constructor for XML->XSLT->area tree XML input * @param xmlfile XML file * @param xsltfile XSLT file * @param params Vector of command-line parameters (name, value, diff --git a/fop-core/src/main/java/org/apache/fop/cli/IFInputHandler.java b/fop-core/src/main/java/org/apache/fop/cli/IFInputHandler.java index f01252cb2..4318edc5b 100644 --- a/fop-core/src/main/java/org/apache/fop/cli/IFInputHandler.java +++ b/fop-core/src/main/java/org/apache/fop/cli/IFInputHandler.java @@ -40,7 +40,7 @@ import org.apache.fop.render.intermediate.IFUtil; public class IFInputHandler extends InputHandler { /** - * Constructor for XML->XSLT->intermediate XML input + * Constructor for XML->XSLT->intermediate XML input * @param xmlfile XML file * @param xsltfile XSLT file * @param params Vector of command-line parameters (name, value, diff --git a/fop-core/src/main/java/org/apache/fop/cli/InputHandler.java b/fop-core/src/main/java/org/apache/fop/cli/InputHandler.java index d91a80115..6d99bbe40 100644 --- a/fop-core/src/main/java/org/apache/fop/cli/InputHandler.java +++ b/fop-core/src/main/java/org/apache/fop/cli/InputHandler.java @@ -72,7 +72,7 @@ public class InputHandler implements ErrorListener, Renderable { protected Log log = LogFactory.getLog(InputHandler.class); /** - * Constructor for XML->XSLT->FO input + * Constructor for XML->XSLT->FO input * * @param xmlfile XML file * @param xsltfile XSLT file diff --git a/fop-core/src/main/java/org/apache/fop/complexscripts/fonts/GlyphPositioningTable.java b/fop-core/src/main/java/org/apache/fop/complexscripts/fonts/GlyphPositioningTable.java index 67d09dd85..9a547b535 100644 --- a/fop-core/src/main/java/org/apache/fop/complexscripts/fonts/GlyphPositioningTable.java +++ b/fop-core/src/main/java/org/apache/fop/complexscripts/fonts/GlyphPositioningTable.java @@ -1791,7 +1791,7 @@ public class GlyphPositioningTable extends GlyphTable { } /** - * Find device adjustment. + * Find device adjustment. asf.todo at present, assumes that 1 device unit equals one point * @param fontSize the font size to search for * @return an adjustment if font size matches an entry */ diff --git a/fop-core/src/main/java/org/apache/fop/complexscripts/fonts/GlyphSubstitutionTable.java b/fop-core/src/main/java/org/apache/fop/complexscripts/fonts/GlyphSubstitutionTable.java index 6ee333192..81020dbe3 100644 --- a/fop-core/src/main/java/org/apache/fop/complexscripts/fonts/GlyphSubstitutionTable.java +++ b/fop-core/src/main/java/org/apache/fop/complexscripts/fonts/GlyphSubstitutionTable.java @@ -1315,8 +1315,8 @@ public class GlyphSubstitutionTable extends GlyphTable { /** * The Ligature class implements a ligature lookup result in terms of - * a ligature glyph (code) and the N+1... components that comprise the ligature, - * where the Nth component was consumed in the coverage table lookup mapping to + * a ligature glyph (code) and the N+1... components that comprise the ligature, + * where the Nth component was consumed in the coverage table lookup mapping to * this ligature instance. */ public static class Ligature { @@ -1327,7 +1327,7 @@ public class GlyphSubstitutionTable extends GlyphTable { /** * Instantiate a ligature. * @param ligature glyph id - * @param components sequence of N+1... component glyph (or character) identifiers + * @param components sequence of N+1... component glyph (or character) identifiers */ public Ligature(int ligature, int[] components) { if ((ligature < 0) || (ligature > 65535)) { @@ -1350,7 +1350,7 @@ public class GlyphSubstitutionTable extends GlyphTable { return ligature; } - /** @return array of N+1... components */ + /** @return array of N+1... components */ public int[] getComponents() { return components; } diff --git a/fop-core/src/main/java/org/apache/fop/complexscripts/fonts/GlyphTable.java b/fop-core/src/main/java/org/apache/fop/complexscripts/fonts/GlyphTable.java index ce5c47ba0..42e0fab75 100644 --- a/fop-core/src/main/java/org/apache/fop/complexscripts/fonts/GlyphTable.java +++ b/fop-core/src/main/java/org/apache/fop/complexscripts/fonts/GlyphTable.java @@ -175,7 +175,7 @@ public class GlyphTable { } /** - * Match lookup specifications according to tuple, where + * Match lookup specifications according to <script,language,feature> tuple, where * '*' is a wildcard for a tuple component. * @param script a script identifier * @param language a language identifier @@ -208,7 +208,7 @@ public class GlyphTable { } /** - * Match lookup specifications according to tuple, where + * Match lookup specifications according to <script,language,feature> tuple, where * '*' is a wildcard for a tuple component. * @param script a script identifier * @param language a language identifier @@ -346,7 +346,7 @@ public class GlyphTable { } /** - * A structure class encapsulating a lookup specification as a tuple. + * A structure class encapsulating a lookup specification as a <script,language,feature> tuple. */ public static class LookupSpec implements Comparable { diff --git a/fop-core/src/main/java/org/apache/fop/complexscripts/fonts/OTFAdvancedTypographicTableReader.java b/fop-core/src/main/java/org/apache/fop/complexscripts/fonts/OTFAdvancedTypographicTableReader.java index 00c8cf1bf..4b319f1c1 100644 --- a/fop-core/src/main/java/org/apache/fop/complexscripts/fonts/OTFAdvancedTypographicTableReader.java +++ b/fop-core/src/main/java/org/apache/fop/complexscripts/fonts/OTFAdvancedTypographicTableReader.java @@ -63,7 +63,7 @@ public final class OTFAdvancedTypographicTableReader { /** * Construct an OTFAdvancedTypographicTableReader instance. - * @param ttf parent font file reader (must be non-null) + * @param otf parent font file reader (must be non-null) * @param in font file reader (must be non-null) */ public OTFAdvancedTypographicTableReader(OpenFont otf, FontFileReader in) { diff --git a/fop-core/src/main/java/org/apache/fop/complexscripts/util/CharAssociation.java b/fop-core/src/main/java/org/apache/fop/complexscripts/util/CharAssociation.java index f5d15b303..c4de16546 100644 --- a/fop-core/src/main/java/org/apache/fop/complexscripts/util/CharAssociation.java +++ b/fop-core/src/main/java/org/apache/fop/complexscripts/util/CharAssociation.java @@ -145,7 +145,7 @@ public class CharAssociation implements Cloneable { } /** - * Set predication . + * Set predication <KEY,VALUE>. * @param key predication key * @param value predication value */ @@ -172,7 +172,7 @@ public class CharAssociation implements Cloneable { } /** - * Merge predication . + * Merge predication <KEY,VALUE>. * @param key predication key * @param value predication value */ diff --git a/fop-core/src/main/java/org/apache/fop/complexscripts/util/GlyphSequence.java b/fop-core/src/main/java/org/apache/fop/complexscripts/util/GlyphSequence.java index 1c13a5efe..5a1ac8b94 100644 --- a/fop-core/src/main/java/org/apache/fop/complexscripts/util/GlyphSequence.java +++ b/fop-core/src/main/java/org/apache/fop/complexscripts/util/GlyphSequence.java @@ -303,7 +303,7 @@ public class GlyphSequence implements Cloneable { } /** - * Set predication at glyph sequence OFFSET. + * Set predication <KEY,VALUE> at glyph sequence OFFSET. * @param offset offset (index) into glyph sequence * @param key predication key * @param value predication value diff --git a/fop-core/src/main/java/org/apache/fop/datatypes/Numeric.java b/fop-core/src/main/java/org/apache/fop/datatypes/Numeric.java index 8ed5a0e5c..fd1003f90 100644 --- a/fop-core/src/main/java/org/apache/fop/datatypes/Numeric.java +++ b/fop-core/src/main/java/org/apache/fop/datatypes/Numeric.java @@ -35,7 +35,6 @@ public interface Numeric { /** * Return the value of this Numeric * @return the computed value. - * @throws PropertyException if a property exception occurs */ double getNumericValue(); @@ -43,7 +42,6 @@ public interface Numeric { * Return the value of this Numeric * @param context The context for the length calculation (for percentage based lengths) * @return the computed value. - * @throws PropertyException if a property exception occurs */ double getNumericValue(PercentBaseContext context); diff --git a/fop-core/src/main/java/org/apache/fop/datatypes/URISpecification.java b/fop-core/src/main/java/org/apache/fop/datatypes/URISpecification.java index 718d84695..7362c2ce5 100644 --- a/fop-core/src/main/java/org/apache/fop/datatypes/URISpecification.java +++ b/fop-core/src/main/java/org/apache/fop/datatypes/URISpecification.java @@ -23,7 +23,7 @@ import java.io.UnsupportedEncodingException; /** - * This class contains method to deal with the datatype from XSL-FO. + * This class contains method to deal with the <uri-specification> datatype from XSL-FO. */ public final class URISpecification { diff --git a/fop-core/src/main/java/org/apache/fop/fo/FONode.java b/fop-core/src/main/java/org/apache/fop/fo/FONode.java index f5eb8854e..b4e0ec0fe 100644 --- a/fop-core/src/main/java/org/apache/fop/fo/FONode.java +++ b/fop-core/src/main/java/org/apache/fop/fo/FONode.java @@ -1013,7 +1013,7 @@ public abstract class FONode implements Cloneable { /** * Base iterator interface over a FO's children, offering three methods on top of the base interface - * methods {@see java.util.ListIterator}. + * methods. */ public interface FONodeIterator extends ListIterator { diff --git a/fop-core/src/main/java/org/apache/fop/fo/FOText.java b/fop-core/src/main/java/org/apache/fop/fo/FOText.java index 8b65e6891..563d96993 100644 --- a/fop-core/src/main/java/org/apache/fop/fo/FOText.java +++ b/fop-core/src/main/java/org/apache/fop/fo/FOText.java @@ -212,7 +212,7 @@ public class FOText extends FONode implements CharSequence, TextFragment { * Check if this text node will create an area. * This means either there is non-whitespace or it is * preserved whitespace. - * Maybe this just needs to check length > 0, since char iterators + * Maybe this just needs to check length > 0, since char iterators * handle whitespace. * * @return true if this will create an area in the output diff --git a/fop-core/src/main/java/org/apache/fop/fo/PropertyList.java b/fop-core/src/main/java/org/apache/fop/fo/PropertyList.java index 0412091a5..2ce1f4c55 100644 --- a/fop-core/src/main/java/org/apache/fop/fo/PropertyList.java +++ b/fop-core/src/main/java/org/apache/fop/fo/PropertyList.java @@ -335,7 +335,7 @@ public abstract class PropertyList { *
  • number-columns-spanned
  • *
  • font
  • *
  • font-size
  • - *
  • all others in order of appearance
  • + *
  • all others in order of appearance
  • * * * @param attributes Collection of attributes passed to us from the parser. diff --git a/fop-core/src/main/java/org/apache/fop/fo/StringCharIterator.java b/fop-core/src/main/java/org/apache/fop/fo/StringCharIterator.java index f3490052b..ec31ff86c 100644 --- a/fop-core/src/main/java/org/apache/fop/fo/StringCharIterator.java +++ b/fop-core/src/main/java/org/apache/fop/fo/StringCharIterator.java @@ -31,7 +31,7 @@ public class StringCharIterator extends CharIterator { /** * Constructor - * @param c the character that this iterator should iterate. + * @param s the character that this iterator should iterate. */ public StringCharIterator(String s) { this.index = -1; diff --git a/fop-core/src/main/java/org/apache/fop/fo/expr/NumericProperty.java b/fop-core/src/main/java/org/apache/fop/fo/expr/NumericProperty.java index 588e43137..2c73de1d1 100644 --- a/fop-core/src/main/java/org/apache/fop/fo/expr/NumericProperty.java +++ b/fop-core/src/main/java/org/apache/fop/fo/expr/NumericProperty.java @@ -42,7 +42,7 @@ public class NumericProperty extends Property implements Numeric, Length { * including absolute length, percent length, table units. * @param value The value of the numeric. * @param dim The dimension of the value. 0 for a Number, 1 for a Length - * (any type), >1, <0 if Lengths have been multiplied or divided. + * (any type), >1, <0 if Lengths have been multiplied or divided. */ protected NumericProperty(double value, int dim) { this.value = value; diff --git a/fop-core/src/main/java/org/apache/fop/fo/flow/BlockContainer.java b/fop-core/src/main/java/org/apache/fop/fo/flow/BlockContainer.java index d5d8114ea..76d2996da 100644 --- a/fop-core/src/main/java/org/apache/fop/fo/flow/BlockContainer.java +++ b/fop-core/src/main/java/org/apache/fop/fo/flow/BlockContainer.java @@ -112,7 +112,7 @@ public class BlockContainer extends FObj implements BreakPropertySet, WritingMod /** * {@inheritDoc} *
    XSL Content Model: marker* (%block;)+ - *
    BUT: "In addition an fo:block-container that does not generate an + *
    BUT: "In addition an fo:block-container that does not generate an * absolutely positioned area may have a sequence of zero or more * fo:markers as its initial children." * The latter refers to block-containers with absolute-position="absolute" diff --git a/fop-core/src/main/java/org/apache/fop/fo/flow/ListBlock.java b/fop-core/src/main/java/org/apache/fop/fo/flow/ListBlock.java index 452f2c4d4..a9fa3681f 100644 --- a/fop-core/src/main/java/org/apache/fop/fo/flow/ListBlock.java +++ b/fop-core/src/main/java/org/apache/fop/fo/flow/ListBlock.java @@ -35,8 +35,8 @@ import org.apache.fop.fo.properties.CommonMarginBlock; import org.apache.fop.fo.properties.KeepProperty; /** - * Class modelling the - * fo:list-block object. + * Class modelling the list block + * fo:list-block object. */ public class ListBlock extends FObj implements BreakPropertySet, CommonAccessibilityHolder { // The value of properties relevant for fo:list-block. diff --git a/fop-core/src/main/java/org/apache/fop/fo/flow/ListItem.java b/fop-core/src/main/java/org/apache/fop/fo/flow/ListItem.java index ec04d3bde..55b2e06b9 100644 --- a/fop-core/src/main/java/org/apache/fop/fo/flow/ListItem.java +++ b/fop-core/src/main/java/org/apache/fop/fo/flow/ListItem.java @@ -37,8 +37,8 @@ import org.apache.fop.fo.properties.CommonMarginBlock; import org.apache.fop.fo.properties.KeepProperty; /** - * Class modelling the - * fo:list-item object. + * Class modelling the list item + * fo:list-item object. */ public class ListItem extends FObj implements BreakPropertySet, CommonAccessibilityHolder { // The value of properties relevant for fo:list-item. diff --git a/fop-core/src/main/java/org/apache/fop/fo/flow/ListItemBody.java b/fop-core/src/main/java/org/apache/fop/fo/flow/ListItemBody.java index 5b121f53c..328485bba 100644 --- a/fop-core/src/main/java/org/apache/fop/fo/flow/ListItemBody.java +++ b/fop-core/src/main/java/org/apache/fop/fo/flow/ListItemBody.java @@ -23,8 +23,8 @@ import org.apache.fop.apps.FOPException; import org.apache.fop.fo.FONode; /** - * Class modelling the - * fo:list-item-body object. + * Class modelling the list item + * fo:list-item-body object. */ public class ListItemBody extends AbstractListItemPart { diff --git a/fop-core/src/main/java/org/apache/fop/fo/flow/ListItemLabel.java b/fop-core/src/main/java/org/apache/fop/fo/flow/ListItemLabel.java index 53dfab84e..02f307496 100644 --- a/fop-core/src/main/java/org/apache/fop/fo/flow/ListItemLabel.java +++ b/fop-core/src/main/java/org/apache/fop/fo/flow/ListItemLabel.java @@ -23,8 +23,8 @@ import org.apache.fop.apps.FOPException; import org.apache.fop.fo.FONode; /** - * Class modelling the - * fo:list-item-label object. + * Class modelling the list item + * fo:list-item-label object. */ public class ListItemLabel extends AbstractListItemPart { diff --git a/fop-core/src/main/java/org/apache/fop/fo/flow/Marker.java b/fop-core/src/main/java/org/apache/fop/fo/flow/Marker.java index 4a2ea64fc..1233da615 100644 --- a/fop-core/src/main/java/org/apache/fop/fo/flow/Marker.java +++ b/fop-core/src/main/java/org/apache/fop/fo/flow/Marker.java @@ -36,8 +36,8 @@ import org.apache.fop.fo.properties.Property; import org.apache.fop.fo.properties.PropertyCache; /** - * Class modelling the - * fo:marker object. + * Class modelling the marker + * fo:markerobject. */ public class Marker extends FObjMixed { // The value of properties relevant for fo:marker. diff --git a/fop-core/src/main/java/org/apache/fop/fo/flow/Markers.java b/fop-core/src/main/java/org/apache/fop/fo/flow/Markers.java index d2c9aa863..4263bd6f6 100644 --- a/fop-core/src/main/java/org/apache/fop/fo/flow/Markers.java +++ b/fop-core/src/main/java/org/apache/fop/fo/flow/Markers.java @@ -145,8 +145,6 @@ public final class Markers { /** * Retrieves the best candidate marker for the given position. - * @param name the key used to register the marker - * @param pos the retrieval scope position * @return a Marker instance */ public Marker resolve(AbstractRetrieveMarker arm) { diff --git a/fop-core/src/main/java/org/apache/fop/fo/flow/Wrapper.java b/fop-core/src/main/java/org/apache/fop/fo/flow/Wrapper.java index e6625a538..39f472cbb 100644 --- a/fop-core/src/main/java/org/apache/fop/fo/flow/Wrapper.java +++ b/fop-core/src/main/java/org/apache/fop/fo/flow/Wrapper.java @@ -32,8 +32,8 @@ import org.apache.fop.fo.properties.CommonAccessibility; import org.apache.fop.fo.properties.CommonAccessibilityHolder; /** - * Class modelling the - * fo:wrapper object. + * Class modelling the fo wrapper + * fo:wrapper object. * The fo:wrapper object serves as a property holder for * its child node objects. */ diff --git a/fop-core/src/main/java/org/apache/fop/fo/flow/table/TableEventProducer.java b/fop-core/src/main/java/org/apache/fop/fo/flow/table/TableEventProducer.java index 132728322..7ab7f8d30 100644 --- a/fop-core/src/main/java/org/apache/fop/fo/flow/table/TableEventProducer.java +++ b/fop-core/src/main/java/org/apache/fop/fo/flow/table/TableEventProducer.java @@ -117,8 +117,8 @@ public interface TableEventProducer extends EventProducer { int actualValue, Locator loc) throws PropertyException; /** - * table-layout=\"fixed\" and column-width unspecified - * => falling back to proportional-column-width(1) + * table-layout=fixed and column-width unspecified + * => falling back to proportional-column-width(1) * @param source the event source * @param loc the location of the error or null * @event.severity WARN diff --git a/fop-core/src/main/java/org/apache/fop/fo/pagination/RegionBody.java b/fop-core/src/main/java/org/apache/fop/fo/pagination/RegionBody.java index 210f25e1f..638149b79 100644 --- a/fop-core/src/main/java/org/apache/fop/fo/pagination/RegionBody.java +++ b/fop-core/src/main/java/org/apache/fop/fo/pagination/RegionBody.java @@ -81,7 +81,7 @@ public class RegionBody extends Region { } /** - * Return the value of the column-count property. + * Return the value of the column-count property. * @return the "column-count" property. */ public int getColumnCount() { diff --git a/fop-core/src/main/java/org/apache/fop/fo/properties/LengthRangeProperty.java b/fop-core/src/main/java/org/apache/fop/fo/properties/LengthRangeProperty.java index 9eeda0e9f..6fe53ef85 100644 --- a/fop-core/src/main/java/org/apache/fop/fo/properties/LengthRangeProperty.java +++ b/fop-core/src/main/java/org/apache/fop/fo/properties/LengthRangeProperty.java @@ -182,7 +182,7 @@ public class LengthRangeProperty extends Property implements CompoundDatatype { /** - * Set maximum value to max if it is >= optimum or optimum isn't set. + * Set maximum value to max if it is >= optimum or optimum isn't set. * @param max A Length value specifying the maximum value for this * @param bIsDefault If true, this is set as a "default" value * and not a user-specified explicit value. diff --git a/fop-core/src/main/java/org/apache/fop/fo/properties/URIProperty.java b/fop-core/src/main/java/org/apache/fop/fo/properties/URIProperty.java index 3bdfbab00..0538af369 100644 --- a/fop-core/src/main/java/org/apache/fop/fo/properties/URIProperty.java +++ b/fop-core/src/main/java/org/apache/fop/fo/properties/URIProperty.java @@ -31,7 +31,7 @@ import org.apache.fop.util.CompareUtil; import static org.apache.fop.fo.Constants.PR_X_XML_BASE; /** - * Class modeling a property that has a value of type <uri-specification>. + * Class modeling a property that has a value of type <uri-specification>. * The purpose is mainly to support resolution of a specified * relative URI against a specified or inherited xml:base * during the property refinement stage. diff --git a/fop-core/src/main/java/org/apache/fop/fonts/CustomFont.java b/fop-core/src/main/java/org/apache/fop/fonts/CustomFont.java index 4422ef8c3..2b659f512 100644 --- a/fop-core/src/main/java/org/apache/fop/fonts/CustomFont.java +++ b/fop-core/src/main/java/org/apache/fop/fonts/CustomFont.java @@ -515,7 +515,7 @@ public abstract class CustomFont extends Typeface /** * Replaces the existing kerning map with a new one. - * @param kerningMap the kerning map (Map, the integers are + * @param kerningMap the kerning map (the integers are * character codes) */ public void replaceKerningMap(Map> kerningMap) { diff --git a/fop-core/src/main/java/org/apache/fop/fonts/EmbedFontInfo.java b/fop-core/src/main/java/org/apache/fop/fonts/EmbedFontInfo.java index 44686c64d..186f098fd 100644 --- a/fop-core/src/main/java/org/apache/fop/fonts/EmbedFontInfo.java +++ b/fop-core/src/main/java/org/apache/fop/fonts/EmbedFontInfo.java @@ -27,7 +27,7 @@ import java.util.List; /** * FontInfo contains meta information on fonts (where is the metrics file etc.) * TODO: We need to remove this class and think about more intelligent design patterns - * (Data classes => Procedural code) + * (Data classes => Procedural code) */ public class EmbedFontInfo implements Serializable { @@ -60,11 +60,10 @@ public class EmbedFontInfo implements Serializable { /** * Main constructor - * @param metricsURI the URI of the XML resource containing font metrics + * @param fontUris the URI of the XML resource containing font metrics * @param kerning True if kerning should be enabled * @param advanced true if advanced typography features should be enabled * @param fontTriplets List of font triplets to associate with this font - * @param embedURI Path to the embeddable font file (may be null) * @param subFontName the sub-fontname used for TrueType Collections (null otherwise) * @param encodingMode the encoding mode to use for this font */ @@ -84,10 +83,9 @@ public class EmbedFontInfo implements Serializable { /** * Main constructor - * @param metricsURI the URI of the XML resource containing font metrics + * @param fontUris the URI of the XML resource containing font metrics * @param kerning True if kerning should be enabled * @param fontTriplets List of font triplets to associate with this font - * @param embedURI Path to the embeddable font file (may be null) * @param subFontName the sub-fontname used for TrueType Collections (null otherwise) */ public EmbedFontInfo(FontUris fontUris, boolean kerning, boolean advanced, diff --git a/fop-core/src/main/java/org/apache/fop/fonts/FontCache.java b/fop-core/src/main/java/org/apache/fop/fonts/FontCache.java index dd2450e4d..76ef22300 100644 --- a/fop-core/src/main/java/org/apache/fop/fonts/FontCache.java +++ b/fop-core/src/main/java/org/apache/fop/fonts/FontCache.java @@ -71,14 +71,14 @@ public final class FontCache implements Serializable { private final boolean[] changeLock = new boolean[1]; /** - * master mapping of font url -> font info. This needs to be a list, since a + * master mapping of font url -> font info. This needs to be a list, since a * TTC file may contain more than 1 font. * @serial */ private Map fontfileMap; /** - * mapping of font url -> file modified date (for all fonts that have failed + * mapping of font url -> file modified date (for all fonts that have failed * to load) * @serial */ diff --git a/fop-core/src/main/java/org/apache/fop/fonts/MultiByteFont.java b/fop-core/src/main/java/org/apache/fop/fonts/MultiByteFont.java index c5af86822..f54dec9a6 100644 --- a/fop-core/src/main/java/org/apache/fop/fonts/MultiByteFont.java +++ b/fop-core/src/main/java/org/apache/fop/fonts/MultiByteFont.java @@ -304,7 +304,7 @@ public class MultiByteFont extends CIDFont implements Substitutable, Positionabl * Returns the Unicode scalar value that corresponds to the glyph index. If more than * one correspondence exists, then the first one is returned (ordered by bfentries[]). * @param gi glyph index - * @returns unicode scalar value + * @return unicode scalar value */ // [TBD] - needs optimization, i.e., change from linear search to binary search private int findCharacterFromGlyphIndex(int gi, boolean augment) { diff --git a/fop-core/src/main/java/org/apache/fop/fonts/SingleByteFont.java b/fop-core/src/main/java/org/apache/fop/fonts/SingleByteFont.java index 53d3cd4fc..1649821ee 100644 --- a/fop-core/src/main/java/org/apache/fop/fonts/SingleByteFont.java +++ b/fop-core/src/main/java/org/apache/fop/fonts/SingleByteFont.java @@ -421,7 +421,7 @@ public class SingleByteFont extends CustomFont { * Sets the version of the PostScript table stored in the TrueType font represented by * this instance. * - * @param version version of the post table + * @param version version of the post table */ public void setTrueTypePostScriptVersion(PostScriptVersion version) { ttPostScriptVersion = version; @@ -431,7 +431,7 @@ public class SingleByteFont extends CustomFont { * Returns the version of the PostScript table stored in the TrueType font represented by * this instance. * - * @return the version of the post table + * @return the version of the post table */ public PostScriptVersion getTrueTypePostScriptVersion() { assert getFontType() == FontType.TRUETYPE; diff --git a/fop-core/src/main/java/org/apache/fop/fonts/XMLFontMetricsReader.java b/fop-core/src/main/java/org/apache/fop/fonts/XMLFontMetricsReader.java index dcdbff05b..ab1203ee0 100644 --- a/fop-core/src/main/java/org/apache/fop/fonts/XMLFontMetricsReader.java +++ b/fop-core/src/main/java/org/apache/fop/fonts/XMLFontMetricsReader.java @@ -46,8 +46,8 @@ import org.apache.fop.fonts.apps.TTFReader; *

    Class for reading a metric.xml file and creating a font object. * Typical usage:

    *
    - * XMLFontMetricsReader reader = new XMLFontMetricsReader();
    - * reader.setFontEmbedPath();
    + * XMLFontMetricsReader reader = new XMLFontMetricsReader(<path til metrics.xml>);
    + * reader.setFontEmbedPath(<path to a .ttf or .pfb file or null to diable embedding>);
      * reader.useKerning(true);
      * Font f = reader.getFont();
      * 
    diff --git a/fop-core/src/main/java/org/apache/fop/fonts/apps/PFMReader.java b/fop-core/src/main/java/org/apache/fop/fonts/apps/PFMReader.java index d2e9b7cbd..06d8d5c36 100644 --- a/fop-core/src/main/java/org/apache/fop/fonts/apps/PFMReader.java +++ b/fop-core/src/main/java/org/apache/fop/fonts/apps/PFMReader.java @@ -65,16 +65,16 @@ public class PFMReader extends AbstractFontReader { * * @param args Command-line arguments: [options] metricfile.pfm xmlfile.xml * where options can be: - * -fn + * -fn fontname * default is to use the fontname in the .pfm file, but you can override * that name to make sure that the embedded font is used instead of installed * fonts when viewing documents with Acrobat Reader. - * -cn + * -cn classname * default is to use the fontname - * -ef + * -ef path to the Type1 .pfb fontfile * will add the possibility to embed the font. When running fop, fop will look * for this file to embed it - * -er + * -er path to Type1 fontfile relative to org/apache/fop/render/pdf/fonts * you can also include the fontfile in the fop.jar file when building fop. * You can use both -ef and -er. The file specified in -ef will be searched first, * then the -er file. diff --git a/fop-core/src/main/java/org/apache/fop/fonts/apps/TTFReader.java b/fop-core/src/main/java/org/apache/fop/fonts/apps/TTFReader.java index 8af55488b..1e5bc5e19 100644 --- a/fop-core/src/main/java/org/apache/fop/fonts/apps/TTFReader.java +++ b/fop-core/src/main/java/org/apache/fop/fonts/apps/TTFReader.java @@ -91,16 +91,16 @@ public class TTFReader extends AbstractFontReader { * * @param args Command-line arguments: [options] fontfile.ttf xmlfile.xml * where options can be: - * -fn + * -fn fontname * default is to use the fontname in the .ttf file, but you can override * that name to make sure that the embedded font is used instead of installed * fonts when viewing documents with Acrobat Reader. - * -cn + * -cn classname * default is to use the fontname - * -ef + * -ef path to the truetype fontfile * will add the possibility to embed the font. When running fop, fop will look * for this file to embed it - * -er + * -er path to truetype fontfile relative to org/apache/fop/render/pdf/fonts * you can also include the fontfile in the fop.jar file when building fop. * You can use both -ef and -er. The file specified in -ef will be searched first, * then the -er file. diff --git a/fop-core/src/main/java/org/apache/fop/fonts/cff/CFFDataReader.java b/fop-core/src/main/java/org/apache/fop/fonts/cff/CFFDataReader.java index ab60b3072..34b9a00ca 100644 --- a/fop-core/src/main/java/org/apache/fop/fonts/cff/CFFDataReader.java +++ b/fop-core/src/main/java/org/apache/fop/fonts/cff/CFFDataReader.java @@ -344,7 +344,7 @@ public class CFFDataReader { /** * Retrieves the SID for the given GID object * @param charsetOffset The offset of the charset data - * @param GID The GID for which to retrieve the SID + * @param gid The GID for which to retrieve the SID * @return Returns the SID as an integer */ public int getSIDFromGID(int charsetOffset, int gid) throws IOException { @@ -458,7 +458,6 @@ public class CFFDataReader { /** * Parses the char string index from the CFF byte data - * @param offset The offset to the char string index * @return Returns the char string index object * @throws IOException Throws an IO Exception if an error occurs */ diff --git a/fop-core/src/main/java/org/apache/fop/fonts/truetype/OpenFont.java b/fop-core/src/main/java/org/apache/fop/fonts/truetype/OpenFont.java index aa6739f15..fb6ebbd11 100644 --- a/fop-core/src/main/java/org/apache/fop/fonts/truetype/OpenFont.java +++ b/fop-core/src/main/java/org/apache/fop/fonts/truetype/OpenFont.java @@ -232,7 +232,7 @@ public abstract class OpenFont { protected OTFAdvancedTypographicTableReader advancedTableReader; /** - * Version of the PostScript table (post) contained in this font. + * Version of the PostScript table (post) contained in this font. */ public static enum PostScriptVersion { /** PostScript table version 1.0. */ @@ -763,9 +763,6 @@ public abstract class OpenFont { * Reads a font. * * @param in FontFileReader to read from - * @param name Name to be checked for in the font file - * @param glyphs Map of glyphs (glyphs has old index as (Integer) key and - * new index as (Integer) value) * @throws IOException in case of an I/O problem */ public void readFont(FontFileReader in, String header, MultiByteFont mbfont) throws IOException { @@ -993,8 +990,8 @@ public abstract class OpenFont { /** * Returns the index of the last character, but this is for WinAnsiEncoding - * only, so the last char is < 256. - * @return short Index of the last character (<256) + * only, so the last char is < 256. + * @return short Index of the last character (<256) */ public short getLastChar() { return lastChar; diff --git a/fop-core/src/main/java/org/apache/fop/fonts/type1/AdobeStandardEncoding.java b/fop-core/src/main/java/org/apache/fop/fonts/type1/AdobeStandardEncoding.java index d3d5a969d..c6dc91dc8 100644 --- a/fop-core/src/main/java/org/apache/fop/fonts/type1/AdobeStandardEncoding.java +++ b/fop-core/src/main/java/org/apache/fop/fonts/type1/AdobeStandardEncoding.java @@ -23,7 +23,7 @@ import java.util.HashMap; import java.util.Map; /** - * Enumerates the {@linkplain http://unicode.org/Public/MAPPINGS/VENDORS/ADOBE/stdenc.txt} for + * Enumerates the linkplain http://unicode.org/Public/MAPPINGS/VENDORS/ADOBE/stdenc.txt for * characters found in a Type1 font. */ public enum AdobeStandardEncoding { diff --git a/fop-core/src/main/java/org/apache/fop/fonts/type1/Type1FontLoader.java b/fop-core/src/main/java/org/apache/fop/fonts/type1/Type1FontLoader.java index f11585cfb..bd96d80c5 100644 --- a/fop-core/src/main/java/org/apache/fop/fonts/type1/Type1FontLoader.java +++ b/fop-core/src/main/java/org/apache/fop/fonts/type1/Type1FontLoader.java @@ -56,7 +56,7 @@ public class Type1FontLoader extends FontLoader { /** * Constructs a new Type 1 font loader. - * @param fontFileURI the URI to the PFB file of a Type 1 font + * @param fontUris the URI to the PFB file of a Type 1 font * @param embedded indicates whether the font is embedded or referenced * @param useKerning indicates whether to load kerning information if available * @param resourceResolver the font resolver used to resolve URIs diff --git a/fop-core/src/main/java/org/apache/fop/hyphenation/Hyphenation.java b/fop-core/src/main/java/org/apache/fop/hyphenation/Hyphenation.java index 9b4a33339..224b35bcd 100644 --- a/fop-core/src/main/java/org/apache/fop/hyphenation/Hyphenation.java +++ b/fop-core/src/main/java/org/apache/fop/hyphenation/Hyphenation.java @@ -20,9 +20,9 @@ package org.apache.fop.hyphenation; /** - * + * This class represents a hyphenated word. * - *

    This work was authored by Carlos Villegas (cav@uniscope.co.jp).

    + * This work was originally authored by Carlos Villegas cav@uniscope.co.jp */ public class Hyphenation { diff --git a/fop-core/src/main/java/org/apache/fop/hyphenation/HyphenationTree.java b/fop-core/src/main/java/org/apache/fop/hyphenation/HyphenationTree.java index e151568ec..e664da38e 100644 --- a/fop-core/src/main/java/org/apache/fop/hyphenation/HyphenationTree.java +++ b/fop-core/src/main/java/org/apache/fop/hyphenation/HyphenationTree.java @@ -38,11 +38,11 @@ import org.xml.sax.InputSource; import org.apache.commons.io.IOUtils; /** - *

    This tree structure stores the hyphenation patterns in an efficient + * This tree structure stores the hyphenation patterns in an efficient * way for fast lookup. It provides the provides the method to - * hyphenate a word.

    + * hyphenate a word. * - *

    This work was authored by Carlos Villegas (cav@uniscope.co.jp).

    + * This work was originally authored by Carlos Villegas cav@uniscope.co.jp */ public class HyphenationTree extends TernaryTree implements PatternConsumer { @@ -232,7 +232,7 @@ public class HyphenationTree extends TernaryTree implements PatternConsumer { * at index an update interletter values. In other words, it * does something like:

    * - * for(i=0; i= len + * @return the minimum integer n such that n * bpUnit >= len */ protected int neededUnits(int len) { return (int) Math.ceil((float)len / bpUnit); diff --git a/fop-core/src/main/java/org/apache/fop/layoutmgr/BreakingAlgorithm.java b/fop-core/src/main/java/org/apache/fop/layoutmgr/BreakingAlgorithm.java index e060226c4..08c27404d 100644 --- a/fop-core/src/main/java/org/apache/fop/layoutmgr/BreakingAlgorithm.java +++ b/fop-core/src/main/java/org/apache/fop/layoutmgr/BreakingAlgorithm.java @@ -100,7 +100,7 @@ public abstract class BreakingAlgorithm { /** Demerit for consecutive lines belonging to incompatible fitness classes . */ protected int incompatibleFitnessDemerit = KnuthPenalty.FLAGGED_PENALTY; /** Maximum number of consecutive lines ending with a flagged penalty. - * Only a value >= 1 is a significant limit. + * Only a value >= 1 is a significant limit. */ protected int maxFlaggedPenaltiesCount; @@ -767,7 +767,7 @@ public abstract class BreakingAlgorithm { /** * Handle a {@link KnuthBox}. - *
    Note: default implementation just adds the box's width + *
    Note: default implementation just adds the box's width * to the total content width. Subclasses that do not keep track * of this themselves, but override this method, should remember * to call {@code super.handleBox(box)} to avoid unwanted side-effects. diff --git a/fop-core/src/main/java/org/apache/fop/layoutmgr/PageProvider.java b/fop-core/src/main/java/org/apache/fop/layoutmgr/PageProvider.java index ff6a277c7..2f6530ef1 100644 --- a/fop-core/src/main/java/org/apache/fop/layoutmgr/PageProvider.java +++ b/fop-core/src/main/java/org/apache/fop/layoutmgr/PageProvider.java @@ -242,7 +242,7 @@ public class PageProvider implements Constants { } /** - * Returns the part index (0 + * for example.
    * The {@link #next()} method always returns a {@link Position}. The * {@link #getPos(Object)} method can be overridden in subclasses * to take care of obtaining the {@link LayoutManager} or {@link Position} diff --git a/fop-core/src/main/java/org/apache/fop/layoutmgr/SpaceResolver.java b/fop-core/src/main/java/org/apache/fop/layoutmgr/SpaceResolver.java index c8c6b9052..868b467f7 100644 --- a/fop-core/src/main/java/org/apache/fop/layoutmgr/SpaceResolver.java +++ b/fop-core/src/main/java/org/apache/fop/layoutmgr/SpaceResolver.java @@ -679,7 +679,7 @@ public final class SpaceResolver { * @param startElementIndex index of the first element in the part to be processed * @param endElementIndex index of the last element in the part to be processed * @param prevBreak index of the the break possibility just before this part (used to - * identify a break condition, lastBreak <= 0 represents a no-break condition) + * identify a break condition, lastBreak <= 0 represents a no-break condition) */ public static void performConditionalsNotification(List effectiveList, int startElementIndex, int endElementIndex, int prevBreak) { diff --git a/fop-core/src/main/java/org/apache/fop/layoutmgr/inline/TextLayoutManager.java b/fop-core/src/main/java/org/apache/fop/layoutmgr/inline/TextLayoutManager.java index 6d61aa89e..65b91c3b6 100644 --- a/fop-core/src/main/java/org/apache/fop/layoutmgr/inline/TextLayoutManager.java +++ b/fop-core/src/main/java/org/apache/fop/layoutmgr/inline/TextLayoutManager.java @@ -693,7 +693,7 @@ public class TextLayoutManager extends LeafNodeLayoutManager { /** * The GlyphMapping stores information about spaces. - *

    + *

    * Add the spaces - except zero-width spaces - to the TextArea. */ private void addSpaces() { diff --git a/fop-core/src/main/java/org/apache/fop/pdf/PDFRoot.java b/fop-core/src/main/java/org/apache/fop/pdf/PDFRoot.java index 5077ba68b..23eb0a63a 100644 --- a/fop-core/src/main/java/org/apache/fop/pdf/PDFRoot.java +++ b/fop-core/src/main/java/org/apache/fop/pdf/PDFRoot.java @@ -69,7 +69,7 @@ public class PDFRoot extends PDFDictionary { * it is about to be written (immediately before the xref * table as part of the trailer). (mark-fop@inomial.com) * - * @param objnum the object's number + * @param document TODO * @param pages the PDFPages object */ public PDFRoot(PDFDocument document, PDFPages pages) { diff --git a/fop-core/src/main/java/org/apache/fop/pdf/StructureHierarchyMember.java b/fop-core/src/main/java/org/apache/fop/pdf/StructureHierarchyMember.java index e3be92102..244770991 100644 --- a/fop-core/src/main/java/org/apache/fop/pdf/StructureHierarchyMember.java +++ b/fop-core/src/main/java/org/apache/fop/pdf/StructureHierarchyMember.java @@ -23,7 +23,7 @@ package org.apache.fop.pdf; * An element in the document's structure tree. This can be either the structure tree root * or a structure element. * - * @see "Section 10.6, Logical Structure of the PDF Reference, 4th edition (PDF 1.5)" + * "Section 10.6, Logical Structure of the PDF Reference, 4th edition (PDF 1.5)" */ public abstract class StructureHierarchyMember extends PDFDictionary { diff --git a/fop-core/src/main/java/org/apache/fop/render/AbstractPathOrientedRenderer.java b/fop-core/src/main/java/org/apache/fop/render/AbstractPathOrientedRenderer.java index bc514acd9..552d9f92f 100644 --- a/fop-core/src/main/java/org/apache/fop/render/AbstractPathOrientedRenderer.java +++ b/fop-core/src/main/java/org/apache/fop/render/AbstractPathOrientedRenderer.java @@ -326,7 +326,6 @@ public abstract class AbstractPathOrientedRenderer extends PrintRenderer { * @param bpsAfter the border-after traits * @param bpsStart the border-start traits * @param bpsEnd the border-end traits - * @param innerBackgroundColor the background color of the block */ protected void clipBackground(float startx, float starty, float width, float height, diff --git a/fop-core/src/main/java/org/apache/fop/render/ImageHandlerBase.java b/fop-core/src/main/java/org/apache/fop/render/ImageHandlerBase.java index f07c89671..2d45d9549 100644 --- a/fop-core/src/main/java/org/apache/fop/render/ImageHandlerBase.java +++ b/fop-core/src/main/java/org/apache/fop/render/ImageHandlerBase.java @@ -32,7 +32,7 @@ public interface ImageHandlerBase { * Returns the priority for this image handler. A lower value means higher priority. This * information is used to build the ordered/prioritized list of supported ImageFlavors. * The built-in handlers use priorities between 100 and 999. - * @return a positive integer (>0) indicating the priority + * @return a positive integer (>0) indicating the priority */ int getPriority(); diff --git a/fop-core/src/main/java/org/apache/fop/render/afp/exceptions/RendererRuntimeException.java b/fop-core/src/main/java/org/apache/fop/render/afp/exceptions/RendererRuntimeException.java index fe9ec87c0..e84eac1a5 100644 --- a/fop-core/src/main/java/org/apache/fop/render/afp/exceptions/RendererRuntimeException.java +++ b/fop-core/src/main/java/org/apache/fop/render/afp/exceptions/RendererRuntimeException.java @@ -21,7 +21,7 @@ package org.apache.fop.render.afp.exceptions; /** * A runtime exception for handling fatal errors in rendering. - *

    + *

    */ public class RendererRuntimeException extends NestedRuntimeException { diff --git a/fop-core/src/main/java/org/apache/fop/render/afp/extensions/AFPAttribute.java b/fop-core/src/main/java/org/apache/fop/render/afp/extensions/AFPAttribute.java index 7c88c7168..904d2e2ea 100644 --- a/fop-core/src/main/java/org/apache/fop/render/afp/extensions/AFPAttribute.java +++ b/fop-core/src/main/java/org/apache/fop/render/afp/extensions/AFPAttribute.java @@ -28,7 +28,7 @@ import org.apache.fop.fo.properties.StringProperty; * in order to provide a static property maker. The object facilitates * extraction of attributes from formatted objects based on the static list * as defined in the AFPElementMapping implementation. - *

    + *

    */ public class AFPAttribute extends StringProperty.Maker { diff --git a/fop-core/src/main/java/org/apache/fop/render/afp/extensions/AFPElementMapping.java b/fop-core/src/main/java/org/apache/fop/render/afp/extensions/AFPElementMapping.java index 4e4100bc7..cbb31bcb7 100644 --- a/fop-core/src/main/java/org/apache/fop/render/afp/extensions/AFPElementMapping.java +++ b/fop-core/src/main/java/org/apache/fop/render/afp/extensions/AFPElementMapping.java @@ -29,7 +29,7 @@ import org.apache.fop.fo.FONode; * for custom AFP extensions not supported by the FO schema. Examples include * adding overlays or indexing a document using the tag logical element * structured field. - *

    + *

    */ public class AFPElementMapping extends ElementMapping { diff --git a/fop-core/src/main/java/org/apache/fop/render/afp/extensions/AFPIncludeFormMapElement.java b/fop-core/src/main/java/org/apache/fop/render/afp/extensions/AFPIncludeFormMapElement.java index 71765bb7d..796f6396d 100644 --- a/fop-core/src/main/java/org/apache/fop/render/afp/extensions/AFPIncludeFormMapElement.java +++ b/fop-core/src/main/java/org/apache/fop/render/afp/extensions/AFPIncludeFormMapElement.java @@ -32,8 +32,7 @@ import org.apache.fop.fo.PropertyList; import org.apache.fop.fo.extensions.ExtensionAttachment; /** - * This class extends the {@link org.apache.fop.fo.extensions.ExtensionObj} class. - * It represents the "include-form-map" extension in the FO tree. + * Represents the "include-form-map" extension in the FO tree. */ public class AFPIncludeFormMapElement extends AbstractAFPExtensionObject { diff --git a/fop-core/src/main/java/org/apache/fop/render/afp/extensions/AFPPageOverlayElement.java b/fop-core/src/main/java/org/apache/fop/render/afp/extensions/AFPPageOverlayElement.java index 59df1529e..1ab259e69 100644 --- a/fop-core/src/main/java/org/apache/fop/render/afp/extensions/AFPPageOverlayElement.java +++ b/fop-core/src/main/java/org/apache/fop/render/afp/extensions/AFPPageOverlayElement.java @@ -35,7 +35,7 @@ import org.apache.fop.fo.extensions.ExtensionAttachment; /** * This class extends the org.apache.fop.render.afp.extensions.AbstractAFPExtensionObject class. * This object will be used to map the page overlay object in AFPElementMapping. - *

    + *

    */ public class AFPPageOverlayElement extends AbstractAFPExtensionObject { diff --git a/fop-core/src/main/java/org/apache/fop/render/afp/extensions/AFPPageSegmentElement.java b/fop-core/src/main/java/org/apache/fop/render/afp/extensions/AFPPageSegmentElement.java index 1925e1456..0e84079af 100644 --- a/fop-core/src/main/java/org/apache/fop/render/afp/extensions/AFPPageSegmentElement.java +++ b/fop-core/src/main/java/org/apache/fop/render/afp/extensions/AFPPageSegmentElement.java @@ -34,7 +34,7 @@ import org.apache.fop.fo.extensions.ExtensionAttachment; * This class extends the org.apache.fop.extensions.ExtensionObj class. The * object faciliates extraction of elements from formatted objects based on * the static list as defined in the AFPElementMapping implementation. - *

    + *

    */ public class AFPPageSegmentElement extends AFPPageSetupElement { diff --git a/fop-core/src/main/java/org/apache/fop/render/bitmap/TIFFRenderer.java b/fop-core/src/main/java/org/apache/fop/render/bitmap/TIFFRenderer.java index 442660c3b..09b4530b5 100644 --- a/fop-core/src/main/java/org/apache/fop/render/bitmap/TIFFRenderer.java +++ b/fop-core/src/main/java/org/apache/fop/render/bitmap/TIFFRenderer.java @@ -65,8 +65,7 @@ import static org.apache.fop.render.bitmap.TIFFCompressionValue.PACKBITS; *

  • JPEG-in-TIFF compression
  • *
  • DEFLATE lossless compression (also known as "Zip-in-TIFF")
  • *
  • LZW compression
  • - * TODO - *

    + * * This class actually does not render itself, instead it extends * org.apache.fop.render.java2D.Java2DRenderer and just encode * rendering results into TIFF format using Batik's image codec diff --git a/fop-core/src/main/java/org/apache/fop/render/intermediate/BorderPainter.java b/fop-core/src/main/java/org/apache/fop/render/intermediate/BorderPainter.java index 1ec127f83..d6d2a10c9 100644 --- a/fop-core/src/main/java/org/apache/fop/render/intermediate/BorderPainter.java +++ b/fop-core/src/main/java/org/apache/fop/render/intermediate/BorderPainter.java @@ -58,7 +58,7 @@ public class BorderPainter { /** The ratio between a solid dash and the white-space in a dashed-border */ public static final float DASHED_BORDER_SPACE_RATIO = 0.5f; - /** The length of the dash as a factor of the border width i.e. 2 -> dashWidth = 2*borderWidth */ + /** The length of the dash as a factor of the border width i.e. 2 -> dashWidth = 2*borderWidth */ protected static final float DASHED_BORDER_LENGTH_FACTOR = 2.0f; private final GraphicsPainter graphicsPainter; @@ -284,7 +284,6 @@ public class BorderPainter { * condition that corners start on a dash and end with a dash (rather than ending with a white space). * @param borderLength The length of the border. * @param borderWidth The width/thickness of the border. - * @param dashSpaceRatio The ratio between dashes and white-space. * @return returns the length of the dash such that it fits the criteria above. */ public static float dashWidthCalculator(float borderLength, float borderWidth) { @@ -299,10 +298,6 @@ public class BorderPainter { /** TODO merge with drawRectangularBorders? * @param borderRect the border rectangle - * @param bpsBefore the border specification on the before side - * @param bpsAfter the border specification on the after side - * @param bpsStart the border specification on the start side - * @param bpsEnd the border specification on the end side * @throws IOException on io exception * */ protected void drawRoundedBorders(Rectangle borderRect, diff --git a/fop-core/src/main/java/org/apache/fop/render/intermediate/IFContext.java b/fop-core/src/main/java/org/apache/fop/render/intermediate/IFContext.java index 0edb94c4b..aa94abef0 100644 --- a/fop-core/src/main/java/org/apache/fop/render/intermediate/IFContext.java +++ b/fop-core/src/main/java/org/apache/fop/render/intermediate/IFContext.java @@ -88,7 +88,7 @@ public class IFContext { /** * Returns the currently applicable foreign attributes. - * @return a Map + * @return a Map<QName, Object> */ public Map getForeignAttributes() { return this.foreignAttributes; @@ -105,7 +105,7 @@ public class IFContext { /** * Sets the currently applicable foreign attributes. - * @param foreignAttributes a Map or null to reset + * @param foreignAttributes a Map<QName, Object> or null to reset */ public void setForeignAttributes(Map foreignAttributes) { if (foreignAttributes != null) { @@ -190,7 +190,7 @@ public class IFContext { /** * Sets the location of the object enclosing the current content. * - * @location the line and column location of the object in the source FO file + * location the line and column location of the object in the source FO file */ public void setLocation(String location) { this.location = location; diff --git a/fop-core/src/main/java/org/apache/fop/render/intermediate/IFSerializer.java b/fop-core/src/main/java/org/apache/fop/render/intermediate/IFSerializer.java index 5ea07b330..d91e11fbe 100644 --- a/fop-core/src/main/java/org/apache/fop/render/intermediate/IFSerializer.java +++ b/fop-core/src/main/java/org/apache/fop/render/intermediate/IFSerializer.java @@ -72,7 +72,7 @@ implements IFConstants, IFPainter, IFDocumentNavigationHandler { * in the root element of the IF document, the initial value of which * is set to '2.0' to signify that something preceded it (but didn't * happen to be marked as such), and that this version is not necessarily - * backwards compatible with the unmarked (<2.0) version. + * backwards compatible with the unmarked (<2.0) version. */ public static final String VERSION = "2.0"; diff --git a/fop-core/src/main/java/org/apache/fop/render/pcl/PCLGenerator.java b/fop-core/src/main/java/org/apache/fop/render/pcl/PCLGenerator.java index 119ec857c..bf45989f9 100644 --- a/fop-core/src/main/java/org/apache/fop/render/pcl/PCLGenerator.java +++ b/fop-core/src/main/java/org/apache/fop/render/pcl/PCLGenerator.java @@ -573,8 +573,8 @@ public class PCLGenerator { /** * Select the current pattern - * @param patternID the pattern ID (*c#G command) - * @param pattern the pattern type (*v#T command) + * @param patternID the pattern ID (<ESC>*c#G command) + * @param pattern the pattern type (<ESC>*v#T command) * @throws IOException In case of an I/O error */ public void selectCurrentPattern(int patternID, int pattern) throws IOException { diff --git a/fop-core/src/main/java/org/apache/fop/render/pcl/PCLPageDefinition.java b/fop-core/src/main/java/org/apache/fop/render/pcl/PCLPageDefinition.java index a07a1a503..834e9990d 100644 --- a/fop-core/src/main/java/org/apache/fop/render/pcl/PCLPageDefinition.java +++ b/fop-core/src/main/java/org/apache/fop/render/pcl/PCLPageDefinition.java @@ -46,7 +46,7 @@ public class PCLPageDefinition { /** * Main constructor * @param name the name of the page definition - * @param selector the selector used by the &l#A command (page size) + * @param selector the selector used by the <ESC> command (page size) * @param physicalPageSize the physical page size * @param logicalPageRect the rectangle defining the logical page * @param landscape true if it is a landscape format @@ -65,7 +65,7 @@ public class PCLPageDefinition { return this.name; } - /** @return the selector used by the &l#A command (page size) */ + /** @return the selector used by the <ESC> command (page size) */ public int getSelector() { return this.selector; } diff --git a/fop-core/src/main/java/org/apache/fop/render/pdf/PDFContentGenerator.java b/fop-core/src/main/java/org/apache/fop/render/pdf/PDFContentGenerator.java index fc1f31cc6..4c6af0dc2 100644 --- a/fop-core/src/main/java/org/apache/fop/render/pdf/PDFContentGenerator.java +++ b/fop-core/src/main/java/org/apache/fop/render/pdf/PDFContentGenerator.java @@ -329,7 +329,7 @@ public class PDFContentGenerator { * @param mcid sequence number * @param actualText the replacement text for the marked content * @see #beginTextObject() - * @see #beginMarkedContentSequence(String, int, String)) + * @see #beginMarkedContentSequence */ protected void beginTextObject(String structElemType, int mcid, String actualText) { if (!textutil.isInTextObject()) { diff --git a/fop-core/src/main/java/org/apache/fop/render/ps/AbstractPSTranscoder.java b/fop-core/src/main/java/org/apache/fop/render/ps/AbstractPSTranscoder.java index 24a48d225..a18fddcdc 100644 --- a/fop-core/src/main/java/org/apache/fop/render/ps/AbstractPSTranscoder.java +++ b/fop-core/src/main/java/org/apache/fop/render/ps/AbstractPSTranscoder.java @@ -61,7 +61,7 @@ import org.apache.fop.svg.font.FOPFontFamilyResolverImpl; * processor can be specified: * *

    KEY_LANGUAGE to set the default language to use (may be - * used by a <switch> SVG element for example), + * used by a <switch> SVG element for example), * KEY_USER_STYLESHEET_URI to fix the URI of a user * stylesheet, and KEY_PIXEL_TO_MM to specify the pixel to * millimeter conversion factor. diff --git a/fop-core/src/main/java/org/apache/fop/render/ps/EPSTranscoder.java b/fop-core/src/main/java/org/apache/fop/render/ps/EPSTranscoder.java index 79856b835..28e8fb3e8 100644 --- a/fop-core/src/main/java/org/apache/fop/render/ps/EPSTranscoder.java +++ b/fop-core/src/main/java/org/apache/fop/render/ps/EPSTranscoder.java @@ -41,7 +41,7 @@ import org.apache.xmlgraphics.java2d.ps.EPSDocumentGraphics2D; * processor can be specified: * *

    KEY_LANGUAGE to set the default language to use (may be - * used by a <switch> SVG element for example), + * used by a <switch> SVG element for example), * KEY_USER_STYLESHEET_URI to fix the URI of a user * stylesheet, and KEY_PIXEL_TO_MM to specify the pixel to * millimeter conversion factor. diff --git a/fop-core/src/main/java/org/apache/fop/render/ps/PSTextElementBridge.java b/fop-core/src/main/java/org/apache/fop/render/ps/PSTextElementBridge.java index f331ecad9..165f0abab 100644 --- a/fop-core/src/main/java/org/apache/fop/render/ps/PSTextElementBridge.java +++ b/fop-core/src/main/java/org/apache/fop/render/ps/PSTextElementBridge.java @@ -28,16 +28,16 @@ import org.apache.batik.bridge.TextPainter; import org.apache.batik.gvt.GraphicsNode; /** - *

    Bridge class for the <text> element. + * Bridge class for the <text> element. * This bridge will use the direct text painter if the text - * for the element is simple.

    + * for the element is simple. */ public class PSTextElementBridge extends SVGTextElementBridge { private TextPainter textPainter; /** - * Constructs a new bridge for the <text> element. + * Constructs a new bridge for the <text> element. * @param textPainter the text painter to use */ public PSTextElementBridge(TextPainter textPainter) { diff --git a/fop-core/src/main/java/org/apache/fop/render/ps/PSTextPainter.java b/fop-core/src/main/java/org/apache/fop/render/ps/PSTextPainter.java index eb726c940..57397efc6 100644 --- a/fop-core/src/main/java/org/apache/fop/render/ps/PSTextPainter.java +++ b/fop-core/src/main/java/org/apache/fop/render/ps/PSTextPainter.java @@ -47,7 +47,7 @@ import org.apache.fop.svg.NativeTextPainter; import org.apache.fop.util.HexEncoder; /** - * Renders the attributed character iterator of a {@link org.apache.batik.gvt.TextNode TextNode}. + * Renders the attributed character iterator of a {@link org.apache.batik.bridge.TextNode TextNode}. * This class draws the text directly using PostScript text operators so * the text is not drawn using shapes which makes the PS files larger. *

    diff --git a/fop-core/src/main/java/org/apache/fop/render/ps/PSTranscoder.java b/fop-core/src/main/java/org/apache/fop/render/ps/PSTranscoder.java index aeaa74714..7857e2797 100644 --- a/fop-core/src/main/java/org/apache/fop/render/ps/PSTranscoder.java +++ b/fop-core/src/main/java/org/apache/fop/render/ps/PSTranscoder.java @@ -41,7 +41,7 @@ import org.apache.xmlgraphics.java2d.ps.PSDocumentGraphics2D; * processor can be specified: * *

    KEY_LANGUAGE to set the default language to use (may be - * used by a <switch> SVG element for example), + * used by a <switch> SVG element for example), * KEY_USER_STYLESHEET_URI to fix the URI of a user * stylesheet, and KEY_PIXEL_TO_MM to specify the pixel to * millimeter conversion factor. diff --git a/fop-core/src/main/java/org/apache/fop/render/ps/fonts/PSTTFGenerator.java b/fop-core/src/main/java/org/apache/fop/render/ps/fonts/PSTTFGenerator.java index 556b62457..abe48326f 100644 --- a/fop-core/src/main/java/org/apache/fop/render/ps/fonts/PSTTFGenerator.java +++ b/fop-core/src/main/java/org/apache/fop/render/ps/fonts/PSTTFGenerator.java @@ -79,7 +79,7 @@ public class PSTTFGenerator { * @param byteArray byte[] a byte array * @param offset the position in the byte array where the streaming must start * @param length the number of bytes to stream. This MUST be less than - * {@link #MAX_BUFFER_SIZE} - 1 since strings are suffixed by '00' (see Section 4.2 of + * MAX_BUFFER_SIZE - 1 since strings are suffixed by '00' (see Section 4.2 of * Adobe Technical Note #5012, The Type 42 Font Format Specification.). */ public void streamBytes(byte[] byteArray, int offset, int length) throws IOException { @@ -91,7 +91,7 @@ public class PSTTFGenerator { } /** - * Finishes writing a string by appending '00' and '>' to the end. + * Finishes writing a string by appending '00' and '>' to the end. */ public void endString() throws IOException { /* Appends a '00' to the end of the string as specified in the spec */ diff --git a/fop-core/src/main/java/org/apache/fop/render/rtf/BorderAttributesConverter.java b/fop-core/src/main/java/org/apache/fop/render/rtf/BorderAttributesConverter.java index 4dd7a2d95..a86346222 100644 --- a/fop-core/src/main/java/org/apache/fop/render/rtf/BorderAttributesConverter.java +++ b/fop-core/src/main/java/org/apache/fop/render/rtf/BorderAttributesConverter.java @@ -21,7 +21,7 @@ package org.apache.fop.render.rtf; /* * This file is part of the RTF library of the FOP project, which was originally - * created by Bertrand Delacretaz and by other + * created by Bertrand Delacretaz bdelacretaz@codeconsult.ch and by other * contributors to the jfor project (www.jfor.org), who agreed to donate jfor to * the FOP project. */ diff --git a/fop-core/src/main/java/org/apache/fop/render/rtf/RTFPlaceHolderHelper.java b/fop-core/src/main/java/org/apache/fop/render/rtf/RTFPlaceHolderHelper.java index e3278ad95..a1db1fd4e 100644 --- a/fop-core/src/main/java/org/apache/fop/render/rtf/RTFPlaceHolderHelper.java +++ b/fop-core/src/main/java/org/apache/fop/render/rtf/RTFPlaceHolderHelper.java @@ -47,7 +47,6 @@ public class RTFPlaceHolderHelper { * A method to create an object which is missing and required from the * RTF structure. * @param containerClass The class which is missing - * @throws Exception */ public void createRTFPlaceholder(Class containerClass) throws RtfException { if (containerClass == RtfTableRow.class) { diff --git a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/exceptions/RtfException.java b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/exceptions/RtfException.java index eb26a4137..454dc51db 100644 --- a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/exceptions/RtfException.java +++ b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/exceptions/RtfException.java @@ -21,7 +21,7 @@ package org.apache.fop.render.rtf.rtflib.exceptions; /* * This file is part of the RTF library of the FOP project, which was originally - * created by Bertrand Delacretaz and by other + * created by Bertrand Delacretaz bdelacretaz@codeconsult.ch and by other * contributors to the jfor project (www.jfor.org), who agreed to donate jfor to * the FOP project. */ diff --git a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/exceptions/RtfStructureException.java b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/exceptions/RtfStructureException.java index b4e8e6f2e..2eafcedeb 100644 --- a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/exceptions/RtfStructureException.java +++ b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/exceptions/RtfStructureException.java @@ -21,7 +21,7 @@ package org.apache.fop.render.rtf.rtflib.exceptions; /* * This file is part of the RTF library of the FOP project, which was originally - * created by Bertrand Delacretaz and by other + * created by Bertrand Delacretaz bdelacretaz@codeconsult.ch and by other * contributors to the jfor project (www.jfor.org), who agreed to donate jfor to * the FOP project. */ diff --git a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IBorderAttributes.java b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IBorderAttributes.java index 5b3153b15..50c710ca6 100644 --- a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IBorderAttributes.java +++ b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IBorderAttributes.java @@ -21,7 +21,7 @@ package org.apache.fop.render.rtf.rtflib.rtfdoc; /* * This file is part of the RTF library of the FOP project, which was originally - * created by Bertrand Delacretaz and by other + * created by Bertrand Delacretaz bdelacretaz@codeconsult.ch and by other * contributors to the jfor project (www.jfor.org), who agreed to donate jfor to * the FOP project. */ diff --git a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfAfterContainer.java b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfAfterContainer.java index c4231a0d3..d070edbb2 100644 --- a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfAfterContainer.java +++ b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfAfterContainer.java @@ -21,7 +21,7 @@ package org.apache.fop.render.rtf.rtflib.rtfdoc; /* * This file is part of the RTF library of the FOP project, which was originally - * created by Bertrand Delacretaz and by other + * created by Bertrand Delacretaz bdelacretaz@codeconsult.ch and by other * contributors to the jfor project (www.jfor.org), who agreed to donate jfor to * the FOP project. */ diff --git a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfBeforeContainer.java b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfBeforeContainer.java index 416c885a1..9ff07df56 100644 --- a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfBeforeContainer.java +++ b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfBeforeContainer.java @@ -21,7 +21,7 @@ package org.apache.fop.render.rtf.rtflib.rtfdoc; /* * This file is part of the RTF library of the FOP project, which was originally - * created by Bertrand Delacretaz and by other + * created by Bertrand Delacretaz bdelacretaz@codeconsult.ch and by other * contributors to the jfor project (www.jfor.org), who agreed to donate jfor to * the FOP project. */ diff --git a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfBookmarkContainer.java b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfBookmarkContainer.java index 68c17b695..eb355589e 100644 --- a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfBookmarkContainer.java +++ b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfBookmarkContainer.java @@ -21,7 +21,7 @@ package org.apache.fop.render.rtf.rtflib.rtfdoc; /* * This file is part of the RTF library of the FOP project, which was originally - * created by Bertrand Delacretaz and by other + * created by Bertrand Delacretaz bdelacretaz@codeconsult.ch and by other * contributors to the jfor project (www.jfor.org), who agreed to donate jfor to * the FOP project. */ diff --git a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfExternalGraphicContainer.java b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfExternalGraphicContainer.java index 22914a5a0..cf850c9e7 100644 --- a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfExternalGraphicContainer.java +++ b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfExternalGraphicContainer.java @@ -21,7 +21,7 @@ package org.apache.fop.render.rtf.rtflib.rtfdoc; /* * This file is part of the RTF library of the FOP project, which was originally - * created by Bertrand Delacretaz and by other + * created by Bertrand Delacretaz bdelacretaz@codeconsult.ch and by other * contributors to the jfor project (www.jfor.org), who agreed to donate jfor to * the FOP project. */ diff --git a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfHyperLinkContainer.java b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfHyperLinkContainer.java index 195c71423..823d9b926 100644 --- a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfHyperLinkContainer.java +++ b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfHyperLinkContainer.java @@ -21,7 +21,7 @@ package org.apache.fop.render.rtf.rtflib.rtfdoc; /* * This file is part of the RTF library of the FOP project, which was originally - * created by Bertrand Delacretaz and by other + * created by Bertrand Delacretaz bdelacretaz@codeconsult.ch and by other * contributors to the jfor project (www.jfor.org), who agreed to donate jfor to * the FOP project. */ diff --git a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfJforCmdContainer.java b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfJforCmdContainer.java index c1b603252..ce1109ba8 100644 --- a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfJforCmdContainer.java +++ b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfJforCmdContainer.java @@ -21,7 +21,7 @@ package org.apache.fop.render.rtf.rtflib.rtfdoc; /* * This file is part of the RTF library of the FOP project, which was originally - * created by Bertrand Delacretaz and by other + * created by Bertrand Delacretaz bdelacretaz@codeconsult.ch and by other * contributors to the jfor project (www.jfor.org), who agreed to donate jfor to * the FOP project. */ diff --git a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfListContainer.java b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfListContainer.java index 62ec52d8a..13afdaca8 100644 --- a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfListContainer.java +++ b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfListContainer.java @@ -21,7 +21,7 @@ package org.apache.fop.render.rtf.rtflib.rtfdoc; /* * This file is part of the RTF library of the FOP project, which was originally - * created by Bertrand Delacretaz and by other + * created by Bertrand Delacretaz bdelacretaz@codeconsult.ch and by other * contributors to the jfor project (www.jfor.org), who agreed to donate jfor to * the FOP project. */ diff --git a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfOptions.java b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfOptions.java index 23b8f2d8a..019e5ffc4 100644 --- a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfOptions.java +++ b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfOptions.java @@ -21,7 +21,7 @@ package org.apache.fop.render.rtf.rtflib.rtfdoc; /* * This file is part of the RTF library of the FOP project, which was originally - * created by Bertrand Delacretaz and by other + * created by Bertrand Delacretaz bdelacretaz@codeconsult.ch and by other * contributors to the jfor project (www.jfor.org), who agreed to donate jfor to * the FOP project. */ diff --git a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfPageBreakContainer.java b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfPageBreakContainer.java index 825b3c2b4..27657805d 100644 --- a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfPageBreakContainer.java +++ b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfPageBreakContainer.java @@ -21,7 +21,7 @@ package org.apache.fop.render.rtf.rtflib.rtfdoc; /* * This file is part of the RTF library of the FOP project, which was originally - * created by Bertrand Delacretaz and by other + * created by Bertrand Delacretaz bdelacretaz@codeconsult.ch and by other * contributors to the jfor project (www.jfor.org), who agreed to donate jfor to * the FOP project. */ diff --git a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfPageContainer.java b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfPageContainer.java index 92a71218f..8c11d4095 100644 --- a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfPageContainer.java +++ b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfPageContainer.java @@ -21,7 +21,7 @@ package org.apache.fop.render.rtf.rtflib.rtfdoc; /* * This file is part of the RTF library of the FOP project, which was originally - * created by Bertrand Delacretaz and by other + * created by Bertrand Delacretaz bdelacretaz@codeconsult.ch and by other * contributors to the jfor project (www.jfor.org), who agreed to donate jfor to * the FOP project. */ diff --git a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfPageNumberCitationContainer.java b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfPageNumberCitationContainer.java index dba341700..35a1b4b5c 100644 --- a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfPageNumberCitationContainer.java +++ b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfPageNumberCitationContainer.java @@ -21,7 +21,7 @@ package org.apache.fop.render.rtf.rtflib.rtfdoc; /* * This file is part of the RTF library of the FOP project, which was originally - * created by Bertrand Delacretaz and by other + * created by Bertrand Delacretaz bdelacretaz@codeconsult.ch and by other * contributors to the jfor project (www.jfor.org), who agreed to donate jfor to * the FOP project. */ diff --git a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfPageNumberContainer.java b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfPageNumberContainer.java index 9226578db..3074951b9 100644 --- a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfPageNumberContainer.java +++ b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfPageNumberContainer.java @@ -21,7 +21,7 @@ package org.apache.fop.render.rtf.rtflib.rtfdoc; /* * This file is part of the RTF library of the FOP project, which was originally - * created by Bertrand Delacretaz and by other + * created by Bertrand Delacretaz bdelacretaz@codeconsult.ch and by other * contributors to the jfor project (www.jfor.org), who agreed to donate jfor to * the FOP project. */ diff --git a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfParagraphContainer.java b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfParagraphContainer.java index 335d81f2d..6122ad6b3 100644 --- a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfParagraphContainer.java +++ b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfParagraphContainer.java @@ -21,7 +21,7 @@ package org.apache.fop.render.rtf.rtflib.rtfdoc; /* * This file is part of the RTF library of the FOP project, which was originally - * created by Bertrand Delacretaz and by other + * created by Bertrand Delacretaz bdelacretaz@codeconsult.ch and by other * contributors to the jfor project (www.jfor.org), who agreed to donate jfor to * the FOP project. */ diff --git a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfParagraphKeepTogetherContainer.java b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfParagraphKeepTogetherContainer.java index e3a4819ed..86133f24a 100644 --- a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfParagraphKeepTogetherContainer.java +++ b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfParagraphKeepTogetherContainer.java @@ -21,7 +21,7 @@ package org.apache.fop.render.rtf.rtflib.rtfdoc; /* * This file is part of the RTF library of the FOP project, which was originally - * created by Bertrand Delacretaz and by other + * created by Bertrand Delacretaz bdelacretaz@codeconsult.ch and by other * contributors to the jfor project (www.jfor.org), who agreed to donate jfor to * the FOP project. */ diff --git a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfTableContainer.java b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfTableContainer.java index 635177727..544da4e40 100644 --- a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfTableContainer.java +++ b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfTableContainer.java @@ -21,7 +21,7 @@ package org.apache.fop.render.rtf.rtflib.rtfdoc; /* * This file is part of the RTF library of the FOP project, which was originally - * created by Bertrand Delacretaz and by other + * created by Bertrand Delacretaz bdelacretaz@codeconsult.ch and by other * contributors to the jfor project (www.jfor.org), who agreed to donate jfor to * the FOP project. */ diff --git a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfTextContainer.java b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfTextContainer.java index 4a7779cc4..211751da4 100644 --- a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfTextContainer.java +++ b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfTextContainer.java @@ -21,7 +21,7 @@ package org.apache.fop.render.rtf.rtflib.rtfdoc; /* * This file is part of the RTF library of the FOP project, which was originally - * created by Bertrand Delacretaz and by other + * created by Bertrand Delacretaz bdelacretaz@codeconsult.ch and by other * contributors to the jfor project (www.jfor.org), who agreed to donate jfor to * the FOP project. */ diff --git a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/ITableAttributes.java b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/ITableAttributes.java index e0639f6e5..46414dadc 100644 --- a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/ITableAttributes.java +++ b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/ITableAttributes.java @@ -24,7 +24,7 @@ package org.apache.fop.render.rtf.rtflib.rtfdoc; /* * This file is part of the RTF library of the FOP project, which was originally - * created by Bertrand Delacretaz and by other + * created by Bertrand Delacretaz bdelacretaz@codeconsult.ch and by other * contributors to the jfor project (www.jfor.org), who agreed to donate jfor to * the FOP project. */ diff --git a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/ITableColumnsInfo.java b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/ITableColumnsInfo.java index 97a5626f4..8f2e2d86f 100644 --- a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/ITableColumnsInfo.java +++ b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/ITableColumnsInfo.java @@ -21,7 +21,7 @@ package org.apache.fop.render.rtf.rtflib.rtfdoc; /* * This file is part of the RTF library of the FOP project, which was originally - * created by Bertrand Delacretaz and by other + * created by Bertrand Delacretaz bdelacretaz@codeconsult.ch and by other * contributors to the jfor project (www.jfor.org), who agreed to donate jfor to * the FOP project. */ diff --git a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IrtfTemplateContainer.java b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IrtfTemplateContainer.java index 1b32ece43..ae9416f1c 100644 --- a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IrtfTemplateContainer.java +++ b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IrtfTemplateContainer.java @@ -21,7 +21,7 @@ package org.apache.fop.render.rtf.rtflib.rtfdoc; /* * This file is part of the RTF library of the FOP project, which was originally - * created by Bertrand Delacretaz and by other + * created by Bertrand Delacretaz bdelacretaz@codeconsult.ch and by other * contributors to the jfor project (www.jfor.org), who agreed to donate jfor to * the FOP project. */ diff --git a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/ParagraphKeeptogetherContext.java b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/ParagraphKeeptogetherContext.java index ce6212a59..855e2ab1c 100644 --- a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/ParagraphKeeptogetherContext.java +++ b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/ParagraphKeeptogetherContext.java @@ -21,7 +21,7 @@ package org.apache.fop.render.rtf.rtflib.rtfdoc; /* * This file is part of the RTF library of the FOP project, which was originally - * created by Bertrand Delacretaz and by other + * created by Bertrand Delacretaz bdelacretaz@codeconsult.ch and by other * contributors to the jfor project (www.jfor.org), who agreed to donate jfor to * the FOP project. */ diff --git a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfAfter.java b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfAfter.java index 832853f5f..b7ec4e5c4 100644 --- a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfAfter.java +++ b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfAfter.java @@ -21,7 +21,7 @@ package org.apache.fop.render.rtf.rtflib.rtfdoc; /* * This file is part of the RTF library of the FOP project, which was originally - * created by Bertrand Delacretaz and by other + * created by Bertrand Delacretaz bdelacretaz@codeconsult.ch and by other * contributors to the jfor project (www.jfor.org), who agreed to donate jfor to * the FOP project. */ diff --git a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfAttributes.java b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfAttributes.java index 57918f04c..a090250a0 100644 --- a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfAttributes.java +++ b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfAttributes.java @@ -21,7 +21,7 @@ package org.apache.fop.render.rtf.rtflib.rtfdoc; /* * This file is part of the RTF library of the FOP project, which was originally - * created by Bertrand Delacretaz and by other + * created by Bertrand Delacretaz bdelacretaz@codeconsult.ch and by other * contributors to the jfor project (www.jfor.org), who agreed to donate jfor to * the FOP project. */ diff --git a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfBefore.java b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfBefore.java index c15339b0e..055b01874 100644 --- a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfBefore.java +++ b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfBefore.java @@ -21,7 +21,7 @@ package org.apache.fop.render.rtf.rtflib.rtfdoc; /* * This file is part of the RTF library of the FOP project, which was originally - * created by Bertrand Delacretaz and by other + * created by Bertrand Delacretaz bdelacretaz@codeconsult.ch and by other * contributors to the jfor project (www.jfor.org), who agreed to donate jfor to * the FOP project. */ diff --git a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfBookmark.java b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfBookmark.java index e82a50eca..857e01e9d 100644 --- a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfBookmark.java +++ b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfBookmark.java @@ -21,7 +21,7 @@ package org.apache.fop.render.rtf.rtflib.rtfdoc; /* * This file is part of the RTF library of the FOP project, which was originally - * created by Bertrand Delacretaz and by other + * created by Bertrand Delacretaz bdelacretaz@codeconsult.ch and by other * contributors to the jfor project (www.jfor.org), who agreed to donate jfor to * the FOP project. */ diff --git a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfBookmarkContainerImpl.java b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfBookmarkContainerImpl.java index 9733df1e7..124b6e838 100644 --- a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfBookmarkContainerImpl.java +++ b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfBookmarkContainerImpl.java @@ -21,7 +21,7 @@ package org.apache.fop.render.rtf.rtflib.rtfdoc; /* * This file is part of the RTF library of the FOP project, which was originally - * created by Bertrand Delacretaz and by other + * created by Bertrand Delacretaz bdelacretaz@codeconsult.ch and by other * contributors to the jfor project (www.jfor.org), who agreed to donate jfor to * the FOP project. */ diff --git a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfColorTable.java b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfColorTable.java index 3b7535c2a..0ac207ce4 100644 --- a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfColorTable.java +++ b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfColorTable.java @@ -21,7 +21,7 @@ package org.apache.fop.render.rtf.rtflib.rtfdoc; /* * This file is part of the RTF library of the FOP project, which was originally - * created by Bertrand Delacretaz and by other + * created by Bertrand Delacretaz bdelacretaz@codeconsult.ch and by other * contributors to the jfor project (www.jfor.org), who agreed to donate jfor to * the FOP project. */ @@ -31,10 +31,9 @@ import java.util.Hashtable; import java.util.Vector; /** - *

    Singelton of the RTF color table. - * This class was created for tag processing.

    - * - *

    This work was authored by Andreas Putz (a.putz@skynamics.com).

    + * Singelton of the RTF color table. + * This class was created for fo:basic-link tag processing. + * This work was originally authored by Andreas Putz */ public final class RtfColorTable { diff --git a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfContainer.java b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfContainer.java index 46dd3d0ee..3c8d5dd23 100644 --- a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfContainer.java +++ b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfContainer.java @@ -21,7 +21,7 @@ package org.apache.fop.render.rtf.rtflib.rtfdoc; /* * This file is part of the RTF library of the FOP project, which was originally - * created by Bertrand Delacretaz and by other + * created by Bertrand Delacretaz bdelacretaz@codeconsult.ch and by other * contributors to the jfor project (www.jfor.org), who agreed to donate jfor to * the FOP project. */ diff --git a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfDocumentArea.java b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfDocumentArea.java index 1f7fbab1b..039c341eb 100644 --- a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfDocumentArea.java +++ b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfDocumentArea.java @@ -21,7 +21,7 @@ package org.apache.fop.render.rtf.rtflib.rtfdoc; /* * This file is part of the RTF library of the FOP project, which was originally - * created by Bertrand Delacretaz and by other + * created by Bertrand Delacretaz bdelacretaz@codeconsult.ch and by other * contributors to the jfor project (www.jfor.org), who agreed to donate jfor to * the FOP project. */ diff --git a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfElement.java b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfElement.java index 27d10e710..59461a361 100644 --- a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfElement.java +++ b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfElement.java @@ -21,7 +21,7 @@ package org.apache.fop.render.rtf.rtflib.rtfdoc; /* * This file is part of the RTF library of the FOP project, which was originally - * created by Bertrand Delacretaz and by other + * created by Bertrand Delacretaz bdelacretaz@codeconsult.ch and by other * contributors to the jfor project (www.jfor.org), who agreed to donate jfor to * the FOP project. */ diff --git a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfExternalGraphic.java b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfExternalGraphic.java index e936305f9..911c1258e 100644 --- a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfExternalGraphic.java +++ b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfExternalGraphic.java @@ -21,7 +21,7 @@ package org.apache.fop.render.rtf.rtflib.rtfdoc; /* * This file is part of the RTF library of the FOP project, which was originally - * created by Bertrand Delacretaz and by other + * created by Bertrand Delacretaz bdelacretaz@codeconsult.ch and by other * contributors to the jfor project (www.jfor.org), who agreed to donate jfor to * the FOP project. */ @@ -39,27 +39,23 @@ import org.apache.fop.render.rtf.rtflib.tools.ImageConstants; import org.apache.fop.render.rtf.rtflib.tools.ImageUtil; /** - *

    Creates an RTF image from an external graphic file. - * This class belongs to the tag processing.

    + * Creates an RTF image from an external graphic file. + * This class belongs to the fo:external-graphic tag processing.
    * - *

    Supports relative path like "../test.gif", too (01-08-24)

    + * Supports relative path like "../test.gif", too (01-08-24)
    * - *

    Limitations:

    - *
      - *
    • Only the image types PNG, JPEG and EMF are supported - *
    • The GIF is supported, too, but will be converted to JPG - *
    • Only the attributes SRC (required), WIDTH, HEIGHT, SCALING are supported - *
    • The SCALING attribute supports (uniform | non-uniform) - *
    + * Limitations: + * Only the image types PNG, JPEG and EMF are supported + * The GIF is supported, too, but will be converted to JPG + * Only the attributes SRC (required), WIDTH, HEIGHT, SCALING are supported + * The SCALING attribute supports (uniform | non-uniform) * - *

    Known Bugs:

    - *
      - *
    • If the emf image has a desired size, the image will be clipped - *
    • The emf, jpg & png image will not be displayed in correct size - *
    + * Known Bugs: + * If the emf image has a desired size, the image will be clipped + * The emf, jpg, png image will not be displayed in correct size * - *

    This work was authored by Andreas Putz (a.putz@skynamics.com) and - * Gianugo Rabellino (gianugo@rabellino.it).

    + * This work was originally authored by Andreas Putz + * This work was originally authored by Gianugo Rabellino gianugo@rabellino.it */ public class RtfExternalGraphic extends RtfElement { diff --git a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfFile.java b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfFile.java index 3c3ce9a2b..2c4e0807a 100644 --- a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfFile.java +++ b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfFile.java @@ -21,7 +21,7 @@ package org.apache.fop.render.rtf.rtflib.rtfdoc; /* * This file is part of the RTF library of the FOP project, which was originally - * created by Bertrand Delacretaz and by other + * created by Bertrand Delacretaz bdelacretaz@codeconsult.ch and by other * contributors to the jfor project (www.jfor.org), who agreed to donate jfor to * the FOP project. */ diff --git a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfFontManager.java b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfFontManager.java index 2b4e8eba5..1d971309f 100644 --- a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfFontManager.java +++ b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfFontManager.java @@ -21,7 +21,7 @@ package org.apache.fop.render.rtf.rtflib.rtfdoc; /* * This file is part of the RTF library of the FOP project, which was originally - * created by Bertrand Delacretaz and by other + * created by Bertrand Delacretaz bdelacretaz@codeconsult.ch and by other * contributors to the jfor project (www.jfor.org), who agreed to donate jfor to * the FOP project. */ diff --git a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfFontTable.java b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfFontTable.java index 50b53a4e8..8a6e99edf 100644 --- a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfFontTable.java +++ b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfFontTable.java @@ -21,7 +21,7 @@ package org.apache.fop.render.rtf.rtflib.rtfdoc; /* * This file is part of the RTF library of the FOP project, which was originally - * created by Bertrand Delacretaz and by other + * created by Bertrand Delacretaz bdelacretaz@codeconsult.ch and by other * contributors to the jfor project (www.jfor.org), who agreed to donate jfor to * the FOP project. */ diff --git a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfHeader.java b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfHeader.java index 85fbbb8ff..9f0a174e4 100644 --- a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfHeader.java +++ b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfHeader.java @@ -21,7 +21,7 @@ package org.apache.fop.render.rtf.rtflib.rtfdoc; /* * This file is part of the RTF library of the FOP project, which was originally - * created by Bertrand Delacretaz and by other + * created by Bertrand Delacretaz bdelacretaz@codeconsult.ch and by other * contributors to the jfor project (www.jfor.org), who agreed to donate jfor to * the FOP project. */ diff --git a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfHyperLink.java b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfHyperLink.java index 58d93e45d..452ef3673 100644 --- a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfHyperLink.java +++ b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfHyperLink.java @@ -21,7 +21,7 @@ package org.apache.fop.render.rtf.rtflib.rtfdoc; /* * This file is part of the RTF library of the FOP project, which was originally - * created by Bertrand Delacretaz and by other + * created by Bertrand Delacretaz bdelacretaz@codeconsult.ch and by other * contributors to the jfor project (www.jfor.org), who agreed to donate jfor to * the FOP project. */ @@ -32,10 +32,10 @@ import java.io.Writer; import org.apache.fop.apps.FOPException; /** - *

    Creates an hyperlink. - * This class belongs to the tag processing.

    + * Creates an hyperlink. + * This class belongs to the fo:basic-link tag processing. + * This work was originally authored by Andreas Putz * - *

    This work was authored by Andreas Putz (a.putz@skynamics.com).

    */ public class RtfHyperLink extends RtfContainer diff --git a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfJforCmd.java b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfJforCmd.java index dd007f774..f4a3c21c3 100644 --- a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfJforCmd.java +++ b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfJforCmd.java @@ -21,7 +21,7 @@ package org.apache.fop.render.rtf.rtflib.rtfdoc; /* * This file is part of the RTF library of the FOP project, which was originally - * created by Bertrand Delacretaz and by other + * created by Bertrand Delacretaz bdelacretaz@codeconsult.ch and by other * contributors to the jfor project (www.jfor.org), who agreed to donate jfor to * the FOP project. */ diff --git a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfLineBreak.java b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfLineBreak.java index 5fe5c2f0b..f25033cca 100644 --- a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfLineBreak.java +++ b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfLineBreak.java @@ -21,7 +21,7 @@ package org.apache.fop.render.rtf.rtflib.rtfdoc; /* * This file is part of the RTF library of the FOP project, which was originally - * created by Bertrand Delacretaz and by other + * created by Bertrand Delacretaz bdelacretaz@codeconsult.ch and by other * contributors to the jfor project (www.jfor.org), who agreed to donate jfor to * the FOP project. */ diff --git a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfList.java b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfList.java index 9bcf8e1b0..6c072b8b5 100644 --- a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfList.java +++ b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfList.java @@ -21,7 +21,7 @@ package org.apache.fop.render.rtf.rtflib.rtfdoc; /* * This file is part of the RTF library of the FOP project, which was originally - * created by Bertrand Delacretaz and by other + * created by Bertrand Delacretaz bdelacretaz@codeconsult.ch and by other * contributors to the jfor project (www.jfor.org), who agreed to donate jfor to * the FOP project. */ diff --git a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfListItem.java b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfListItem.java index 07b3436ac..0b365bb15 100644 --- a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfListItem.java +++ b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfListItem.java @@ -21,7 +21,7 @@ package org.apache.fop.render.rtf.rtflib.rtfdoc; /* * This file is part of the RTF library of the FOP project, which was originally - * created by Bertrand Delacretaz and by other + * created by Bertrand Delacretaz bdelacretaz@codeconsult.ch and by other * contributors to the jfor project (www.jfor.org), who agreed to donate jfor to * the FOP project. */ diff --git a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfListStyle.java b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfListStyle.java index 4364b92f9..93d7f59ea 100644 --- a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfListStyle.java +++ b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfListStyle.java @@ -21,7 +21,7 @@ package org.apache.fop.render.rtf.rtflib.rtfdoc; /* * This file is part of the RTF library of the FOP project, which was originally - * created by Bertrand Delacretaz and by other + * created by Bertrand Delacretaz bdelacretaz@codeconsult.ch and by other * contributors to the jfor project (www.jfor.org), who agreed to donate jfor to * the FOP project. */ diff --git a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfListStyleBullet.java b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfListStyleBullet.java index e7139d02e..eba75b9aa 100644 --- a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfListStyleBullet.java +++ b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfListStyleBullet.java @@ -21,7 +21,7 @@ package org.apache.fop.render.rtf.rtflib.rtfdoc; /* * This file is part of the RTF library of the FOP project, which was originally - * created by Bertrand Delacretaz and by other + * created by Bertrand Delacretaz bdelacretaz@codeconsult.ch and by other * contributors to the jfor project (www.jfor.org), who agreed to donate jfor to * the FOP project. */ diff --git a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfListStyleNumber.java b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfListStyleNumber.java index f2edf7d2f..f0bfd4d80 100644 --- a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfListStyleNumber.java +++ b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfListStyleNumber.java @@ -21,7 +21,7 @@ package org.apache.fop.render.rtf.rtflib.rtfdoc; /* * This file is part of the RTF library of the FOP project, which was originally - * created by Bertrand Delacretaz and by other + * created by Bertrand Delacretaz bdelacretaz@codeconsult.ch and by other * contributors to the jfor project (www.jfor.org), who agreed to donate jfor to * the FOP project. */ diff --git a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfListStyleText.java b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfListStyleText.java index b10d4348f..e5136b692 100644 --- a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfListStyleText.java +++ b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfListStyleText.java @@ -21,7 +21,7 @@ package org.apache.fop.render.rtf.rtflib.rtfdoc; /* * This file is part of the RTF library of the FOP project, which was originally - * created by Bertrand Delacretaz and by other + * created by Bertrand Delacretaz bdelacretaz@codeconsult.ch and by other * contributors to the jfor project (www.jfor.org), who agreed to donate jfor to * the FOP project. */ diff --git a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfListTable.java b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfListTable.java index a8e4a571f..f660dd83c 100644 --- a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfListTable.java +++ b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfListTable.java @@ -21,7 +21,7 @@ package org.apache.fop.render.rtf.rtflib.rtfdoc; /* * This file is part of the RTF library of the FOP project, which was originally - * created by Bertrand Delacretaz and by other + * created by Bertrand Delacretaz bdelacretaz@codeconsult.ch and by other * contributors to the jfor project (www.jfor.org), who agreed to donate jfor to * the FOP project. */ diff --git a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfNull.java b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfNull.java index c446e0e82..dd0129581 100644 --- a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfNull.java +++ b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfNull.java @@ -21,7 +21,7 @@ package org.apache.fop.render.rtf.rtflib.rtfdoc; /* * This file is part of the RTF library of the FOP project, which was originally - * created by Bertrand Delacretaz and by other + * created by Bertrand Delacretaz bdelacretaz@codeconsult.ch and by other * contributors to the jfor project (www.jfor.org), who agreed to donate jfor to * the FOP project. */ diff --git a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfOptions.java b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfOptions.java index 7cacb82f8..4dc8db11c 100644 --- a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfOptions.java +++ b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfOptions.java @@ -21,7 +21,7 @@ package org.apache.fop.render.rtf.rtflib.rtfdoc; /* * This file is part of the RTF library of the FOP project, which was originally - * created by Bertrand Delacretaz and by other + * created by Bertrand Delacretaz bdelacretaz@codeconsult.ch and by other * contributors to the jfor project (www.jfor.org), who agreed to donate jfor to * the FOP project. */ diff --git a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfPage.java b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfPage.java index 67945e3a1..64dc10870 100644 --- a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfPage.java +++ b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfPage.java @@ -21,7 +21,7 @@ package org.apache.fop.render.rtf.rtflib.rtfdoc; /* * This file is part of the RTF library of the FOP project, which was originally - * created by Bertrand Delacretaz and by other + * created by Bertrand Delacretaz bdelacretaz@codeconsult.ch and by other * contributors to the jfor project (www.jfor.org), who agreed to donate jfor to * the FOP project. */ diff --git a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfPageArea.java b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfPageArea.java index 4dfcd5bec..a78741b5a 100644 --- a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfPageArea.java +++ b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfPageArea.java @@ -21,7 +21,7 @@ package org.apache.fop.render.rtf.rtflib.rtfdoc; /* * This file is part of the RTF library of the FOP project, which was originally - * created by Bertrand Delacretaz and by other + * created by Bertrand Delacretaz bdelacretaz@codeconsult.ch and by other * contributors to the jfor project (www.jfor.org), who agreed to donate jfor to * the FOP project. */ diff --git a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfPageBreak.java b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfPageBreak.java index 9707fe439..31a65ddb4 100644 --- a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfPageBreak.java +++ b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfPageBreak.java @@ -21,7 +21,7 @@ package org.apache.fop.render.rtf.rtflib.rtfdoc; /* * This file is part of the RTF library of the FOP project, which was originally - * created by Bertrand Delacretaz and by other + * created by Bertrand Delacretaz bdelacretaz@codeconsult.ch and by other * contributors to the jfor project (www.jfor.org), who agreed to donate jfor to * the FOP project. */ diff --git a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfPageNumber.java b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfPageNumber.java index 1fc3cd5c1..26aa2d48a 100644 --- a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfPageNumber.java +++ b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfPageNumber.java @@ -21,7 +21,7 @@ package org.apache.fop.render.rtf.rtflib.rtfdoc; /* * This file is part of the RTF library of the FOP project, which was originally - * created by Bertrand Delacretaz and by other + * created by Bertrand Delacretaz bdelacretaz@codeconsult.ch and by other * contributors to the jfor project (www.jfor.org), who agreed to donate jfor to * the FOP project. */ diff --git a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfPageNumberCitation.java b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfPageNumberCitation.java index 6cd78f03b..f97fe2b32 100644 --- a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfPageNumberCitation.java +++ b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfPageNumberCitation.java @@ -21,7 +21,7 @@ package org.apache.fop.render.rtf.rtflib.rtfdoc; /* * This file is part of the RTF library of the FOP project, which was originally - * created by Bertrand Delacretaz and by other + * created by Bertrand Delacretaz bdelacretaz@codeconsult.ch and by other * contributors to the jfor project (www.jfor.org), who agreed to donate jfor to * the FOP project. */ diff --git a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfParagraph.java b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfParagraph.java index 4b5554acf..a6684089e 100644 --- a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfParagraph.java +++ b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfParagraph.java @@ -21,7 +21,7 @@ package org.apache.fop.render.rtf.rtflib.rtfdoc; /* * This file is part of the RTF library of the FOP project, which was originally - * created by Bertrand Delacretaz and by other + * created by Bertrand Delacretaz bdelacretaz@codeconsult.ch and by other * contributors to the jfor project (www.jfor.org), who agreed to donate jfor to * the FOP project. */ diff --git a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfParagraphKeepTogether.java b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfParagraphKeepTogether.java index d682626ec..3b4daff0a 100644 --- a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfParagraphKeepTogether.java +++ b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfParagraphKeepTogether.java @@ -21,7 +21,7 @@ package org.apache.fop.render.rtf.rtflib.rtfdoc; /* * This file is part of the RTF library of the FOP project, which was originally - * created by Bertrand Delacretaz and by other + * created by Bertrand Delacretaz bdelacretaz@codeconsult.ch and by other * contributors to the jfor project (www.jfor.org), who agreed to donate jfor to * the FOP project. */ diff --git a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfSection.java b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfSection.java index 0a796a3d9..19493b54b 100644 --- a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfSection.java +++ b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfSection.java @@ -21,7 +21,7 @@ package org.apache.fop.render.rtf.rtflib.rtfdoc; /* * This file is part of the RTF library of the FOP project, which was originally - * created by Bertrand Delacretaz and by other + * created by Bertrand Delacretaz bdelacretaz@codeconsult.ch and by other * contributors to the jfor project (www.jfor.org), who agreed to donate jfor to * the FOP project. */ diff --git a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfString.java b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfString.java index 8f0e3d0b3..9044ce366 100644 --- a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfString.java +++ b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfString.java @@ -21,7 +21,7 @@ package org.apache.fop.render.rtf.rtflib.rtfdoc; /* * This file is part of the RTF library of the FOP project, which was originally - * created by Bertrand Delacretaz and by other + * created by Bertrand Delacretaz bdelacretaz@codeconsult.ch and by other * contributors to the jfor project (www.jfor.org), who agreed to donate jfor to * the FOP project. */ diff --git a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfStringConverter.java b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfStringConverter.java index b805f1310..dbfc6343f 100644 --- a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfStringConverter.java +++ b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfStringConverter.java @@ -21,7 +21,7 @@ package org.apache.fop.render.rtf.rtflib.rtfdoc; /* * This file is part of the RTF library of the FOP project, which was originally - * created by Bertrand Delacretaz and by other + * created by Bertrand Delacretaz bdelacretaz@codeconsult.ch and by other * contributors to the jfor project (www.jfor.org), who agreed to donate jfor to * the FOP project. */ diff --git a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfStyleSheetTable.java b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfStyleSheetTable.java index e3f7ce3c3..35abc3e2a 100644 --- a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfStyleSheetTable.java +++ b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfStyleSheetTable.java @@ -17,25 +17,25 @@ /* $Id$ */ -package org.apache.fop.render.rtf.rtflib.rtfdoc; /* * This file is part of the RTF library of the FOP project, which was originally - * created by Bertrand Delacretaz and by other + * created by Bertrand Delacretaz bdelacretaz@codeconsult.ch and by other * contributors to the jfor project (www.jfor.org), who agreed to donate jfor to * the FOP project. */ +package org.apache.fop.render.rtf.rtflib.rtfdoc; + import java.io.IOException; import java.util.Hashtable; import java.util.Iterator; import java.util.Vector; /** - *

    Singelton of the RTF style sheet table. - * This class belongs to the tag processing.

    - * - *

    This work was authored by Andreas Putz (a.putz@skynamics.com).

    + * Singelton of the RTF style sheet table. + * This class belongs to the jfor:stylesheet tag processing. + * This work was originally authored by Andreas Putz */ public final class RtfStyleSheetTable { ////////////////////////////////////////////////// diff --git a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfTable.java b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfTable.java index 874873bc6..c07c2fe57 100644 --- a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfTable.java +++ b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfTable.java @@ -21,7 +21,7 @@ package org.apache.fop.render.rtf.rtflib.rtfdoc; /* * This file is part of the RTF library of the FOP project, which was originally - * created by Bertrand Delacretaz and by other + * created by Bertrand Delacretaz bdelacretaz@codeconsult.ch and by other * contributors to the jfor project (www.jfor.org), who agreed to donate jfor to * the FOP project. */ diff --git a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfTableCell.java b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfTableCell.java index 263f6d1ac..731800fdb 100644 --- a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfTableCell.java +++ b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfTableCell.java @@ -21,7 +21,7 @@ package org.apache.fop.render.rtf.rtflib.rtfdoc; /* * This file is part of the RTF library of the FOP project, which was originally - * created by Bertrand Delacretaz and by other + * created by Bertrand Delacretaz bdelacretaz@codeconsult.ch and by other * contributors to the jfor project (www.jfor.org), who agreed to donate jfor to * the FOP project. */ diff --git a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfTableRow.java b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfTableRow.java index 566e2c7ce..be6614394 100644 --- a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfTableRow.java +++ b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfTableRow.java @@ -21,7 +21,7 @@ package org.apache.fop.render.rtf.rtflib.rtfdoc; /* * This file is part of the RTF library of the FOP project, which was originally - * created by Bertrand Delacretaz and by other + * created by Bertrand Delacretaz bdelacretaz@codeconsult.ch and by other * contributors to the jfor project (www.jfor.org), who agreed to donate jfor to * the FOP project. */ diff --git a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfTemplate.java b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfTemplate.java index 6d928765c..eea7fbda3 100644 --- a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfTemplate.java +++ b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfTemplate.java @@ -21,7 +21,7 @@ package org.apache.fop.render.rtf.rtflib.rtfdoc; /* * This file is part of the RTF library of the FOP project, which was originally - * created by Bertrand Delacretaz and by other + * created by Bertrand Delacretaz bdelacretaz@codeconsult.ch and by other * contributors to the jfor project (www.jfor.org), who agreed to donate jfor to * the FOP project. */ @@ -30,7 +30,7 @@ import java.io.IOException; /** * Singelton of the RTF style template - * This class belongs to the tag processing. + * This class belongs to the jfor:style-template tag processing. */ public final class RtfTemplate { diff --git a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfText.java b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfText.java index e32891e9b..5e43857b8 100644 --- a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfText.java +++ b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfText.java @@ -21,7 +21,7 @@ package org.apache.fop.render.rtf.rtflib.rtfdoc; /* * This file is part of the RTF library of the FOP project, which was originally - * created by Bertrand Delacretaz and by other + * created by Bertrand Delacretaz bdelacretaz@codeconsult.ch and by other * contributors to the jfor project (www.jfor.org), who agreed to donate jfor to * the FOP project. */ diff --git a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/WhitespaceCollapser.java b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/WhitespaceCollapser.java index dcb5c0843..22779a832 100644 --- a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/WhitespaceCollapser.java +++ b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/rtfdoc/WhitespaceCollapser.java @@ -21,7 +21,7 @@ package org.apache.fop.render.rtf.rtflib.rtfdoc; /* * This file is part of the RTF library of the FOP project, which was originally - * created by Bertrand Delacretaz and by other + * created by Bertrand Delacretaz bdelacretaz@codeconsult.ch and by other * contributors to the jfor project (www.jfor.org), who agreed to donate jfor to * the FOP project. */ diff --git a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/tools/ImageConstants.java b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/tools/ImageConstants.java index 7f65f9c10..8a0b7f49f 100644 --- a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/tools/ImageConstants.java +++ b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/tools/ImageConstants.java @@ -17,20 +17,20 @@ /* $Id$ */ -package org.apache.fop.render.rtf.rtflib.tools; /* * This file is part of the RTF library of the FOP project, which was originally - * created by Bertrand Delacretaz and by other + * created by Bertrand Delacretaz bdelacretaz@codeconsult.ch and by other * contributors to the jfor project (www.jfor.org), who agreed to donate jfor to * the FOP project. */ -/** - *

    Here will be defined all supported image formats. - * This class belongs to the tag processing.

    - * - *

    This work was authored by Andreas Putz (a.putz@skynamics.com).

    +package org.apache.fop.render.rtf.rtflib.tools; + + +/** Here will be defined all supported image formats. + * This class belongs to the fo:external-graphic tag processing. + * This work was originally authored by a.putz@skynamics.com (Andreas Putz) */ public final class ImageConstants { diff --git a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/tools/ImageUtil.java b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/tools/ImageUtil.java index fb590ab63..41af8204e 100644 --- a/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/tools/ImageUtil.java +++ b/fop-core/src/main/java/org/apache/fop/render/rtf/rtflib/tools/ImageUtil.java @@ -17,20 +17,19 @@ /* $Id$ */ -package org.apache.fop.render.rtf.rtflib.tools; /* * This file is part of the RTF library of the FOP project, which was originally - * created by Bertrand Delacretaz and by other + * created by Bertrand Delacretaz bdelacretaz@codeconsult.ch and by other * contributors to the jfor project (www.jfor.org), who agreed to donate jfor to * the FOP project. */ -/** - *

    Miscellaneous utilities for images handling. - * This class belongs to the tag processing.

    - * - *

    This work was authored by Andreas Putz (a.putz@skynamics.com).

    +package org.apache.fop.render.rtf.rtflib.tools; + +/** Misc.utilities for images handling + * This class belongs to the fo:external-graphic tag processing. + * This work was originally authored by Andreas Putz */ public final class ImageUtil { diff --git a/fop-core/src/main/java/org/apache/fop/render/xml/XMLRenderer.java b/fop-core/src/main/java/org/apache/fop/render/xml/XMLRenderer.java index ffe16f2ca..f8765f280 100644 --- a/fop-core/src/main/java/org/apache/fop/render/xml/XMLRenderer.java +++ b/fop-core/src/main/java/org/apache/fop/render/xml/XMLRenderer.java @@ -105,7 +105,7 @@ public class XMLRenderer extends AbstractXMLRenderer { * in the root element of the AT document, the initial value of which * is set to '2.0' to signify that something preceded it (but didn't * happen to be marked as such), and that this version is not necessarily - * backwards compatible with the unmarked (<2.0) version. + * backwards compatible with the unmarked (<2.0) version. */ public static final String VERSION = "2.0"; diff --git a/fop-core/src/main/java/org/apache/fop/servlet/FopPrintServlet.java b/fop-core/src/main/java/org/apache/fop/servlet/FopPrintServlet.java index 006a95dfc..dddd1ec5e 100644 --- a/fop-core/src/main/java/org/apache/fop/servlet/FopPrintServlet.java +++ b/fop-core/src/main/java/org/apache/fop/servlet/FopPrintServlet.java @@ -47,11 +47,11 @@ import org.apache.fop.apps.MimeConstants; *
  • xml: the path to an XML file to render
  • *
  • xslt: the path to an XSLT file that can transform the above XML to XSL-FO
  • * - *
    + *
    * Example URL: http://servername/fop/servlet/FopPrintServlet?fo=readme.fo - *
    - * Example URL: http://servername/fop/servlet/FopPrintServlet?xml=data.xml&xsl=format.xsl - *
    + *
    + * Example URL: http://servername/fop/servlet/FopPrintServlet?xml=data.xml + *
    * Note: This servlet is derived from FopServlet. Most methods are inherited from the * superclass. Only the differences to the base class are necessary. */ diff --git a/fop-core/src/main/java/org/apache/fop/servlet/FopServlet.java b/fop-core/src/main/java/org/apache/fop/servlet/FopServlet.java index 8d2f0c4cd..406ead324 100644 --- a/fop-core/src/main/java/org/apache/fop/servlet/FopServlet.java +++ b/fop-core/src/main/java/org/apache/fop/servlet/FopServlet.java @@ -53,7 +53,7 @@ import org.apache.fop.apps.MimeConstants; /** * Example servlet to generate a PDF from a servlet. - *
    + *
    * Servlet param is: *
      *
    • fo: the path to a XSL-FO file to render @@ -63,12 +63,12 @@ import org.apache.fop.apps.MimeConstants; *
    • xml: the path to an XML file to render
    • *
    • xslt: the path to an XSLT file that can transform the above XML to XSL-FO
    • *
    - *
    + *
    * Example URL: http://servername/fop/servlet/FopServlet?fo=readme.fo - *
    - * Example URL: http://servername/fop/servlet/FopServlet?xml=data.xml&xslt=format.xsl - *
    - * For this to work with Internet Explorer, you might need to append "&ext=.pdf" + *
    + * Example URL: http://servername/fop/servlet/FopServlet?xml=data.xml + *
    + * For this to work with Internet Explorer, you might need to append "ext=.pdf" * to the URL. * (todo) Ev. add caching mechanism for Templates objects */ diff --git a/fop-core/src/main/java/org/apache/fop/svg/AbstractFOPImageElementBridge.java b/fop-core/src/main/java/org/apache/fop/svg/AbstractFOPImageElementBridge.java index 42fb729dd..d902c6216 100644 --- a/fop-core/src/main/java/org/apache/fop/svg/AbstractFOPImageElementBridge.java +++ b/fop-core/src/main/java/org/apache/fop/svg/AbstractFOPImageElementBridge.java @@ -47,14 +47,14 @@ import org.apache.xmlgraphics.java2d.Graphics2DImagePainter; import org.apache.fop.image.loader.batik.BatikUtil; /** - *

    Bridge class for the <image> element when jpeg images.

    + * Bridge class for the <image> element when jpeg images. * - *

    This work was authored by Keiron Liddle (keiron@aftexsw.com).

    + * This work was originally authored by Keiron Liddle */ public abstract class AbstractFOPImageElementBridge extends SVGImageElementBridge { /** - * Constructs a new bridge for the <image> element. + * Constructs a new bridge for the <image> element. */ public AbstractFOPImageElementBridge() { } diff --git a/fop-core/src/main/java/org/apache/fop/svg/AbstractFOPTextElementBridge.java b/fop-core/src/main/java/org/apache/fop/svg/AbstractFOPTextElementBridge.java index 59db21d63..f031d950b 100644 --- a/fop-core/src/main/java/org/apache/fop/svg/AbstractFOPTextElementBridge.java +++ b/fop-core/src/main/java/org/apache/fop/svg/AbstractFOPTextElementBridge.java @@ -28,11 +28,11 @@ import org.apache.batik.bridge.TextPainter; import org.apache.batik.gvt.GraphicsNode; /** - *

    Bridge class for the <text> element. + * Bridge class for the <text> element. * This bridge will use the direct text painter if the text - * for the element is simple.

    + * for the element is simple. * - *

    This work was authored by Keiron Liddle (keiron@aftexsw.com).

    + * This work was originally authored by Keiron Liddle */ public abstract class AbstractFOPTextElementBridge extends SVGTextElementBridge { diff --git a/fop-core/src/main/java/org/apache/fop/svg/NativeTextPainter.java b/fop-core/src/main/java/org/apache/fop/svg/NativeTextPainter.java index e203e135f..e6a1b43dd 100644 --- a/fop-core/src/main/java/org/apache/fop/svg/NativeTextPainter.java +++ b/fop-core/src/main/java/org/apache/fop/svg/NativeTextPainter.java @@ -335,10 +335,6 @@ public abstract class NativeTextPainter extends StrokingTextPainter { protected abstract void writeGlyph(char glyph, AffineTransform transform) throws IOException; - /** - * @param runaci an attributed character iterator - * @param layout a text span layout - */ protected final void logTextRun(TextRun textRun) { AttributedCharacterIterator runaci = textRun.getACI(); TextSpanLayout layout = textRun.getLayout(); diff --git a/fop-core/src/main/java/org/apache/fop/svg/PDFAElementBridge.java b/fop-core/src/main/java/org/apache/fop/svg/PDFAElementBridge.java index c2a481af9..929811085 100644 --- a/fop-core/src/main/java/org/apache/fop/svg/PDFAElementBridge.java +++ b/fop-core/src/main/java/org/apache/fop/svg/PDFAElementBridge.java @@ -29,15 +29,15 @@ import org.apache.batik.bridge.BridgeContext; import org.apache.batik.gvt.GraphicsNode; /** - *

    Bridge class for the <a> element.

    + * Bridge class for the <a> element. * - *

    This work was authored by Keiron Liddle (keiron@aftexsw.com).

    + * This work was originally authored by Keiron Liddle */ public class PDFAElementBridge extends AbstractGraphicsNodeBridge { private AffineTransform transform; /** - * Constructs a new bridge for the <a> element. + * Constructs a new bridge for the <a> element. */ public PDFAElementBridge() { } @@ -87,7 +87,7 @@ public class PDFAElementBridge extends AbstractGraphicsNodeBridge { } /** - * Returns true as the <a> element is a container. + * Returns true as the <a> element is a container. * @return true if the a element is a container */ public boolean isComposite() { diff --git a/fop-core/src/main/java/org/apache/fop/svg/PDFImageElementBridge.java b/fop-core/src/main/java/org/apache/fop/svg/PDFImageElementBridge.java index 0cc14b7e3..59db4f9d3 100644 --- a/fop-core/src/main/java/org/apache/fop/svg/PDFImageElementBridge.java +++ b/fop-core/src/main/java/org/apache/fop/svg/PDFImageElementBridge.java @@ -24,14 +24,14 @@ import org.apache.xmlgraphics.image.loader.ImageFlavor; import org.apache.fop.image.loader.batik.BatikImageFlavors; /** - *

    PDF Image Element Bridge class for the <image> element when jpeg images.

    + * PDF Image Element Bridge class for the <image> element when jpeg images. * - *

    This work was authored by Keiron Liddle (keiron@aftexsw.com).

    + * This work was originally authored by Keiron Liddle */ public class PDFImageElementBridge extends AbstractFOPImageElementBridge { /** - * Constructs a new bridge for the <image> element. + * Constructs a new bridge for the <image> element. */ public PDFImageElementBridge() { } diff --git a/fop-core/src/main/java/org/apache/fop/svg/PDFTextElementBridge.java b/fop-core/src/main/java/org/apache/fop/svg/PDFTextElementBridge.java index e63b580f2..7cee4d92b 100644 --- a/fop-core/src/main/java/org/apache/fop/svg/PDFTextElementBridge.java +++ b/fop-core/src/main/java/org/apache/fop/svg/PDFTextElementBridge.java @@ -22,16 +22,16 @@ package org.apache.fop.svg; import org.apache.batik.bridge.TextPainter; /** - *

    Bridge class for the <text> element. + * Bridge class for the <text> element. * This bridge will use the direct text painter if the text - * for the element is simple.

    + * for the element is simple. * - *

    This work was authored by Keiron Liddle (keiron@aftexsw.com).

    + * This work was originally authored by Keiron Liddle */ public class PDFTextElementBridge extends AbstractFOPTextElementBridge { /** - * Constructs a new bridge for the <text> element. + * Constructs a new bridge for the <text> element. * * @param textPainter the text painter to use */ diff --git a/fop-core/src/main/java/org/apache/fop/svg/PDFTextPainter.java b/fop-core/src/main/java/org/apache/fop/svg/PDFTextPainter.java index 5c5308ace..3894f01e0 100644 --- a/fop-core/src/main/java/org/apache/fop/svg/PDFTextPainter.java +++ b/fop-core/src/main/java/org/apache/fop/svg/PDFTextPainter.java @@ -37,7 +37,7 @@ import org.apache.fop.svg.font.FOPGVTFont; import org.apache.fop.svg.font.FOPGVTGlyphVector; /** - * Renders the attributed character iterator of a {@link org.apache.batik.gvt.TextNode}. + * Renders the attributed character iterator of a {@link org.apache.batik.bridge.TextNode}. * This class draws the text directly into the PDFGraphics2D so that * the text is not drawn using shapes which makes the PDF files larger. * If the text is simple enough to draw then it sets the font and calls @@ -60,7 +60,6 @@ class PDFTextPainter extends NativeTextPainter { * Create a new PDF text painter with the given font information. * * @param fi the font info - * @param fontFamilyResolver the Font Family Resolver */ public PDFTextPainter(FontInfo fi) { super(fi); diff --git a/fop-core/src/main/java/org/apache/fop/svg/PDFTranscoder.java b/fop-core/src/main/java/org/apache/fop/svg/PDFTranscoder.java index f52b18437..1481f7028 100644 --- a/fop-core/src/main/java/org/apache/fop/svg/PDFTranscoder.java +++ b/fop-core/src/main/java/org/apache/fop/svg/PDFTranscoder.java @@ -59,7 +59,7 @@ import org.apache.fop.svg.font.FOPFontFamilyResolverImpl; * processor can be specified: * *

    KEY_LANGUAGE to set the default language to use (may be - * used by a <switch> SVG element for example), + * used by a <switch> SVG element for example), * KEY_USER_STYLESHEET_URI to fix the URI of a user * stylesheet, and KEY_PIXEL_TO_MM to specify the pixel to * millimeter conversion factor. diff --git a/fop-core/src/main/java/org/apache/fop/tools/anttasks/Fop.java b/fop-core/src/main/java/org/apache/fop/tools/anttasks/Fop.java index bb1bef24b..c4b9f281e 100644 --- a/fop-core/src/main/java/org/apache/fop/tools/anttasks/Fop.java +++ b/fop-core/src/main/java/org/apache/fop/tools/anttasks/Fop.java @@ -50,17 +50,19 @@ import org.apache.fop.cli.InputHandler; * Wrapper for FOP which allows it to be accessed from within an Ant task. * Accepts the inputs: *

      - *
    • fofile -> formatting objects file to be transformed
    • - *
    • format -> MIME type of the format to generate ex. "application/pdf"
    • - *
    • outfile -> output filename
    • - *
    • baseDir -> directory to work from
    • - *
    • relativebase -> (true | false) control whether to use each FO's + *
    • fofile - formatting objects file to be transformed
    • + *
    • iffile - intermediate format input file to be transformed
    • + *
    • outputFormat - MIME type of the format to generate ex. "application/pdf"
    • + *
    • inputFormat - Input file format (like "fo","xml","if")
    • + *
    • outfile - output filename
    • + *
    • baseDir - directory to work from
    • + *
    • relativebase - (true | false) control whether to use each FO's * directory as base directory. false uses the baseDir parameter.
    • - *
    • userconfig -> file with user configuration (same as the "-c" command + *
    • userconfig - file with user configuration (same as the "-c" command * line option)
    • - *
    • messagelevel -> (error | warn | info | verbose | debug) level to output + *
    • messagelevel - (error | warn | info | verbose | debug) level to output * non-error messages
    • - *
    • logFiles -> Controls whether the names of the files that are processed + *
    • logFiles - Controls whether the names of the files that are processed * are logged or not
    • *
    */ diff --git a/fop-core/src/main/java/org/apache/fop/traits/MinOptMax.java b/fop-core/src/main/java/org/apache/fop/traits/MinOptMax.java index 84fb0156a..a647ae327 100644 --- a/fop-core/src/main/java/org/apache/fop/traits/MinOptMax.java +++ b/fop-core/src/main/java/org/apache/fop/traits/MinOptMax.java @@ -23,14 +23,12 @@ import java.io.Serializable; /** * This class holds the resolved (as mpoints) form of a - * {@link org.apache.fop.fo.properties.LengthRangeProperty} or - * {@link org.apache.fop.fo.properties.SpaceProperty} type property value. - *

    - * Instances of this class are immutable. All arithmetic methods like {@link #plus(MinOptMax) plus}, - * {@link #minus(MinOptMax) minus} or {@link #mult(int) mult} return a different instance. So it is - * possible to pass around instances without copying. - *

    - * MinOptMax values are used during layout calculations. + * {@link org.apache.fop.fo.properties.LengthRangeProperty LengthRange} or + * {@link org.apache.fop.fo.properties.SpaceProperty Space} type property value.

    + * Instances of this class are immutable. All arithmetic methods like + * {@link #plus(MinOptMax) plus}, {@link #minus(MinOptMax) minus} or {@link #mult(int) + * mult} return a different instance. So it is possible to pass around instances without + * copying.

    MinOptMax values are used during layout calculations. */ public final class MinOptMax implements Serializable { @@ -52,7 +50,7 @@ public final class MinOptMax implements Serializable { * @param opt the optimum value * @param max the maximum value * @return the corresponding instance - * @throws IllegalArgumentException if min > opt || max < opt. + * @throws IllegalArgumentException if min > opt || max < opt. */ public static MinOptMax getInstance(int min, int opt, int max) throws IllegalArgumentException { if (min > opt) { @@ -196,7 +194,7 @@ public final class MinOptMax implements Serializable { * @param minOperand the minimal value to be added. * @return an instance with the given value added to the minimal value. * @throws IllegalArgumentException if - * min + minOperand > opt || max < opt. + * min + minOperand > opt || max < opt. */ public MinOptMax plusMin(int minOperand) throws IllegalArgumentException { return getInstance(min + minOperand, opt, max); @@ -209,7 +207,7 @@ public final class MinOptMax implements Serializable { * @param minOperand the minimal value to be subtracted. * @return an instance with the given value subtracted to the minimal value. * @throws IllegalArgumentException if - * min - minOperand > opt || max < opt. + * min - minOperand > opt || max < opt. */ public MinOptMax minusMin(int minOperand) throws IllegalArgumentException { return getInstance(min - minOperand, opt, max); @@ -222,7 +220,7 @@ public final class MinOptMax implements Serializable { * @param maxOperand the maximal value to be added. * @return an instance with the given value added to the maximal value. * @throws IllegalArgumentException if - * min > opt || max < opt + maxOperand. + * min > opt || max < opt + maxOperand. */ public MinOptMax plusMax(int maxOperand) throws IllegalArgumentException { return getInstance(min, opt, max + maxOperand); @@ -235,7 +233,7 @@ public final class MinOptMax implements Serializable { * @param maxOperand the maximal value to be subtracted. * @return an instance with the given value subtracted to the maximal value. * @throws IllegalArgumentException if - * min > opt || max < opt - maxOperand. + * min > opt || max < opt - maxOperand. */ public MinOptMax minusMax(int maxOperand) throws IllegalArgumentException { return getInstance(min, opt, max - maxOperand); diff --git a/fop-core/src/main/java/org/apache/fop/util/XMLUtil.java b/fop-core/src/main/java/org/apache/fop/util/XMLUtil.java index 87efed670..ebebef156 100644 --- a/fop-core/src/main/java/org/apache/fop/util/XMLUtil.java +++ b/fop-core/src/main/java/org/apache/fop/util/XMLUtil.java @@ -284,7 +284,7 @@ public final class XMLUtil implements XMLConstants { /** * Returns an attribute value as a glyph position adjustments array. The string value - * is expected to be a non-empty sequence of either Z or , where the + * is expected to be a non-empty sequence of either Z<repeat> or <number>, where the * former encodes a repeat count (of zeroes) and the latter encodes a integer number, * and where each item is separated by whitespace. * @param attributes the Attributes object @@ -301,7 +301,7 @@ public final class XMLUtil implements XMLConstants { } /** - * Escape '<', '>' and '&' using NCRs. + * Escape '<', '>' and '&' using NCRs. * @param unescaped string * @return escaped string */ diff --git a/fop-core/src/test/java/org/apache/fop/render/rtf/rtflib/testdocs/BasicLink.java b/fop-core/src/test/java/org/apache/fop/render/rtf/rtflib/testdocs/BasicLink.java index 9df1c26ef..01ba8a551 100644 --- a/fop-core/src/test/java/org/apache/fop/render/rtf/rtflib/testdocs/BasicLink.java +++ b/fop-core/src/test/java/org/apache/fop/render/rtf/rtflib/testdocs/BasicLink.java @@ -20,7 +20,7 @@ /* * This file is part of the RTF library of the FOP project, which was originally - * created by Bertrand Delacretaz and by other + * created by Bertrand Delacretaz bdelacretaz@codeconsult.ch and by other * contributors to the jfor project (www.jfor.org), who agreed to donate jfor to * the FOP project. */ diff --git a/fop-core/src/test/java/org/apache/fop/render/rtf/rtflib/testdocs/CreateTestDocuments.java b/fop-core/src/test/java/org/apache/fop/render/rtf/rtflib/testdocs/CreateTestDocuments.java index 797aa1b79..a6ea16cf0 100644 --- a/fop-core/src/test/java/org/apache/fop/render/rtf/rtflib/testdocs/CreateTestDocuments.java +++ b/fop-core/src/test/java/org/apache/fop/render/rtf/rtflib/testdocs/CreateTestDocuments.java @@ -20,7 +20,7 @@ /* * This file is part of the RTF library of the FOP project, which was originally - * created by Bertrand Delacretaz and by other + * created by Bertrand Delacretaz bdelacretaz@codeconsult.ch and by other * contributors to the jfor project (www.jfor.org), who agreed to donate jfor to * the FOP project. */ diff --git a/fop-core/src/test/java/org/apache/fop/render/rtf/rtflib/testdocs/DummyTableColumnsInfo.java b/fop-core/src/test/java/org/apache/fop/render/rtf/rtflib/testdocs/DummyTableColumnsInfo.java index 1af4c7bed..151dc1695 100644 --- a/fop-core/src/test/java/org/apache/fop/render/rtf/rtflib/testdocs/DummyTableColumnsInfo.java +++ b/fop-core/src/test/java/org/apache/fop/render/rtf/rtflib/testdocs/DummyTableColumnsInfo.java @@ -20,7 +20,7 @@ /* * This file is part of the RTF library of the FOP project, which was originally - * created by Bertrand Delacretaz and by other + * created by Bertrand Delacretaz bdelacretaz@codeconsult.ch and by other * contributors to the jfor project (www.jfor.org), who agreed to donate jfor to * the FOP project. */ diff --git a/fop-core/src/test/java/org/apache/fop/render/rtf/rtflib/testdocs/ExternalGraphic.java b/fop-core/src/test/java/org/apache/fop/render/rtf/rtflib/testdocs/ExternalGraphic.java index 1127f3e72..6b31f551b 100644 --- a/fop-core/src/test/java/org/apache/fop/render/rtf/rtflib/testdocs/ExternalGraphic.java +++ b/fop-core/src/test/java/org/apache/fop/render/rtf/rtflib/testdocs/ExternalGraphic.java @@ -20,7 +20,7 @@ /* * This file is part of the RTF library of the FOP project, which was originally - * created by Bertrand Delacretaz and by other + * created by Bertrand Delacretaz bdelacretaz@codeconsult.ch and by other * contributors to the jfor project (www.jfor.org), who agreed to donate jfor to * the FOP project. */ diff --git a/fop-core/src/test/java/org/apache/fop/render/rtf/rtflib/testdocs/ListInTable.java b/fop-core/src/test/java/org/apache/fop/render/rtf/rtflib/testdocs/ListInTable.java index 6f4e27a59..53233e773 100644 --- a/fop-core/src/test/java/org/apache/fop/render/rtf/rtflib/testdocs/ListInTable.java +++ b/fop-core/src/test/java/org/apache/fop/render/rtf/rtflib/testdocs/ListInTable.java @@ -20,7 +20,7 @@ /* * This file is part of the RTF library of the FOP project, which was originally - * created by Bertrand Delacretaz and by other + * created by Bertrand Delacretaz bdelacretaz@codeconsult.ch and by other * contributors to the jfor project (www.jfor.org), who agreed to donate jfor to * the FOP project. */ diff --git a/fop-core/src/test/java/org/apache/fop/render/rtf/rtflib/testdocs/MergedTableCells.java b/fop-core/src/test/java/org/apache/fop/render/rtf/rtflib/testdocs/MergedTableCells.java index 9be5e899a..fe00e44c4 100644 --- a/fop-core/src/test/java/org/apache/fop/render/rtf/rtflib/testdocs/MergedTableCells.java +++ b/fop-core/src/test/java/org/apache/fop/render/rtf/rtflib/testdocs/MergedTableCells.java @@ -20,7 +20,7 @@ /* * This file is part of the RTF library of the FOP project, which was originally - * created by Bertrand Delacretaz and by other + * created by Bertrand Delacretaz bdelacretaz@codeconsult.ch and by other * contributors to the jfor project (www.jfor.org), who agreed to donate jfor to * the FOP project. */ diff --git a/fop-core/src/test/java/org/apache/fop/render/rtf/rtflib/testdocs/NestedTable.java b/fop-core/src/test/java/org/apache/fop/render/rtf/rtflib/testdocs/NestedTable.java index c11fbc334..60370aa2d 100644 --- a/fop-core/src/test/java/org/apache/fop/render/rtf/rtflib/testdocs/NestedTable.java +++ b/fop-core/src/test/java/org/apache/fop/render/rtf/rtflib/testdocs/NestedTable.java @@ -20,7 +20,7 @@ /* * This file is part of the RTF library of the FOP project, which was originally - * created by Bertrand Delacretaz and by other + * created by Bertrand Delacretaz bdelacretaz@codeconsult.ch and by other * contributors to the jfor project (www.jfor.org), who agreed to donate jfor to * the FOP project. */ diff --git a/fop-core/src/test/java/org/apache/fop/render/rtf/rtflib/testdocs/ParagraphAlignment.java b/fop-core/src/test/java/org/apache/fop/render/rtf/rtflib/testdocs/ParagraphAlignment.java index edce3264a..2de087d91 100644 --- a/fop-core/src/test/java/org/apache/fop/render/rtf/rtflib/testdocs/ParagraphAlignment.java +++ b/fop-core/src/test/java/org/apache/fop/render/rtf/rtflib/testdocs/ParagraphAlignment.java @@ -20,7 +20,7 @@ /* * This file is part of the RTF library of the FOP project, which was originally - * created by Bertrand Delacretaz and by other + * created by Bertrand Delacretaz bdelacretaz@codeconsult.ch and by other * contributors to the jfor project (www.jfor.org), who agreed to donate jfor to * the FOP project. */ diff --git a/fop-core/src/test/java/org/apache/fop/render/rtf/rtflib/testdocs/SimpleDocument.java b/fop-core/src/test/java/org/apache/fop/render/rtf/rtflib/testdocs/SimpleDocument.java index ca6ce79bc..14ec754a6 100644 --- a/fop-core/src/test/java/org/apache/fop/render/rtf/rtflib/testdocs/SimpleDocument.java +++ b/fop-core/src/test/java/org/apache/fop/render/rtf/rtflib/testdocs/SimpleDocument.java @@ -20,7 +20,7 @@ /* * This file is part of the RTF library of the FOP project, which was originally - * created by Bertrand Delacretaz and by other + * created by Bertrand Delacretaz bdelacretaz@codeconsult.ch and by other * contributors to the jfor project (www.jfor.org), who agreed to donate jfor to * the FOP project. */ diff --git a/fop-core/src/test/java/org/apache/fop/render/rtf/rtflib/testdocs/SimpleLists.java b/fop-core/src/test/java/org/apache/fop/render/rtf/rtflib/testdocs/SimpleLists.java index e817f6a13..64161c181 100644 --- a/fop-core/src/test/java/org/apache/fop/render/rtf/rtflib/testdocs/SimpleLists.java +++ b/fop-core/src/test/java/org/apache/fop/render/rtf/rtflib/testdocs/SimpleLists.java @@ -20,7 +20,7 @@ /* * This file is part of the RTF library of the FOP project, which was originally - * created by Bertrand Delacretaz and by other + * created by Bertrand Delacretaz bdelacretaz@codeconsult.ch and by other * contributors to the jfor project (www.jfor.org), who agreed to donate jfor to * the FOP project. */ diff --git a/fop-core/src/test/java/org/apache/fop/render/rtf/rtflib/testdocs/SimpleTable.java b/fop-core/src/test/java/org/apache/fop/render/rtf/rtflib/testdocs/SimpleTable.java index 10ddc11e7..a83a6d344 100644 --- a/fop-core/src/test/java/org/apache/fop/render/rtf/rtflib/testdocs/SimpleTable.java +++ b/fop-core/src/test/java/org/apache/fop/render/rtf/rtflib/testdocs/SimpleTable.java @@ -20,7 +20,7 @@ /* * This file is part of the RTF library of the FOP project, which was originally - * created by Bertrand Delacretaz and by other + * created by Bertrand Delacretaz bdelacretaz@codeconsult.ch and by other * contributors to the jfor project (www.jfor.org), who agreed to donate jfor to * the FOP project. */ diff --git a/fop-core/src/test/java/org/apache/fop/render/rtf/rtflib/testdocs/TestDocument.java b/fop-core/src/test/java/org/apache/fop/render/rtf/rtflib/testdocs/TestDocument.java index 266903766..e606a49d8 100644 --- a/fop-core/src/test/java/org/apache/fop/render/rtf/rtflib/testdocs/TestDocument.java +++ b/fop-core/src/test/java/org/apache/fop/render/rtf/rtflib/testdocs/TestDocument.java @@ -20,7 +20,7 @@ /* * This file is part of the RTF library of the FOP project, which was originally - * created by Bertrand Delacretaz and by other + * created by Bertrand Delacretaz bdelacretaz@codeconsult.ch and by other * contributors to the jfor project (www.jfor.org), who agreed to donate jfor to * the FOP project. */ diff --git a/fop-core/src/test/java/org/apache/fop/render/rtf/rtflib/testdocs/TextAttributes.java b/fop-core/src/test/java/org/apache/fop/render/rtf/rtflib/testdocs/TextAttributes.java index bb0614cee..ff198fe50 100644 --- a/fop-core/src/test/java/org/apache/fop/render/rtf/rtflib/testdocs/TextAttributes.java +++ b/fop-core/src/test/java/org/apache/fop/render/rtf/rtflib/testdocs/TextAttributes.java @@ -20,7 +20,7 @@ /* * This file is part of the RTF library of the FOP project, which was originally - * created by Bertrand Delacretaz and by other + * created by Bertrand Delacretaz bdelacretaz@codeconsult.ch and by other * contributors to the jfor project (www.jfor.org), who agreed to donate jfor to * the FOP project. */ diff --git a/fop-core/src/test/java/org/apache/fop/render/rtf/rtflib/testdocs/Whitespace.java b/fop-core/src/test/java/org/apache/fop/render/rtf/rtflib/testdocs/Whitespace.java index a206e014f..4889fd827 100644 --- a/fop-core/src/test/java/org/apache/fop/render/rtf/rtflib/testdocs/Whitespace.java +++ b/fop-core/src/test/java/org/apache/fop/render/rtf/rtflib/testdocs/Whitespace.java @@ -20,7 +20,7 @@ /* * This file is part of the RTF library of the FOP project, which was originally - * created by Bertrand Delacretaz and by other + * created by Bertrand Delacretaz bdelacretaz@codeconsult.ch and by other * contributors to the jfor project (www.jfor.org), who agreed to donate jfor to * the FOP project. */ diff --git a/fop-events/src/main/java/org/apache/fop/events/EventProducer.java b/fop-events/src/main/java/org/apache/fop/events/EventProducer.java index 88da771a4..00c956a61 100644 --- a/fop-events/src/main/java/org/apache/fop/events/EventProducer.java +++ b/fop-events/src/main/java/org/apache/fop/events/EventProducer.java @@ -22,9 +22,8 @@ package org.apache.fop.events; /** * This is a marker interface which all event producer interfaces need to extend. These interfaces * must agree to the following convention: - *

      - *
    • The first parameter of each method must be: Object source - *
    + * + * The first parameter of each method must be: Object source */ public interface EventProducer {