</module>
<!-- ===================================================================================================== -->
+ <!-- ===================================================================================================== -->
+ <module name="RegexpSingleline">
+ <property name="format" value="@author"/>
+ <property name="message" value="Use of @author javadoc keyword is prohibited."/>
+ </module>
+ <!-- ===================================================================================================== -->
+
<!-- ===================================================================================================== -->
<module name="SuppressionCommentFilter">
<property name="offCommentFormat" value="CSOFF\: ([\w\|]+)"/>
*
* <p>This code is derived in part from GenerateLineBreakUtils.java.</p>
*
- * @author Glenn Adams
+ * <p>This work was originally authored by Glenn Adams (gadams@apache.org).</p>
*/
public final class GenerateBidiClass {
*
* <p>This code is derived in part from GenerateBidiClassUtils.java.</p>
*
- * @author Glenn Adams
+ * <p>This work was originally authored by Glenn Adams (gadams@apache.org).</p>
*/
public final class GenerateBidiTestData {
* The entity resolver only handles queries for the DTD. It will find any URI
* with a recognised public id and return an {@link org.xml.sax.InputSource}.
* <p>
- * @author <a href="mailto:joe@exubero.com">Joe Schmetzer</a>
+ *
+ * <p>This work was authored by Joe Schmetzer (joe@exubero.com).</p>
*/
public class DTDEntityResolver implements EntityResolver {
/**
- * Constants used for bidirectional processing.
- * @author Glenn Adams
+ * <p>Constants used for bidirectional processing.</p>
+ *
+ * <p>This work was originally authored by Glenn Adams (gadams@apache.org).</p>
*/
public interface BidiConstants {
/**
* <p>A utility class for performing bidirectional resolution processing.</p>
*
- * @author Glenn Adams
+ * <p>This work was originally authored by Glenn Adams (gadams@apache.org).</p>
*/
public final class BidiResolver {
* by XML-FO 1.1 §5.8, which contains a flattened sequence of characters. Any FO that generates
* block areas serves as a delimiter.
*
- * @author Glenn Adams
+ * <p>This work was originally authored by Glenn Adams (gadams@apache.org).</p>
*/
public class DelimitedTextRange {
private FONode fn; // node that generates this text range
* The <code>InlineRun</code> class is a utility class, the instances of which are used
* to capture a sequence of reordering levels associated with an inline area.
*
- * @author Glenn Adams
+ * <p>This work was originally authored by Glenn Adams (gadams@apache.org).</p>
*/
public class InlineRun {
private InlineArea inline;
// CSOFF: SimplifyBooleanReturnCheck
/**
- * The <code>TextInterval</code> class is a utility class, the instances of which are used
- * to record backpointers to associated nodes over sub-intervals of a delimited text range.
+ * <p>The <code>TextInterval</code> class is a utility class, the instances of which are used
+ * to record backpointers to associated nodes over sub-intervals of a delimited text range.</p>
*
- * @author Glenn Adams
+ * <p>This work was originally authored by Glenn Adams (gadams@apache.org).</p>
*/
class TextInterval {
private FONode fn; // associated node
// CSOFF: SimplifyBooleanReturnCheck
/**
- * The <code>UnflattenProcessor</code> class is used to reconstruct (by unflattening) a line
- * area's internal area hierarachy after leaf inline area reordering is completed.
+ * <p>The <code>UnflattenProcessor</code> class is used to reconstruct (by unflattening) a line
+ * area's internal area hierarachy after leaf inline area reordering is completed.</p>
*
- * @author Glenn Adams
+ * <p>This work was originally authored by Glenn Adams (gadams@apache.org).</p>
*/
class UnflattenProcessor {
private List<InlineArea> il; // list of flattened inline areas being unflattened
// CSOFF: ParameterNumberCheck
/**
- * The <code>UnicodeBidiAlgorithm</code> class implements functionality prescribed by
- * the Unicode Bidirectional Algorithm, Unicode Standard Annex #9.
+ * <p>The <code>UnicodeBidiAlgorithm</code> class implements functionality prescribed by
+ * the Unicode Bidirectional Algorithm, Unicode Standard Annex #9.</p>
*
- * @author Glenn Adams
+ * <p>This work was originally authored by Glenn Adams (gadams@apache.org).</p>
*/
public final class UnicodeBidiAlgorithm implements BidiConstants {
package org.apache.fop.complexscripts.fonts;
/**
- * Exception thrown when attempting to decode a truetype font file and a format
- * constraint is violated.
- * @author Glenn Adams
+ * <p>Exception thrown when attempting to decode a truetype font file and a format
+ * constraint is violated.</p>
+ *
+ * <p>This work was originally authored by Glenn Adams (gadams@apache.org).</p>
*/
public class AdvancedTypographicTableFormatException extends RuntimeException {
/**
// CSOFF: LineLengthCheck
/**
- * The <code>GlyphClassMapping</code> interface provides glyph identifier to class
- * index mapping support.
- * @author Glenn Adams
+ * <p>The <code>GlyphClassMapping</code> interface provides glyph identifier to class
+ * index mapping support.</p>
+ *
+ * <p>This work was originally authored by Glenn Adams (gadams@apache.org).</p>
*/
public interface GlyphClassMapping {
// CSOFF: NoWhitespaceAfterCheck
/**
- * Base class implementation of glyph class table.
- * @author Glenn Adams
+ * <p>Base class implementation of glyph class table.</p>
+ *
+ * <p>This work was originally authored by Glenn Adams (gadams@apache.org).</p>
*/
public final class GlyphClassTable extends GlyphMappingTable implements GlyphClassMapping {
// CSOFF: LineLengthCheck
/**
- * The <code>GlyphCoverageMapping</code> interface provides glyph identifier to coverage
- * index mapping support.
- * @author Glenn Adams
+ * <p>The <code>GlyphCoverageMapping</code> interface provides glyph identifier to coverage
+ * index mapping support.</p>
+ *
+ * <p>This work was originally authored by Glenn Adams (gadams@apache.org).</p>
*/
public interface GlyphCoverageMapping {
// CSOFF: NoWhitespaceAfterCheck
/**
- * Base class implementation of glyph coverage table.
- * @author Glenn Adams
+ * <p>.Base class implementation of glyph coverage table.</p>
+ *
+ * <p>This work was originally authored by Glenn Adams (gadams@apache.org).</p>
*/
public final class GlyphCoverageTable extends GlyphMappingTable implements GlyphCoverageMapping {
// CSOFF: LineLengthCheck
/**
- * The <code>GlyphDefinition</code> interface is a marker interface implemented by a glyph definition
- * subtable.
- * @author Glenn Adams
+ * <p>The <code>GlyphDefinition</code> interface is a marker interface implemented by a glyph definition
+ * subtable.</p>
+ *
+ * <p>This work was originally authored by Glenn Adams (gadams@apache.org).</p>
*/
public interface GlyphDefinition {
// CSOFF: InnerAssignmentCheck
/**
- * The <code>GlyphDefinitionSubtable</code> implements an abstract base of a glyph definition subtable,
- * providing a default implementation of the <code>GlyphDefinition</code> interface.
- * @author Glenn Adams
+ * <p>The <code>GlyphDefinitionSubtable</code> implements an abstract base of a glyph definition subtable,
+ * providing a default implementation of the <code>GlyphDefinition</code> interface.</p>
+ *
+ * <p>This work was originally authored by Glenn Adams (gadams@apache.org).</p>
*/
public abstract class GlyphDefinitionSubtable extends GlyphSubtable implements GlyphDefinition {
// CSOFF: LineLengthCheck
/**
- * The <code>GlyphDefinitionTable</code> class is a glyph table that implements
- * glyph definition functionality according to the OpenType GDEF table.
- * @author Glenn Adams
+ * <p>The <code>GlyphDefinitionTable</code> class is a glyph table that implements
+ * glyph definition functionality according to the OpenType GDEF table.</p>
+ *
+ * <p>This work was originally authored by Glenn Adams (gadams@apache.org).</p>
*/
public class GlyphDefinitionTable extends GlyphTable {
// CSOFF: LineLengthCheck
/**
- * Base class implementation of glyph mapping table. This base
+ * <p>Base class implementation of glyph mapping table. This base
* class maps glyph indices to arbitrary integers (mappping indices), and
- * is used to implement both glyph coverage and glyph class maps.
- * @author Glenn Adams
+ * is used to implement both glyph coverage and glyph class maps.</p>
+ *
+ * <p>This work was originally authored by Glenn Adams (gadams@apache.org).</p>
*/
public class GlyphMappingTable {
// CSOFF: LineLengthCheck
/**
- * The <code>GlyphPositioning</code> interface is implemented by a glyph positioning subtable
+ * <p>The <code>GlyphPositioning</code> interface is implemented by a glyph positioning subtable
* that supports the determination of glyph positioning information based on script and
- * language of the corresponding character content.
- * @author Glenn Adams
+ * language of the corresponding character content.</p>
+ *
+ * <p>This work was originally authored by Glenn Adams (gadams@apache.org).</p>
*/
public interface GlyphPositioning {
// CSOFF: ParameterNumberCheck
/**
- * The <code>GlyphPositioningState</code> implements an state object used during glyph positioning
- * processing.
- * @author Glenn Adams
+ * <p>The <code>GlyphPositioningState</code> implements an state object used during glyph positioning
+ * processing.</p>
+ *
+ * <p>This work was originally authored by Glenn Adams (gadams@apache.org).</p>
*/
public class GlyphPositioningState extends GlyphProcessingState {
// CSOFF: ParameterNumberCheck
/**
- * The <code>GlyphPositioningSubtable</code> implements an abstract base of a glyph subtable,
- * providing a default implementation of the <code>GlyphPositioning</code> interface.
- * @author Glenn Adams
+ * <p>The <code>GlyphPositioningSubtable</code> implements an abstract base of a glyph subtable,
+ * providing a default implementation of the <code>GlyphPositioning</code> interface.</p>
+ *
+ * <p>This work was originally authored by Glenn Adams (gadams@apache.org).</p>
*/
public abstract class GlyphPositioningSubtable extends GlyphSubtable implements GlyphPositioning {
// CSOFF: ParameterNumberCheck
/**
- * The <code>GlyphPositioningTable</code> class is a glyph table that implements
- * <code>GlyphPositioning</code> functionality.
- * @author Glenn Adams
+ * <p>The <code>GlyphPositioningTable</code> class is a glyph table that implements
+ * <code>GlyphPositioning</code> functionality.</p>
+ *
+ * <p>This work was originally authored by Glenn Adams (gadams@apache.org).</p>
*/
public class GlyphPositioningTable extends GlyphTable {
// CSOFF: NoWhitespaceAfterCheck
/**
- * The <code>GlyphProcessingState</code> implements a common, base state object used during glyph substitution
- * and positioning processing.
- * @author Glenn Adams
+ * <p>The <code>GlyphProcessingState</code> implements a common, base state object used during glyph substitution
+ * and positioning processing.</p>
+ *
+ * <p>This work was originally authored by Glenn Adams (gadams@apache.org).</p>
*/
public class GlyphProcessingState {
// CSOFF: LineLengthCheck
/**
- * The <code>GlyphSubstitution</code> interface is implemented by a glyph substitution subtable
+ * <p>The <code>GlyphSubstitution</code> interface is implemented by a glyph substitution subtable
* that supports the determination of glyph substitution information based on script and
- * language of the corresponding character content.
- * @author Glenn Adams
+ * language of the corresponding character content.</p>
+ *
+ * <p>This work was originally authored by Glenn Adams (gadams@apache.org).</p>
*/
public interface GlyphSubstitution {
// CSOFF: NoWhitespaceAfterCheck
/**
- * The <code>GlyphSubstitutionState</code> implements an state object used during glyph substitution
- * processing.
- * @author Glenn Adams
+ * <p>The <code>GlyphSubstitutionState</code> implements an state object used during glyph substitution
+ * processing.</p>
+ *
+ * <p>This work was originally authored by Glenn Adams (gadams@apache.org).</p>
*/
public class GlyphSubstitutionState extends GlyphProcessingState {
// CSOFF: NoWhitespaceAfterCheck
/**
- * The <code>GlyphSubstitutionSubtable</code> implements an abstract base of a glyph substitution subtable,
- * providing a default implementation of the <code>GlyphSubstitution</code> interface.
- * @author Glenn Adams
+ * <p>The <code>GlyphSubstitutionSubtable</code> implements an abstract base of a glyph substitution subtable,
+ * providing a default implementation of the <code>GlyphSubstitution</code> interface.</p>
+ *
+ * <p>This work was originally authored by Glenn Adams (gadams@apache.org).</p>
*/
public abstract class GlyphSubstitutionSubtable extends GlyphSubtable implements GlyphSubstitution {
// CSOFF: NoWhitespaceAfterCheck
/**
- * The <code>GlyphSubstitutionTable</code> class is a glyph table that implements
- * <code>GlyphSubstitution</code> functionality.
- * @author Glenn Adams
+ * <p>The <code>GlyphSubstitutionTable</code> class is a glyph table that implements
+ * <code>GlyphSubstitution</code> functionality.</p>
+ *
+ * <p>This work was originally authored by Glenn Adams (gadams@apache.org).</p>
*/
public class GlyphSubstitutionTable extends GlyphTable {
// CSOFF: LineLengthCheck
/**
- * The <code>GlyphSubtable</code> implements an abstract glyph subtable that
- * encapsulates identification, type, format, and coverage information.
- * @author Glenn Adams
+ * <p>The <code>GlyphSubtable</code> implements an abstract glyph subtable that
+ * encapsulates identification, type, format, and coverage information.</p>
+ *
+ * <p>This work was originally authored by Glenn Adams (gadams@apache.org).</p>
*/
public abstract class GlyphSubtable implements Comparable {
// CSOFF: SimplifyBooleanReturnCheck
/**
- * Base class for all advanced typographic glyph tables.
- * @author Glenn Adams
+ * <p>Base class for all advanced typographic glyph tables.</p>
+ *
+ * <p>This work was originally authored by Glenn Adams (gadams@apache.org).</p>
*/
public class GlyphTable {
package org.apache.fop.complexscripts.fonts;
/**
- * Exception thrown during when attempting to map glyphs to associated characters
- * in the case that the associated characters do not represent a compact interval.
- * @author Glenn Adams
+ * <p>Exception thrown during when attempting to map glyphs to associated characters
+ * in the case that the associated characters do not represent a compact interval.</p>
+ *
+ * <p>This work was originally authored by Glenn Adams (gadams@apache.org).</p>
*/
public class IncompatibleSubtableException extends RuntimeException {
/**
// CSOFF: LineLengthCheck
/**
- * OpenType Font (OTF) advanced typographic table reader. Used by @{Link org.apache.fop.fonts.truetype.TTFFile}
- * to read advanced typographic tables (GDEF, GSUB, GPOS).
+ * <p>OpenType Font (OTF) advanced typographic table reader. Used by @{Link org.apache.fop.fonts.truetype.TTFFile}
+ * to read advanced typographic tables (GDEF, GSUB, GPOS).</p>
*
- * @author Glenn Adams
+ * <p>This work was originally authored by Glenn Adams (gadams@apache.org).</p>
*/
public final class OTFAdvancedTypographicTableReader {
// CSOFF: LineLengthCheck
/**
- * Optional interface which indicates that glyph positioning is supported and, if supported,
- * can perform positioning.
- * @author Glenn Adams
+ * <p>Optional interface which indicates that glyph positioning is supported and, if supported,
+ * can perform positioning.</p>
+ *
+ * <p>This work was originally authored by Glenn Adams (gadams@apache.org).</p>
*/
public interface Positionable {
// CSOFF: LineLengthCheck
/**
- * Optional interface which indicates that glyph substitution is supported and, if supported,
- * can perform substitution.
- * @author Glenn Adams
+ * <p>Optional interface which indicates that glyph substitution is supported and, if supported,
+ * can perform substitution.</p>
+ *
+ * <p>This work was originally authored by Glenn Adams (gadams@apache.org).</p>
*/
public interface Substitutable {
/**
* <p>The <code>ArabicScriptProcessor</code> class implements a script processor for
* performing glyph substitution and positioning operations on content associated with the Arabic script.</p>
- * @author Glenn Adams
+ *
+ * <p>This work was originally authored by Glenn Adams (gadams@apache.org).</p>
*/
public class ArabicScriptProcessor extends DefaultScriptProcessor {
// CSOFF: LineLengthCheck
/**
- * Default script processor, which enables default glyph composition/decomposition, common ligatures, localized forms
- * and kerning.
+ * <p>Default script processor, which enables default glyph composition/decomposition, common ligatures, localized forms
+ * and kerning.</p>
*
- * @author Glenn Adams
+ * <p>This work was originally authored by Glenn Adams (gadams@apache.org).</p>
*/
public class DefaultScriptProcessor extends ScriptProcessor {
/**
* <p>The <code>DevanagariScriptProcessor</code> class implements a script processor for
* performing glyph substitution and positioning operations on content associated with the Devanagari script.</p>
- * @author Glenn Adams
+ *
+ * <p>This work was originally authored by Glenn Adams (gadams@apache.org).</p>
*/
public class DevanagariScriptProcessor extends IndicScriptProcessor {
/**
* <p>The <code>GujaratiScriptProcessor</code> class implements a script processor for
* performing glyph substitution and positioning operations on content associated with the Gujarati script.</p>
- * @author Glenn Adams
+ *
+ * <p>This work was originally authored by Glenn Adams (gadams@apache.org).</p>
*/
public class GujaratiScriptProcessor extends IndicScriptProcessor {
/**
* <p>The <code>GurmukhiScriptProcessor</code> class implements a script processor for
* performing glyph substitution and positioning operations on content associated with the Gurmukhi script.</p>
- * @author Glenn Adams
+ *
+ * <p>This work was originally authored by Glenn Adams (gadams@apache.org).</p>
*/
public class GurmukhiScriptProcessor extends IndicScriptProcessor {
/**
* <p>The <code>IndicScriptProcessor</code> class implements a script processor for
* performing glyph substitution and positioning operations on content associated with the Indic script.</p>
- * @author Glenn Adams
+ *
+ * <p>This work was originally authored by Glenn Adams (gadams@apache.org).</p>
*/
public class IndicScriptProcessor extends DefaultScriptProcessor {
// CSOFF: ParameterNumberCheck
/**
- * Abstract script processor base class for which an implementation of the substitution and positioning methods
- * must be supplied.
- * @author Glenn Adams
+ * <p>Abstract script processor base class for which an implementation of the substitution and positioning methods
+ * must be supplied.</p>
+ *
+ * <p>This work was originally authored by Glenn Adams (gadams@apache.org).</p>
*/
public abstract class ScriptProcessor {
import java.util.Arrays;
/**
- * Mirror related utilities.
- * @author Glenn Adams
+ * <p>Mirror related utilities.</p>
+ *
+ * <p>This work was originally authored by Glenn Adams (gadams@apache.org).</p>
*/
public final class CharMirror {
// CSOFF: WhitespaceAfterCheck
/**
- * Script related utilities.
- * @author Glenn Adams
+ * <p>Script related utilities.</p>
+ *
+ * <p>This work was originally authored by Glenn Adams (gadams@apache.org).</p>
*/
public final class CharScript {
package org.apache.fop.complexscripts.util;
/**
- * Exception thrown during when attempting to map glyphs to associated characters
- * in the case that the associated characters do not represent a compact interval.
- * @author Glenn Adams
+ * <p>Exception thrown during when attempting to map glyphs to associated characters
+ * in the case that the associated characters do not represent a compact interval.</p>
+ *
+ * <p>This work was originally authored by Glenn Adams (gadams@apache.org).</p>
*/
public class DiscontinuousAssociationException extends RuntimeException {
/**
// CSOFF: LineLengthCheck
/**
- * Interface for testing the originating (source) character context of a glyph sequence.
- * @author Glenn Adams
+ * <p>Interface for testing the originating (source) character context of a glyph sequence.</p>
+ *
+ * <p>This work was originally authored by Glenn Adams (gadams@apache.org).</p>
*/
public interface GlyphContextTester {
// CSOFF: NoWhitespaceAfterCheck
/**
- * A GlyphSequence encapsulates a sequence of character codes, a sequence of glyph codes,
+ * <p>A GlyphSequence encapsulates a sequence of character codes, a sequence of glyph codes,
* and a sequence of character associations, where, for each glyph in the sequence of glyph
* codes, there is a corresponding character association. Character associations server to
* relate the glyph codes in a glyph sequence to the specific characters in an original
- * character code sequence with which the glyph codes are associated.
- * @author Glenn Adams
+ * character code sequence with which the glyph codes are associated.</p>
+ *
+ * <p>This work was originally authored by Glenn Adams (gadams@apache.org).</p>
*/
public class GlyphSequence implements Cloneable {
package org.apache.fop.complexscripts.util;
/**
- * Interface for testing glyph properties according to glyph identifier.
- * @author Glenn Adams
+ * <p>Interface for testing glyph properties according to glyph identifier.</p>
+ *
+ * <p>This work was originally authored by Glenn Adams (gadams@apache.org).</p>
*/
public interface GlyphTester {
// CSOFF: AvoidNestedBlocksCheck
/**
- * Implementation of Number to String Conversion algorithm specified by
- * XSL Transformations (XSLT) Version 2.0, W3C Recommendation, 23 January 2007.
+ * <p>Implementation of Number to String Conversion algorithm specified by
+ * XSL Transformations (XSLT) Version 2.0, W3C Recommendation, 23 January 2007.</p>
*
- * This algorithm differs from that specified in XSLT 1.0 in the following
- * ways:
+ * <p>This algorithm differs from that specified in XSLT 1.0 in the following
+ * ways:</p>
* <ul>
* <li>input numbers are greater than or equal to zero rather than greater than zero;</li>
* <li>introduces format tokens { w, W, Ww };</li>
* <li>introduces ordinal parameter to generate ordinal numbers;</li>
* </ul>
*
- * Implementation Defaults and Limitations
+ * <p>Implementation Defaults and Limitations</p>
* <ul>
* <li>If language parameter is unspecified (null or empty string), then the value
* of DEFAULT_LANGUAGE is used, which is defined below as "eng" (English).</li>
* <li>Ordinal word numerals are supported for French and Spanish only when less than or equal to ten (10).</li>
* </ul>
*
- * Implementation Notes
+ * <p>Implementation Notes</p>
* <ul>
* <li>In order to handle format tokens outside the Unicode BMP, all processing is
* done in Unicode Scalar Values represented with Integer and Integer[]
* selects female ordinals.</li>
* </ul>
*
- * @author Glenn Adams
+ * <p>This work was originally authored by Glenn Adams (gadams@apache.org).</p>
*/
public class NumberConverter {
package org.apache.fop.complexscripts.util;
/**
- * Interface for providing script specific context testers.
- * @author Glenn Adams
+ * <p>Interface for providing script specific context testers.</p>
+ *
+ * <p>This work was originally authored by Glenn Adams (gadams@apache.org).</p>
*/
public interface ScriptContextTester {
// CSOFF: InnerAssignmentCheck
/**
- * UTF32 related utilities.
- * @author Glenn Adams
+ * <p>UTF32 related utilities.</p>
+ *
+ * <p>This work was originally authored by Glenn Adams (gadams@apache.org).</p>
*/
public final class UTF32 {
// CSOFF: LineLengthCheck
/**
- * This class uses the 'format', 'groupingSeparator', 'groupingSize',
+ * <p>This class uses the 'format', 'groupingSeparator', 'groupingSize',
* and 'letterValue' properties on fo:page-sequence to return a String
- * corresponding to the supplied integer page number.
+ * corresponding to the supplied integer page number.</p>
*
- * In addition, (now) uses 'language' parameter and new 'fox:page-number-features'
- * parameter to express applicable language and number conversion features.
+ * <p>In addition, (now) uses 'language' parameter and new 'fox:page-number-features'
+ * parameter to express applicable language and number conversion features.</p>
*
- * @author Glenn Adams (rewrite to use new NumberConverter utility)
+ * <p>This work was authored by Glenn Adams (gadams@apache.org), based on a
+ * rewrite of prior work to use the new <code>NumberConverter</code> utility class.</p>
* @see NumberConverter
*/
public class PageNumberGenerator {
import org.apache.fop.fo.expr.PropertyException;
/**
- * @author me
- *
- * To change the template for this generated type comment go to
- * Window - Preferences - Java - Code Generation - Code and Comments
+ * <p>Dimensioned property maker.</p>
*/
public class DimensionPropertyMaker extends CorrespondingPropertyMaker {
import java.io.Serializable;
/**
- * This class implements a simple byte vector with access to the
- * underlying array.
+ * <p>This class implements a simple byte vector with access to the
+ * underlying array.</p>
*
- * @author Carlos Villegas <cav@uniscope.co.jp>
+ * <p>This work was authored by Carlos Villegas (cav@uniscope.co.jp).</p>
*/
public class ByteVector implements Serializable {
import java.io.Serializable;
/**
- * This class implements a simple char vector with access to the
- * underlying array.
+ * <p>This class implements a simple char vector with access to the
+ * underlying array.</p>
*
- * @author Carlos Villegas <cav@uniscope.co.jp>
+ * <p>This work was authored by Carlos Villegas (cav@uniscope.co.jp).</p>
*/
public class CharVector implements Cloneable, Serializable {
import java.io.Serializable;
/**
- * This class represents a hyphen. A 'full' hyphen is made of 3 parts:
+ * <p>This class represents a hyphen. A 'full' hyphen is made of 3 parts:
* the pre-break text, post-break text and no-break. If no line-break
* is generated at this position, the no-break text is used, otherwise,
* pre-break and post-break are used. Typically, pre-break is equal to
* the hyphen character and the others are empty. However, this general
* scheme allows support for cases in some languages where words change
* spelling if they're split across lines, like german's 'backen' which
- * hyphenates 'bak-ken'. BTW, this comes from TeX.
+ * hyphenates 'bak-ken'. BTW, this comes from TeX.</p>
*
- * @author Carlos Villegas <cav@uniscope.co.jp>
+ * <p>This work was authored by Carlos Villegas (cav@uniscope.co.jp).</p>
*/
/**
package org.apache.fop.hyphenation;
/**
- * This class represents a hyphenated word.
+ * <p.This class represents a hyphenated word.</p>
*
- * @author Carlos Villegas <cav@uniscope.co.jp>
+ * <p>This work was authored by Carlos Villegas (cav@uniscope.co.jp).</p>
*/
public class Hyphenation {
package org.apache.fop.hyphenation;
/**
- * An hyphenation exception.
- * @author Carlos Villegas <cav@uniscope.co.jp>
+ * <p>An hyphenation exception.</p>
+ *
+ * <p>This work was authored by Carlos Villegas (cav@uniscope.co.jp).</p>
+ *
* TODO Derive from FOPException
*/
public class HyphenationException extends Exception {
import org.xml.sax.InputSource;
/**
- * This tree structure stores the hyphenation patterns in an efficient
+ * <p>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.</p>
*
- * @author Carlos Villegas <cav@uniscope.co.jp>
+ * <p>This work was authored by Carlos Villegas (cav@uniscope.co.jp).</p>
*/
public class HyphenationTree extends TernaryTree
implements PatternConsumer, Serializable {
import java.util.Set;
/**
- * This is a cache for HyphenationTree instances.
+ * <p>This is a cache for HyphenationTree instances.</p>
*/
public class HyphenationTreeCache {
import javax.xml.transform.Source;
/**
- * This interface is used to resolve relative URIs pointing to hyphenation tree files.
+ * <p>This interface is used to resolve relative URIs pointing to hyphenation tree files.</p>
*/
public interface HyphenationTreeResolver {
import org.apache.commons.logging.LogFactory;
/**
- * This class is the main entry point to the hyphenation package.
- * You can use only the static methods or create an instance.
+ * <p>This class is the main entry point to the hyphenation package.
+ * You can use only the static methods or create an instance.</p>
*
- * @author Carlos Villegas <cav@uniscope.co.jp>
+ * <p>This work was authored by Carlos Villegas (cav@uniscope.co.jp).</p>
*/
public final class Hyphenator {
import java.util.ArrayList;
/**
- * This interface is used to connect the XML pattern file parser to
- * the hyphenation tree.
+ * <p>This interface is used to connect the XML pattern file parser to
+ * the hyphenation tree.</p>
*
- * @author Carlos Villegas <cav@uniscope.co.jp>
+ * <p>This work was authored by Carlos Villegas (cav@uniscope.co.jp).</p>
*/
public interface PatternConsumer {
import org.xml.sax.helpers.DefaultHandler;
/**
- * A SAX document handler to read and parse hyphenation patterns
- * from a XML file.
+ * <p>A SAX document handler to read and parse hyphenation patterns
+ * from a XML file.</p>
*
- * @author Carlos Villegas <cav@uniscope.co.jp>
+ * <p>This work was authored by Carlos Villegas (cav@uniscope.co.jp).</p>
*/
public class PatternParser extends DefaultHandler implements PatternConsumer {
import java.io.ObjectOutputStream;
/**
- * Serialize hyphenation patterns
- * For all xml files in the source directory a pattern file is built in the target directory
- * This class may be called from the ant build file in a java task
+ * <p>Serialize hyphenation patterns.</p>
+ * <p>For all xml files in the source directory a pattern file is built in the target directory.</p>
+ * <p>This class may be called from the ant build file in a java task.</p>
*/
public class SerializeHyphPattern {
* char value as an index to an array that contains the object
* values.</p>
*
- * @author cav@uniscope.co.jp
+ * <p>This work was authored by Carlos Villegas (cav@uniscope.co.jp).</p>
*/
public class TernaryTree implements Cloneable, Serializable {
package org.apache.fop.pdf;
/**
- * DCT Filter class. Right now it is just used as a dummy filter flag so
+ * <p>DCT Filter class. Right now it is just used as a dummy filter flag so
* we can write JPG images to the PDF. The encode method just returns the
* data passed to it. In the future an actual JPEG compression should be
- * added to the encode method so other images can be compressed.
+ * added to the encode method so other images can be compressed.</p>
*
- * @author Eric Dalquist
+ * <p>This work was authored by Eric Dalquist.</p>
*/
public class DCTFilter extends NullFilter {
import java.io.OutputStream;
/**
- * PDF Filter class.
- * This represents a PDF filter object.
- * Filter implementations should extend this class.
+ * <p>PDF Filter class.
+ * This class represents a PDF filter object.
+ * Filter implementations should extend this class.</p>
*
- * @author Eric SCHAEFFER, Kelly A. Campbell
+ * <p>This work was authored by Eric Schaeffer and Kelly A. Campbell.</p>
*/
public abstract class PDFFilter {
/*
package org.apache.fop.pdf;
/**
- * PDF Filter exception.
- * This is used for exceptions relating to use a PDF filter.
+ * <p>PDF Filter exception.
+ * This is used for exceptions relating to use a PDF filter.</p>
*
- * @author Eric SCHAEFFER
+ * <p>This work was authored by Eric Schaeffer.</p>
*/
public class PDFFilterException extends Exception {
/**
import java.util.List;
/**
- * This represents a single Outline object in a PDF, including the root Outlines
+ * <p>This represents a single Outline object in a PDF, including the root Outlines
* object. Outlines provide the bookmark bar, usually rendered to the right of
- * a PDF document in user agents such as Acrobat Reader
- *
- * @author Kelly A. Campbell
+ * a PDF document in user agents such as Acrobat Reader.</p>
*
+ * <p>This work was authored by Kelly A. Campbell.</p>
*/
public class PDFOutline extends PDFObject {
import org.apache.fop.svg.PDFDocumentGraphics2DConfigurator;
/**
- * This class enables to transcode an input to a PostScript document.
+ * <p>This class enables to transcode an input to a PostScript document.</p>
*
* <p>Two transcoding hints (<code>KEY_WIDTH</code> and
* <code>KEY_HEIGHT</code>) can be used to respectively specify the image
* stylesheet, and <code>KEY_PIXEL_TO_MM</code> to specify the pixel to
* millimeter conversion factor.
*
- * @author <a href="mailto:keiron@aftexsw.com">Keiron Liddle</a>
- * @version $Id$
+ * <p>This work was authored by Keiron Liddle (keiron@aftexsw.com).</p>
*/
public abstract class AbstractPSTranscoder extends AbstractFOPTranscoder {
import org.apache.xmlgraphics.java2d.ps.EPSDocumentGraphics2D;
/**
- * This class enables to transcode an input to a EPS document.
+ * <p>This class enables to transcode an input to a EPS document.</p>
*
* <p>Two transcoding hints (<code>KEY_WIDTH</code> and
* <code>KEY_HEIGHT</code>) can be used to respectively specify the image
* stylesheet, and <code>KEY_PIXEL_TO_MM</code> to specify the pixel to
* millimeter conversion factor.
*
- * @author <a href="mailto:keiron@aftexsw.com">Keiron Liddle</a>
- * @version $Id$
+ * <p>This work was authored by Keiron Liddle (keiron@aftexsw.com).</p>
*/
public class EPSTranscoder extends AbstractPSTranscoder {
import org.apache.batik.gvt.TextPainter;
/**
- * Bridge class for the <text> element.
+ * <p>Bridge class for the <text> element.
* This bridge will use the direct text painter if the text
- * for the element is simple.
- *
- * @author <a href="mailto:fop-dev@xml.apache.org">Apache XML FOP Development Team</a>
- * @version $Id$
+ * for the element is simple.</p>
*/
public class PSTextElementBridge extends SVGTextElementBridge {
}
}
-
import org.apache.xmlgraphics.java2d.ps.PSDocumentGraphics2D;
/**
- * This class enables to transcode an input to a PostScript document.
+ * <p>This class enables to transcode an input to a PostScript document.</p>
*
* <p>Two transcoding hints (<code>KEY_WIDTH</code> and
* <code>KEY_HEIGHT</code>) can be used to respectively specify the image
* stylesheet, and <code>KEY_PIXEL_TO_MM</code> to specify the pixel to
* millimeter conversion factor.
*
- * @author <a href="mailto:keiron@aftexsw.com">Keiron Liddle</a>
- * @version $Id$
+ * <p>This work was authored by Keiron Liddle (keiron@aftexsw.com).</p>
*/
public class PSTranscoder extends AbstractPSTranscoder {
import org.apache.fop.fo.properties.FixedLength;
-/** Converts XSL-FO units to RTF units
+/**
+ * <p>Converts XSL-FO units to RTF units.</p>
*
- * @author Bertrand Delacretaz <bdelacretaz@codeconsult.ch>
- * @author putzi
- * @author Peter Herweg <pherweg@web.de>
- *
- * This class was originally developed by Bertrand Delacretaz bdelacretaz@codeconsult.ch
- * for the JFOR project and is now integrated into FOP.
+ * <p>This work was originally developed by Bertrand Delacretaz (bdelacretaz@codeconsult.ch).</p>
*/
final class FoUnitsConverter {
import org.apache.fop.render.rtf.rtflib.rtfdoc.RtfPage;
-/** Converts simple-page-master attributes into strings as defined in RtfPage.
- * @author Christopher Scott, scottc@westinghouse.com
- * @author Peter Herweg, pherweg@web.de
+/**
+ * <p>Converts simple-page-master attributes into strings as defined in RtfPage.</p>
+ *
+ * <p>This work was authored by Christopher Scott (scottc@westinghouse.com) and
+ * Peter Herweg (pherweg@web.de).</p>
*/
final class PageAttributesConverter {
import org.apache.fop.render.rtf.rtflib.rtfdoc.RtfAttributes;
/**
- * Contributor(s):
- * @author Roberto Marra <roberto@link-u.com>
- * @author Boris Poudérous <boris.pouderous@eads-telecom.com>
- * @author Normand Massé
- * @author Peter Herweg <pherweg@web.de>
+ * <p>Table attributes converter.</p>
+ *
+ * <p>This work was authored by Roberto Marra (roberto@link-u.com),
+ * Boris Poudérous (boris.pouderous@eads-telecom.com),
+ * Normand Massé, and
+ * Peter Herweg (pherweg@web.de).</p>
*
* This class was originally developed for the JFOR project and
* is now integrated into FOP.
import org.apache.fop.render.rtf.rtflib.rtfdoc.RtfLeader;
import org.apache.fop.render.rtf.rtflib.rtfdoc.RtfText;
-/** Converts FO properties to RtfAttributes
- * @author Bertrand Delacretaz bdelacretaz@codeconsult.ch
- * @author Andreas Putz a.putz@skynamics.com
- * @author Boris Poudérous boris.pouderous@eads-telecom.com
- * @author Peter Herweg, pherweg@web.de
- * @author Normand Massé
- * @author Chris Scott
- * @author rmarra
+/**
+ * <p>Converts FO properties to RtfAttributes.</p>
+ *
+ * <p>This work was authored by Bertrand Delacretaz (bdelacretaz@codeconsult.ch),
+ * Boris Poudérous (boris.pouderous@eads-telecom.com),
+ * Peter Herweg (pherweg@web.de),
+ * Normand Massé,
+ * Christopher Scott (scottc@westinghouse.com), and
+ * Roberto Marra (roberto@link-u.com).</p>
*/
final class TextAttributesConverter {
* the FOP project.
*/
-/** Base class for rtflib exceptions.
- * @author Bertrand Delacretaz bdelacretaz@codeconsult.ch
+/**
+ * <p>Base class for rtflib exceptions.</p>
+ *
+ * <p>This work was authored by Bertrand Delacretaz (bdelacretaz@codeconsult.ch).</p>
*/
public class RtfException extends java.io.IOException {
/**
* the FOP project.
*/
-/** Thrown when a method call would lead to an invalid RTF document structure.
- * @author Bertrand Delacretaz bdelacretaz@codeconsult.ch
+/**
+ * <p>Thrown when a method call would lead to an invalid RTF document structure.</p>
+ *
+ * <p>This work was authored by Bertrand Delacretaz (bdelacretaz@codeconsult.ch).</p>
*/
public class RtfStructureException
extends RtfException {
import java.io.IOException;
/**
- * RTF Bookmark container interface.
- * @author <a href="mailto:a.putz@skynamics.com">Andreas Putz</a>
+ * <p>RTF Bookmark container interface.</p>
+ *
+ * <p>This work was authored by Andreas Putz (a.putz@skynamics.com).</p>
*/
public interface IRtfBookmarkContainer {
import java.io.IOException;
-/** interface for RtfElements that can contain RtfHyperLinks
- * @author Andreas Putz a.putz@skynamics.com
+/**
+ * <p>Interface for RtfElements that can contain RtfHyperLinks.</p>
+ *
+ * <p>This work was authored by Andreas Putz (a.putz@skynamics.com).</p>
*/
public interface IRtfHyperLinkContainer extends IRtfTextContainer {
/**
import java.io.IOException;
-/** Interface for RtfElements that can contain RtfLists
- * @author Bertrand Delacretaz bdelacretaz@codeconsult.ch
+/**
+ * <p>Interface for RtfElements that can contain RtfLists.</p>
+ *
+ * <p>This work was authored by Bertrand Delacretaz (bdelacretaz@codeconsult.ch).</p>
*/
public interface IRtfListContainer {
import java.io.IOException;
-/** Interface for RtfElements that can contain RtfPageBreaks
- * @author Bertrand Delacretaz bdelacretaz@codeconsult.ch
+/**
+ * <p>Interface for RtfElements that can contain RtfPageBreaks.</p>
+ *
+ * <p>This work was authored by Bertrand Delacretaz (bdelacretaz@codeconsult.ch).</p>
*/
public interface IRtfPageBreakContainer {
import java.io.IOException;
-/** Interface for RtfElements that can contain RtfText elements
- * @author Bertrand Delacretaz bdelacretaz@codeconsult.ch
+/**
+ * <p>Interface for RtfElements that can contain RtfText elements.</p>
+ *
+ * <p>This work was authored by Bertrand Delacretaz (bdelacretaz@codeconsult.ch).</p>
*/
public interface IRtfPageContainer {
import java.io.IOException;
-/** Interface for RtfElements that can contain RtfParagraphs
- * @author Bertrand Delacretaz bdelacretaz@codeconsult.ch
+/**
+ * <p>Interface for RtfElements that can contain RtfParagraphs.</p>
+ *
+ * <p>This work was authored by Bertrand Delacretaz (bdelacretaz@codeconsult.ch).</p>
*/
public interface IRtfParagraphContainer {
import java.io.IOException;
/**
- * Interface for RtfElements that can contain RtfTables
- * @author Bertrand Delacretaz bdelacretaz@codeconsult.ch
- * @author Boris Poudérous
+ * <p>Interface for RtfElements that can contain RtfTables.</p>
+ *
+ * <p>This work was authored by Bertrand Delacretaz (bdelacretaz@codeconsult.ch)
+ * and Boris Poudérous.</p>
*/
public interface IRtfTableContainer {
/**
import java.io.IOException;
-/** Interface for RtfElements that can contain RtfText elements
- * @author Bertrand Delacretaz bdelacretaz@codeconsult.ch
+/**
+ * <p>Interface for RtfElements that can contain RtfText elements.</p>
+ *
+ * <p>This work was authored by Bertrand Delacretaz (bdelacretaz@codeconsult.ch).</p>
*/
public interface IRtfTextContainer {
import java.io.IOException;
-/** Interface which enables an implementing class to contain linear text runs.
- * @author Peter Herweg, pherweg@web.de
+/**
+ * <p>Interface which enables an implementing class to contain linear text runs.</p>
+ *
+ * <p>This work was authored by Peter Herweg (pherweg@web.de).</p>
*/
public interface IRtfTextrunContainer {
*/
/**
- * Constants for RTF table attribute names
- * @author unascribed
- * @author Boris POUDEROUS
- * @author Chris Scott, Westinghouse
+ * <p>Constants for RTF table attribute names.</p>
+ *
+ * <p>This work was authored by Boris Pouderous and Chris Scott.</p>
*/
public interface ITableAttributes {
/** to process column spanning */
* the FOP project.
*/
-/** Used to get information about tables, for example when handling nested tables
- * @author Bertrand Delacretaz bdelacretaz@codeconsult.ch
+/**
+ * <p>Used to get information about tables, for example when handling nested tables.</p>
+ *
+ * <p>This work was authored by Bertrand Delacretaz (bdelacretaz@codeconsult.ch).</p>
*/
public interface ITableColumnsInfo {
import java.io.IOException;
import java.io.Writer;
-/** Common code for RtfAfter and RtfBefore
-* @author Andreas Lambert <andreas.lambert@cronidesoft.com>
-* @author Christopher Scott, scottc@westinghouse.com
-* @author Christoph Zahm <zahm@jnet.ch> (support for tables in headers/footers)
-*/
+/**
+ * <p>Common code for RtfAfter and RtfBefore.</p>
+ *
+ * <p>This work was authored by Andreas Lambert (andreas.lambert@cronidesoft.com),
+ * Christopher Scott (scottc@westinghouse.com), and
+ * Christoph Zahm (zahm@jnet.ch) [support for tables in headers/footers].</p>
+ */
abstract class RtfAfterBeforeBase
extends RtfContainer
import org.xml.sax.helpers.AttributesImpl;
-/** Attributes for RtfText
- * @author Bertrand Delacretaz bdelacretaz@codeconsult.ch
+/**
+ * <p>Attributes for RtfText.</p>
+ *
+ * <p>This work was authored by Bertrand Delacretaz (bdelacretaz@codeconsult.ch).</p>
*/
public class RtfAttributes
import java.io.Writer;
/**
- * RTF Bookmark.
+ * <p>RTF Bookmark.
* Create an RTF bookmark as a child of given container with default attributes.
- * This class belongs to the "id" attribute processing.
- * @author <a href="mailto:a.putz@skynamics.com">Andreas Putz</a>
+ * This class belongs to the "id" attribute processing.</p>
+ *
+ * <p>This work was authored by Andreas Putz (a.putz@skynamics.com).</p>
*/
public class RtfBookmark extends RtfElement {
//////////////////////////////////////////////////
import java.io.Writer;
/**
- * RTF Bookmark container implementation.
+ * <p>RTF Bookmark container implementation.
* Nearly all containers or elements can have a bookmark, that is why the bookmark container is
- * implemented as stand alone.
- * @author <a href="mailto:a.putz@skynamics.com">Andreas Putz</a>
+ * implemented as stand alone.</p>
+ *
+ * <p>This work was authored by Andreas Putz (a.putz@skynamics.com).</p>
*/
public class RtfBookmarkContainerImpl extends RtfContainer implements IRtfBookmarkContainer {
//////////////////////////////////////////////////
import java.util.Vector;
/**
- * Singelton of the RTF color table.
- * This class was created for <fo:basic-link> tag processing.
- * @author <a href="mailto:a.putz@skynamics.com">Andreas Putz</a>
+ * <p>Singelton of the RTF color table.
+ * This class was created for <fo:basic-link> tag processing.</p>
+ *
+ * <p>This work was authored by Andreas Putz (a.putz@skynamics.com).</p>
*/
public final class RtfColorTable {
import org.apache.fop.render.rtf.rtflib.exceptions.RtfStructureException;
-/** An RtfElement that can contain other elements.
- * @author Bertrand Delacretaz bdelacretaz@codeconsult.ch
+/**
+ * <p>An RtfElement that can contain other elements.</p>
+ *
+ * <p>This work was authored by Bertrand Delacretaz (bdelacretaz@codeconsult.ch).</p>
*/
public class RtfContainer extends RtfElement {
import java.io.IOException;
import java.io.Writer;
-/** The RTF document area, container for RtfSection objects.
- * @author Bertrand Delacretaz bdelacretaz@codeconsult.ch
+/**
+ * <p>The RTF document area, container for RtfSection objects.</p>
+ *
+ * <p>This work was authored by Bertrand Delacretaz (bdelacretaz@codeconsult.ch).</p>
*/
public class RtfDocumentArea
import java.io.Writer;
import java.util.Iterator;
-/** Base class for all elements of an RTF file.
- * @author Bertrand Delacretaz bdelacretaz@codeconsult.ch
- * @author Andreas Putz a.putz@skynamics.com
+/**
+ * <p>Base class for all elements of an RTF file.</p>
+ *
+ * <p>This work was authored by Bertrand Delacretaz (bdelacretaz@codeconsult.ch)
+ * and Andreas Putz (a.putz@skynamics.com).</p>
*/
public abstract class RtfElement {
/** Writer to be used */
import org.apache.fop.render.rtf.rtflib.tools.ImageUtil;
/**
- * Creates an RTF image from an external graphic file.
- * This class belongs to the <fo:external-graphic> tag processing. <br>
+ * <p>Creates an RTF image from an external graphic file.
+ * This class belongs to the <fo:external-graphic> tag processing.</p>
*
- * Supports relative path like "../test.gif", too (01-08-24) <br>
+ * <p>Supports relative path like "../test.gif", too (01-08-24)</p>
*
- * Limitations:
+ * <p>Limitations:</p>
+ * <ul>
* <li> Only the image types PNG, JPEG and EMF are supported
* <li> The GIF is supported, too, but will be converted to JPG
* <li> Only the attributes SRC (required), WIDTH, HEIGHT, SCALING are supported
* <li> The SCALING attribute supports (uniform | non-uniform)
+ * </ul>
*
- * Known Bugs:
+ * <p>Known Bugs:</p>
+ * <ul>
* <li> If the emf image has a desired size, the image will be clipped
* <li> The emf, jpg & png image will not be displayed in correct size
+ * </ul>
*
- * @author <a href="mailto:a.putz@skynamics.com">Andreas Putz</a>
- * @author Gianugo Rabellino gianugo@rabellino.it
+ * <p>This work was authored by Andreas Putz (a.putz@skynamics.com) and
+ * Gianugo Rabellino (gianugo@rabellino.it).</p>
*/
public class RtfExternalGraphic extends RtfElement {
/**
- * Used to add extra table rows after a row that contains a nested table:
+ * <p>Used to add extra table rows after a row that contains a nested table:</p>
+ * <ul>
* <li> created by RtfTableRow before generating RTF code
* <li> an RtfTableCell that contains a nested table can ask this to put
* some of its children in extra rows that after the current row
* <li> once RtfTableRow is done rendering its children, it renders this,
* causing extra rows to be generated, with content that can come
* from several RtfTableCells
+ * </ul>
*
- * See org.apache.fop.rtf.rtflib.testdocs.NestedTable for an example of
- * usage.
- * @author Bertrand Delacretaz bdelacretaz@codeconsult.ch
+ * <p>See org.apache.fop.rtf.rtflib.testdocs.NestedTable for an example of
+ * usage.</p>
+ *
+ * <p>This work was authored by Bertrand Delacretaz (bdelacretaz@codeconsult.ch).</p>
*/
public class RtfExtraRowSet extends RtfContainer {
import org.apache.fop.render.rtf.rtflib.exceptions.RtfStructureException;
/**
- * Models the top-level structure of an RTF file.
- * @author Bertrand Delacretaz bdelacretaz@codeconsult.ch
- * @author Andreas Putz a.putz@skynamics.com
- * @author Christopher Scott scottc@westinghouse.com
+ * <p>Models the top-level structure of an RTF file.</p>
+ *
+ * <p>This work was authored by Bertrand Delacretaz (bdelacretaz@codeconsult.ch),
+ * Andreas Putz (a.putz@skynamics.com), and
+ * Christopher Scott (scottc@westinghouse.com).</p>
*/
public class RtfFile
import java.util.Vector;
/**
- * RTF font table
- * @author Andreas Putz a.putz@skynamics.com
+ * <p>RTF font table.</p>
+ *
+ * <p>This work was authored by Andreas Putz (a.putz@skynamics.com).</p>
*/
public final class RtfFontManager {
//////////////////////////////////////////////////
import java.io.IOException;
import java.io.Writer;
-/** RTF font table
- * @author Bertrand Delacretaz bdelacretaz@codeconsult.ch
- * @author Andreas Putz a.putz@skynamics.com
+/**
+ * <p>RTF font table.</p>
+ *
+ * <p>This work was authored by Bertrand Delacretaz (bdelacretaz@codeconsult.ch)
+ * and Andreas Putz (a.putz@skynamics.com).</p>
*/
class RtfFontTable extends RtfElement {
import java.io.IOException;
import java.io.Writer;
-/** Model of an RTF footnote
- * @author Peter Herweg, pherweg@web.de
- * @author Marc Wilhelm Kuester
+/**
+ * <p>Model of an RTF footnote.</p>
+ *
+ * <p>This work was authored by Peter Herweg (pherweg@web.de) and
+ * Marc Wilhelm Kuester.</p>
*/
public class RtfFootnote extends RtfContainer
implements IRtfTextrunContainer, IRtfListContainer {
import java.util.Iterator;
import java.util.Map;
-/** RTF file header, contains style, font and other document-level information.
- * @author Bertrand Delacretaz bdelacretaz@codeconsult.ch
- * @author Andreas Putz a.putz@skynamics.com
- * @author Marc Wilhelm Kuester
+/**
+ * <p>RTF file header, contains style, font and other document-level information.</p>
+ *
+ * <p>This work was authored by Bertrand Delacretaz (bdelacretaz@codeconsult.ch),
+ * Andreas Putz (a.putz@skynamics.com), and
+ * Marc Wilhelm Kuester.</p>
*/
class RtfHeader extends RtfContainer {
import java.io.Writer;
/**
- * Creates an hyperlink.
- * This class belongs to the <fo:basic-link> tag processing.
- * @author <a href="mailto:a.putz@skynamics.com">Andreas Putz</a>
+ * <p>Creates an hyperlink.
+ * This class belongs to the <fo:basic-link> tag processing.</p>
*
- * {\field {\*\fldinst HYPERLINK "http://www.test.de" }{\fldrslt Joe Smith}}
+ * <p>This work was authored by Andreas Putz (a.putz@skynamics.com).</p>
*/
public class RtfHyperLink
extends RtfContainer
import java.io.IOException;
import java.io.Writer;
-/** "Model" of an RTF line break
- * @author Bertrand Delacretaz bdelacretaz@codeconsult.ch
+/**
+ * <p>Model of an RTF line break.</p>
+ *
+ * <p>This work was authored by Bertrand Delacretaz (bdelacretaz@codeconsult.ch).</p>
*/
public class RtfLineBreak extends RtfElement {
import java.util.Random;
/**
- * Model of an RTF list, which can contain RTF list items
- * @author Bertrand Delacretaz bdelacretaz@codeconsult.ch
- * @author Christopher Scott, scottc@westinghouse.com
- * @author Peter Herweg, pherweg@web.de
+ * <p>Model of an RTF list, which can contain RTF list items.</p>
+ *
+ * <p>This work was authored by Bertrand Delacretaz (bdelacretaz@codeconsult.ch),
+ * Christopher Scott (scottc@westinghouse.com), and
+ * Peter Herweg (pherweg@web.de).</p>
*/
public class RtfList extends RtfContainer {
private RtfListItem item;
import java.io.IOException;
import java.io.Writer;
-/** Model of an RTF list item, which can contain RTF paragraphs
- * @author Bertrand Delacretaz bdelacretaz@codeconsult.ch
- * @author Andreas Putz a.putz@skynamics.com
+/**
+ * <p>Model of an RTF list item, which can contain RTF paragraphs.</p>
+ *
+ * <p>This work was authored by Bertrand Delacretaz (bdelacretaz@codeconsult.ch)
+ * and Andreas Putz (a.putz@skynamics.com).</p>
*/
public class RtfListItem extends RtfContainer
implements IRtfTextrunContainer,
import java.util.LinkedList;
/**
- * RtfListTable: used to make the list table in the header section of the RtfFile.
+ * <p>RtfListTable: used to make the list table in the header section of the RtfFile.
* This is the method that Word uses to make lists in RTF and the way most RTF readers,
- * esp. Adobe FrameMaker read lists from RTF.
- * @author Christopher Scott, scottc@westinghouse.com
+ * esp. Adobe FrameMaker read lists from RTF.</p>
+ *
+ * <p>This work was authored by Christopher Scott (scottc@westinghouse.com).</p>
*/
public class RtfListTable extends RtfContainer {
private LinkedList lists;
import java.io.Writer;
/**
- * @author Christopher Scott, scottc@westinghouse.com
+ * <p>Null container.</p>
+ *
+ * <p>This work was authored by Christopher Scott (scottc@westinghouse.com).</p>
*/
public class RtfNull
extends RtfContainer {
*/
/**
- * Simplistic options definitions for RTF generation
- * @author Bertrand Delacretaz bdelacretaz@codeconsult.ch
+ * <p>Simplistic options definitions for RTF generation.</p>
+ *
+ * <p>This work was authored by Bertrand Delacretaz (bdelacretaz@codeconsult.ch).</p>
*/
public class RtfOptions {
/**
import java.io.IOException;
import java.io.Writer;
-/** Specifies rtf control words. Is the container for page attributes.
- * Overrides okToWriteRtf.
- * @author Christopher Scott, scottc@westinghouse.com
+/**
+ * <p>Specifies rtf control words. Is the container for page attributes.
+ * Overrides okToWriteRtf.</p>
+ *
+ * <p>This work was authored by Christopher Scott (scottc@westinghouse.com).</p>
*/
public class RtfPage
import java.io.Writer;
/**
- * @author Christopher Scott, scottc@westinghouse.com
+ * <p>Page area container.</p>
+ *
+ * <p>This work was authored by Christopher Scott (scottc@westinghouse.com).</p>
*/
public class RtfPageArea
extends RtfContainer {
import java.io.IOException;
import java.io.Writer;
-/** "Model" of an RTF page break
- * @author Bertrand Delacretaz bdelacretaz@codeconsult.ch
+/**
+ * <p>Model of an RTF page break.</p>
+ *
+ * <p>This work was authored by Bertrand Delacretaz (bdelacretaz@codeconsult.ch).</p>
*/
public class RtfPageBreak extends RtfElement {
import java.io.Writer;
/**
- * @author Christopher Scott, scottc@westinghouse.com
+ * <p>Page number container.</p>
+ *
+ * <p>This work was authored by Christopher Scott (scottc@westinghouse.com).</p>
*/
public class RtfPageNumber extends RtfContainer {
/* RtfText attributes: fields
import java.io.Writer;
/**
- * @author Christopher Scott, scottc@westinghouse.com
- * @author Boris Pouderous, boris.pouderous@free.fr
+ * <p>Page number citation container.</p>
+
+ * <p>This work was authored by Christopher Scott (scottc@westinghouse.com) and
+ * Boris Pouderous (boris.pouderous@free.fr).</p>
*/
public class RtfPageNumberCitation extends RtfContainer {
/* Page field :
import java.io.Writer;
import java.util.List;
-/** Model of an RTF paragraph, which can contain RTF text elements.
- * @author Bertrand Delacretaz bdelacretaz@codeconsult.ch
- * @author Andreas Putz a.putz@skynamics.com
- * @author Boris Poudérous, boris.pouderous@free.fr
+/**
+ * <p>Model of an RTF paragraph, which can contain RTF text elements.</p>
+ *
+ * <p>This work was authored by Bertrand Delacretaz (bdelacretaz@codeconsult.ch),
+ * Andreas Putz (a.putz@skynamics.com), and
+ * Boris Poudérous (boris.pouderous@free.fr).</p>
*/
public class RtfParagraph extends RtfBookmarkContainerImpl
import java.io.IOException;
import java.io.Writer;
-/** Models a section in an RTF document
- * @author Bertrand Delacretaz bdelacretaz@codeconsult.ch
+/**
+ * <p>Models a section in an RTF document</p>
+ *
+ * <p>This work was authored by Bertrand Delacretaz (bdelacretaz@codeconsult.ch).</p>
*/
public class RtfSection
import java.io.IOException;
import java.io.Writer;
-/** Plain text in a RTF file, without any formatings.
- * @author Peter Herweg, pherweg@web.de
+/**
+ * <p>Plain text in a RTF file, without any formatings.</p>
+ *
+ * <p>This work was authored by Peter Herweg (pherweg@web.de).</p>
*/
public class RtfString extends RtfElement {
import java.util.HashMap;
import java.util.Map;
-/** Converts java Strings according to RTF conventions
- * @author Bertrand Delacretaz bdelacretaz@codeconsult.ch
+/**
+ * <p>Converts java Strings according to RTF conventions.</p>
+ *
+ * <p>This work was authored by Bertrand Delacretaz (bdelacretaz@codeconsult.ch).</p>
*/
public final class RtfStringConverter {
import java.util.Vector;
/**
- * Singelton of the RTF style sheet table.
- * This class belongs to the <jfor:stylesheet> tag processing.
- * @author <a href="mailto:a.putz@skynamics.com">Andreas Putz</a>
+ * <p>Singelton of the RTF style sheet table.
+ * This class belongs to the <jfor:stylesheet> tag processing.</p>
+ *
+ * <p>This work was authored by Andreas Putz (a.putz@skynamics.com).</p>
*/
public final class RtfStyleSheetTable {
//////////////////////////////////////////////////
import java.io.IOException;
import java.io.Writer;
-/** Container for RtfRow elements
- * @author Bertrand Delacretaz bdelacretaz@codeconsult.ch
+/**
+ * <p>Container for RtfRow elements.</p>
+ *
+ * <p>This work was authored by Bertrand Delacretaz (bdelacretaz@codeconsult.ch).</p>
*/
public class RtfTable extends RtfContainer {
import java.io.Writer;
import java.util.Iterator;
-/** A cell in an RTF table, container for paragraphs, lists, etc.
- * @author Bertrand Delacretaz bdelacretaz@codeconsult.ch
+/**
+ * <p>A cell in an RTF table, container for paragraphs, lists, etc.</p>
+ *
+ * <p>This work was authored by Bertrand Delacretaz (bdelacretaz@codeconsult.ch).</p>
*/
public class RtfTableCell
import java.io.Writer;
import java.util.Iterator;
-/** Container for RtfTableCell elements
- * @author Bertrand Delacretaz bdelacretaz@codeconsult.ch
- * @author Andreas Putz a.putz@skynamics.com
- * @author Roberto Marra roberto@link-u.com
+/**
+ * <p>Container for RtfTableCell elements.</p>
+ *
+ * <p>This work was authored by Bertrand Delacretaz (bdelacretaz@codeconsult.ch),
+ * Andreas Putz (a.putz@skynamics.com), and
+ * Roberto Marra (roberto@link-u.com).</p>
*/
public class RtfTableRow extends RtfContainer implements ITableAttributes {
import java.io.IOException;
import java.io.Writer;
-/** Model of a text run (a piece of text with attributes) in an RTF document
- * @author Bertrand Delacretaz bdelacretaz@codeconsult.ch
+/**
+ * <p>Model of a text run (a piece of text with attributes) in an RTF document.</p>
+ *
+ * <p>This work was authored by Bertrand Delacretaz (bdelacretaz@codeconsult.ch).</p>
*/
public class RtfText extends RtfElement {
import org.apache.commons.logging.LogFactory;
/**
- * Class which contains a linear text run. It has methods to add attributes,
- * text, paragraph breaks....
- * @author Peter Herweg, pherweg@web.de
+ * <p>Class which contains a linear text run. It has methods to add attributes,
+ * text, paragraph breaks....</p>
+ *
+ * <p>This work was authored by Peter Herweg (pherweg@web.de).</p>
*/
public class RtfTextrun extends RtfContainer {
import java.util.Iterator;
import java.util.StringTokenizer;
-/** Collapses whitespace of an RtfContainer that contains RtfText elements
- * @author Bertrand Delacretaz bdelacretaz@codeconsult.ch
+/**
+ * <p>Collapses whitespace of an RtfContainer that contains RtfText elements.</p>
+ *
+ * <p>This work was authored by Bertrand Delacretaz (bdelacretaz@codeconsult.ch).</p>
*/
final class WhitespaceCollapser {
import org.apache.fop.render.rtf.rtflib.rtfdoc.RtfContainer;
-/** A BuilderContext holds context information when building an RTF document
- *
- * @author Bertrand Delacretaz <bdelacretaz@codeconsult.ch>
- * @author putzi
- * @author Peter Herweg <pherweg@web.de>
+/**
+ * <p>A BuilderContext holds context information when building an RTF document.</p>
*
* This class was originally developed by Bertrand Delacretaz bdelacretaz@codeconsult.ch
* for the JFOR project and is now integrated into FOP.
+ *
+ * <p>This work was authored by Bertrand Delacretaz (bdelacretaz@codeconsult.ch),
+ * Andreas Putz (a.putz@skynamics.com), and
+ * Peter Herweg (pherweg@web.de).</p>
*/
public class BuilderContext {
* the FOP project.
*/
-/** Here will be defined all supported image formats.
- * This class belongs to the <fo:external-graphic> tag processing.
- * @author a.putz@skynamics.com (Andreas Putz)
+/**
+ * <p>Here will be defined all supported image formats.
+ * This class belongs to the <fo:external-graphic> tag processing.</p>
+ *
+ * <p>This work was authored by Andreas Putz (a.putz@skynamics.com).</p>
*/
public final class ImageConstants {
* the FOP project.
*/
-/** Misc.utilities for images handling
- * This class belongs to the <fo:external-graphic> tag processing.
- * @author <a href="mailto:a.putz@skynamics.com">Andreas Putz</a>
+/**
+ * <p>Miscellaneous utilities for images handling.
+ * This class belongs to the <fo:external-graphic> tag processing.</p>
+ *
+ * <p>This work was authored by Andreas Putz (a.putz@skynamics.com).</p>
*/
public final class ImageUtil {
import org.apache.fop.fo.pagination.PageSequence;
/**
- * PercentBaseContext implementation to track base widths for percentage calculations.
+ * <p>PercentBaseContext implementation to track base widths for percentage calculations.</p>
*/
public class PercentContext implements PercentBaseContext {
private static Log log = LogFactory.getLog(PercentContext.class);
import org.apache.fop.render.rtf.rtflib.rtfdoc.RtfAttributes;
-/** Used when handling fo:table to hold information to build the table.
+/**
+ * <p>Used when handling fo:table to hold information to build the table.</p>
*
- * Contributor(s):
- * @author Bertrand Delacretaz <bdelacretaz@codeconsult.ch>
- * @author Trembicki-Guy, Ed <GuyE@DNB.com>
- * @author Boris Poudérous <boris.pouderous@eads-telecom.com>
- * @author Peter Herweg <pherweg@web.de>
+ * <p>This work was authored by Bertrand Delacretaz (bdelacretaz@codeconsult.ch),
+ * Ed Trembicki-Guy (guye@dnb.com),
+ * Boris Poudérous (boris.pouderous@eads-telecom.com), and
+ * Peter Herweg (pherweg@web.de).</p>
*
* This class was originally developed for the JFOR project and
* is now integrated into FOP.
import org.apache.fop.render.txt.border.BorderManager;
/**
- * Renderer that renders areas to plain text.
+ * <p>Renderer that renders areas to plain text.</p>
*
- * @author Art Welch
- * @author <a href="mailto:mark-fop@inomial.com">Mark Lillywhite</a> (to use
- * the new Renderer interface)
+ * <p>This work was authored by Art Welch and
+ * Mark Lillywhite (mark-fop@inomial.com) [to use the new Renderer interface].</p>
*/
public class TXTRenderer extends AbstractPathOrientedRenderer {
* <br/>
* <b>Note:</b> This servlet is derived from FopServlet. Most methods are inherited from the
* superclass. Only the differences to the base class are necessary.
- *
- * @author <a href="mailto:fop-dev@xmlgraphics.apache.org">Apache FOP Development Team</a>
- * @version $Id$
*/
public class FopPrintServlet extends FopServlet {
* <br/>
* For this to work with Internet Explorer, you might need to append "&ext=.pdf"
* to the URL.
- *
- * @author <a href="mailto:fop-dev@xmlgraphics.apache.org">Apache FOP Development Team</a>
- * @version $Id$
* (todo) Ev. add caching mechanism for Templates objects
*/
public class FopServlet extends HttpServlet {
import org.apache.fop.image.loader.batik.BatikUtil;
/**
- * Bridge class for the <image> element when jpeg images.
+ * <p>Bridge class for the <image> element when jpeg images.</p>
*
- * @author <a href="mailto:keiron@aftexsw.com">Keiron Liddle</a>
+ * <p>This work was authored by Keiron Liddle (keiron@aftexsw.com).</p>
*/
public abstract class AbstractFOPImageElementBridge extends SVGImageElementBridge {
import org.apache.batik.gvt.TextPainter;
/**
- * Bridge class for the <text> element.
+ * <p>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.</p>
*
- * @author <a href="mailto:keiron@aftexsw.com">Keiron Liddle</a>
+ * <p>This work was authored by Keiron Liddle (keiron@aftexsw.com).</p>
*/
public abstract class AbstractFOPTextElementBridge extends SVGTextElementBridge {
import org.apache.batik.gvt.GraphicsNode;
/**
- * Bridge class for the <a> element.
+ * <p>Bridge class for the <a> element.</p>
*
- * @author <a href="mailto:keiron@aftexsw.com">Keiron Liddle</a>
+ * <p>This work was authored by Keiron Liddle (keiron@aftexsw.com).</p>
*/
public class PDFAElementBridge extends AbstractGraphicsNodeBridge {
private AffineTransform transform;
import org.apache.batik.gvt.CompositeGraphicsNode;
/**
- * A graphics node that represents an image described as a graphics node.
+ * <p>A graphics node that represents an image described as a graphics node.</p>
*
- * @author <a href="mailto:keiron@aftexsw.com">Keiron Liddle</a>
+ * <p>This work was authored by Keiron Liddle (keiron@aftexsw.com).</p>
*/
public class PDFANode extends CompositeGraphicsNode {
private String destination;
import org.apache.fop.render.pdf.ImageRenderedAdapter;
/**
- * PDF Graphics 2D.
+ * <p>PDF Graphics 2D.
* Used for drawing into a pdf document as if it is a graphics object.
- * This takes a pdf document and draws into it.
+ * This takes a pdf document and draws into it.</p>
+ *
+ * <p>This work was authored by Keiron Liddle (keiron@aftexsw.com).</p>
*
- * @author <a href="mailto:keiron@aftexsw.com">Keiron Liddle</a>
- * @version $Id$
* @see org.apache.batik.ext.awt.g2d.AbstractGraphics2D
*/
public class PDFGraphics2D extends AbstractGraphics2D implements NativeImageHandler {
import org.apache.fop.image.loader.batik.BatikImageFlavors;
/**
- * PDF Image Element Bridge class for the <image> element when jpeg images.
+ * <p>PDF Image Element Bridge class for the <image> element when jpeg images.</p>
*
- * @author <a href="mailto:keiron@aftexsw.com">Keiron Liddle</a>
+ * <p>This work was authored by Keiron Liddle (keiron@aftexsw.com).</p>
*/
public class PDFImageElementBridge extends AbstractFOPImageElementBridge {
import org.apache.batik.gvt.TextPainter;
/**
- * Bridge class for the <text> element.
+ * <p>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.</p>
*
- * @author <a href="mailto:keiron@aftexsw.com">Keiron Liddle</a>
+ * <p>This work was authored by Keiron Liddle (keiron@aftexsw.com).</p>
*/
public class PDFTextElementBridge extends AbstractFOPTextElementBridge {
import org.apache.fop.fonts.FontInfo;
/**
- * This class enables to transcode an input to a pdf document.
+ * <p>This class enables to transcode an input to a PDF document.</p>
*
* <p>Two transcoding hints (<code>KEY_WIDTH</code> and
* <code>KEY_HEIGHT</code>) can be used to respectively specify the image
* of the other transcoders, but this may be associated with a price in the form of a small
* performance penalty. If font auto-detection is not desired, it can be disable using this key.
*
- * @author <a href="mailto:keiron@aftexsw.com">Keiron Liddle</a>
- * @version $Id$
+ * <p>This work was authored by Keiron Liddle (keiron@aftexsw.com).</p>
*/
public class PDFTranscoder extends AbstractFOPTranscoder {
* @param s a java string (encoded in UTF-16)
* @return a string representing a sequence of numeric character reference or
* ASCII characters
- * @author Glenn Adams
*/
public static String toNCRefs ( String s ) {
StringBuffer sb = new StringBuffer();
* @param width width of field to add padding
* @param pad character to use for padding
* @return padded string
- * @author Glenn Adams
*/
public static String padLeft ( String s, int width, char pad ) {
StringBuffer sb = new StringBuffer();
* and either 4 or 6 hex characters in width according to whether it is in the BMP or not.
* @param c character code
* @return formatted character string
- * @author Glenn Adams
*/
public static String format ( int c ) {
if ( c < 1114112 ) {
* @param cs1 first character sequence
* @param cs2 second character sequence
* @return true if both sequences have same length and same character sequence
- * @author Glenn Adams
*/
public static boolean isSameSequence ( CharSequence cs1, CharSequence cs2 ) {
assert cs1 != null;
projects / xmlgraphics-fop.git / commitdiff