diff options
| author | Glenn Adams <gadams@apache.org> | 2012-03-05 23:29:29 +0000 |
|---|---|---|
| committer | Glenn Adams <gadams@apache.org> | 2012-03-05 23:29:29 +0000 |
| commit | 1dc8efba5f37f241be94fa1f977c453a38ea58e2 (patch) | |
| tree | f258fbe99caee9ab58fff3636d4432d600fc3310 /src/java/org/apache | |
| parent | 64cbcc37824ec37cf6bbfa9336fad2b41cda5ccd (diff) | |
| download | xmlgraphics-fop-1dc8efba5f37f241be94fa1f977c453a38ea58e2.tar.gz xmlgraphics-fop-1dc8efba5f37f241be94fa1f977c453a38ea58e2.zip | |
add RegexpSingleline rule to flag use of @author; fix violations
git-svn-id: https://svn.apache.org/repos/asf/xmlgraphics/fop/trunk@1297284 13f79535-47bb-0310-9956-ffa450edef68
Diffstat (limited to 'src/java/org/apache')
143 files changed, 511 insertions, 400 deletions
diff --git a/src/java/org/apache/fop/afp/util/DTDEntityResolver.java b/src/java/org/apache/fop/afp/util/DTDEntityResolver.java index 7ba061993..1f9f55ee6 100644 --- a/src/java/org/apache/fop/afp/util/DTDEntityResolver.java +++ b/src/java/org/apache/fop/afp/util/DTDEntityResolver.java @@ -33,7 +33,8 @@ import org.apache.fop.afp.fonts.FontRuntimeException; * 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 { diff --git a/src/java/org/apache/fop/complexscripts/bidi/BidiConstants.java b/src/java/org/apache/fop/complexscripts/bidi/BidiConstants.java index 6349417f6..eeca2b41a 100644 --- a/src/java/org/apache/fop/complexscripts/bidi/BidiConstants.java +++ b/src/java/org/apache/fop/complexscripts/bidi/BidiConstants.java @@ -21,8 +21,9 @@ package org.apache.fop.complexscripts.bidi; /** - * 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 { diff --git a/src/java/org/apache/fop/complexscripts/bidi/BidiResolver.java b/src/java/org/apache/fop/complexscripts/bidi/BidiResolver.java index 70bbe857a..97a9f0b52 100644 --- a/src/java/org/apache/fop/complexscripts/bidi/BidiResolver.java +++ b/src/java/org/apache/fop/complexscripts/bidi/BidiResolver.java @@ -41,7 +41,7 @@ import org.apache.fop.fo.pagination.PageSequence; /** * <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 { diff --git a/src/java/org/apache/fop/complexscripts/bidi/DelimitedTextRange.java b/src/java/org/apache/fop/complexscripts/bidi/DelimitedTextRange.java index 9939db971..9654b74d5 100644 --- a/src/java/org/apache/fop/complexscripts/bidi/DelimitedTextRange.java +++ b/src/java/org/apache/fop/complexscripts/bidi/DelimitedTextRange.java @@ -44,7 +44,7 @@ import org.apache.fop.util.CharUtilities; * 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 diff --git a/src/java/org/apache/fop/complexscripts/bidi/InlineRun.java b/src/java/org/apache/fop/complexscripts/bidi/InlineRun.java index 7897770f8..19c4119fd 100644 --- a/src/java/org/apache/fop/complexscripts/bidi/InlineRun.java +++ b/src/java/org/apache/fop/complexscripts/bidi/InlineRun.java @@ -44,7 +44,7 @@ import org.apache.fop.util.CharUtilities; * 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; diff --git a/src/java/org/apache/fop/complexscripts/bidi/TextInterval.java b/src/java/org/apache/fop/complexscripts/bidi/TextInterval.java index 8249c4628..6130da97b 100644 --- a/src/java/org/apache/fop/complexscripts/bidi/TextInterval.java +++ b/src/java/org/apache/fop/complexscripts/bidi/TextInterval.java @@ -31,10 +31,10 @@ import org.apache.fop.fo.flow.Leader; // 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 diff --git a/src/java/org/apache/fop/complexscripts/bidi/UnflattenProcessor.java b/src/java/org/apache/fop/complexscripts/bidi/UnflattenProcessor.java index d91bed572..864c2930c 100644 --- a/src/java/org/apache/fop/complexscripts/bidi/UnflattenProcessor.java +++ b/src/java/org/apache/fop/complexscripts/bidi/UnflattenProcessor.java @@ -41,10 +41,10 @@ import org.apache.fop.area.inline.UnresolvedPageNumber; // 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 diff --git a/src/java/org/apache/fop/complexscripts/bidi/UnicodeBidiAlgorithm.java b/src/java/org/apache/fop/complexscripts/bidi/UnicodeBidiAlgorithm.java index 9f61ecab8..a12d24aae 100644 --- a/src/java/org/apache/fop/complexscripts/bidi/UnicodeBidiAlgorithm.java +++ b/src/java/org/apache/fop/complexscripts/bidi/UnicodeBidiAlgorithm.java @@ -33,10 +33,10 @@ import org.apache.fop.util.CharUtilities; // 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 { diff --git a/src/java/org/apache/fop/complexscripts/fonts/AdvancedTypographicTableFormatException.java b/src/java/org/apache/fop/complexscripts/fonts/AdvancedTypographicTableFormatException.java index 4f3e341d6..4acd2c87b 100644 --- a/src/java/org/apache/fop/complexscripts/fonts/AdvancedTypographicTableFormatException.java +++ b/src/java/org/apache/fop/complexscripts/fonts/AdvancedTypographicTableFormatException.java @@ -20,9 +20,10 @@ 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 { /** diff --git a/src/java/org/apache/fop/complexscripts/fonts/GlyphClassMapping.java b/src/java/org/apache/fop/complexscripts/fonts/GlyphClassMapping.java index 4afc747a2..9a94c7be0 100644 --- a/src/java/org/apache/fop/complexscripts/fonts/GlyphClassMapping.java +++ b/src/java/org/apache/fop/complexscripts/fonts/GlyphClassMapping.java @@ -22,9 +22,10 @@ package org.apache.fop.complexscripts.fonts; // 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 { diff --git a/src/java/org/apache/fop/complexscripts/fonts/GlyphClassTable.java b/src/java/org/apache/fop/complexscripts/fonts/GlyphClassTable.java index 71aa206ba..07d64eb98 100644 --- a/src/java/org/apache/fop/complexscripts/fonts/GlyphClassTable.java +++ b/src/java/org/apache/fop/complexscripts/fonts/GlyphClassTable.java @@ -26,8 +26,9 @@ import java.util.List; // 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 { diff --git a/src/java/org/apache/fop/complexscripts/fonts/GlyphCoverageMapping.java b/src/java/org/apache/fop/complexscripts/fonts/GlyphCoverageMapping.java index e8fde9474..999876088 100644 --- a/src/java/org/apache/fop/complexscripts/fonts/GlyphCoverageMapping.java +++ b/src/java/org/apache/fop/complexscripts/fonts/GlyphCoverageMapping.java @@ -22,9 +22,10 @@ package org.apache.fop.complexscripts.fonts; // 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 { diff --git a/src/java/org/apache/fop/complexscripts/fonts/GlyphCoverageTable.java b/src/java/org/apache/fop/complexscripts/fonts/GlyphCoverageTable.java index f0e7e50da..6037aa6e4 100644 --- a/src/java/org/apache/fop/complexscripts/fonts/GlyphCoverageTable.java +++ b/src/java/org/apache/fop/complexscripts/fonts/GlyphCoverageTable.java @@ -31,8 +31,9 @@ import org.apache.commons.logging.LogFactory; // 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 { diff --git a/src/java/org/apache/fop/complexscripts/fonts/GlyphDefinition.java b/src/java/org/apache/fop/complexscripts/fonts/GlyphDefinition.java index a3d511dce..268e00fdd 100644 --- a/src/java/org/apache/fop/complexscripts/fonts/GlyphDefinition.java +++ b/src/java/org/apache/fop/complexscripts/fonts/GlyphDefinition.java @@ -22,9 +22,10 @@ package org.apache.fop.complexscripts.fonts; // 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 { diff --git a/src/java/org/apache/fop/complexscripts/fonts/GlyphDefinitionSubtable.java b/src/java/org/apache/fop/complexscripts/fonts/GlyphDefinitionSubtable.java index ec7e1e3d2..94829425e 100644 --- a/src/java/org/apache/fop/complexscripts/fonts/GlyphDefinitionSubtable.java +++ b/src/java/org/apache/fop/complexscripts/fonts/GlyphDefinitionSubtable.java @@ -23,9 +23,10 @@ package org.apache.fop.complexscripts.fonts; // 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 { diff --git a/src/java/org/apache/fop/complexscripts/fonts/GlyphDefinitionTable.java b/src/java/org/apache/fop/complexscripts/fonts/GlyphDefinitionTable.java index 18bf018dc..ca57ca67f 100644 --- a/src/java/org/apache/fop/complexscripts/fonts/GlyphDefinitionTable.java +++ b/src/java/org/apache/fop/complexscripts/fonts/GlyphDefinitionTable.java @@ -33,9 +33,10 @@ import org.apache.fop.complexscripts.util.GlyphSequence; // 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 { diff --git a/src/java/org/apache/fop/complexscripts/fonts/GlyphMappingTable.java b/src/java/org/apache/fop/complexscripts/fonts/GlyphMappingTable.java index e91c1d6b0..f8e430537 100644 --- a/src/java/org/apache/fop/complexscripts/fonts/GlyphMappingTable.java +++ b/src/java/org/apache/fop/complexscripts/fonts/GlyphMappingTable.java @@ -28,10 +28,11 @@ import java.util.List; // 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 { diff --git a/src/java/org/apache/fop/complexscripts/fonts/GlyphPositioning.java b/src/java/org/apache/fop/complexscripts/fonts/GlyphPositioning.java index 92fae7506..2ebc4d0a5 100644 --- a/src/java/org/apache/fop/complexscripts/fonts/GlyphPositioning.java +++ b/src/java/org/apache/fop/complexscripts/fonts/GlyphPositioning.java @@ -22,10 +22,11 @@ package org.apache.fop.complexscripts.fonts; // 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 { diff --git a/src/java/org/apache/fop/complexscripts/fonts/GlyphPositioningState.java b/src/java/org/apache/fop/complexscripts/fonts/GlyphPositioningState.java index ea62a7239..e269f0c22 100644 --- a/src/java/org/apache/fop/complexscripts/fonts/GlyphPositioningState.java +++ b/src/java/org/apache/fop/complexscripts/fonts/GlyphPositioningState.java @@ -26,9 +26,10 @@ import org.apache.fop.complexscripts.util.ScriptContextTester; // 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 { diff --git a/src/java/org/apache/fop/complexscripts/fonts/GlyphPositioningSubtable.java b/src/java/org/apache/fop/complexscripts/fonts/GlyphPositioningSubtable.java index cb87faff4..a2e3a7fe7 100644 --- a/src/java/org/apache/fop/complexscripts/fonts/GlyphPositioningSubtable.java +++ b/src/java/org/apache/fop/complexscripts/fonts/GlyphPositioningSubtable.java @@ -27,9 +27,10 @@ import org.apache.fop.complexscripts.util.ScriptContextTester; // 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 { diff --git a/src/java/org/apache/fop/complexscripts/fonts/GlyphPositioningTable.java b/src/java/org/apache/fop/complexscripts/fonts/GlyphPositioningTable.java index 48d5e4789..3b7c14b0e 100644 --- a/src/java/org/apache/fop/complexscripts/fonts/GlyphPositioningTable.java +++ b/src/java/org/apache/fop/complexscripts/fonts/GlyphPositioningTable.java @@ -38,9 +38,10 @@ import org.apache.fop.complexscripts.util.GlyphTester; // 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 { diff --git a/src/java/org/apache/fop/complexscripts/fonts/GlyphProcessingState.java b/src/java/org/apache/fop/complexscripts/fonts/GlyphProcessingState.java index b40708e11..589fcb90b 100644 --- a/src/java/org/apache/fop/complexscripts/fonts/GlyphProcessingState.java +++ b/src/java/org/apache/fop/complexscripts/fonts/GlyphProcessingState.java @@ -32,9 +32,10 @@ import org.apache.fop.complexscripts.util.ScriptContextTester; // 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 { diff --git a/src/java/org/apache/fop/complexscripts/fonts/GlyphSubstitution.java b/src/java/org/apache/fop/complexscripts/fonts/GlyphSubstitution.java index b8f9d02bf..600d4de49 100644 --- a/src/java/org/apache/fop/complexscripts/fonts/GlyphSubstitution.java +++ b/src/java/org/apache/fop/complexscripts/fonts/GlyphSubstitution.java @@ -22,10 +22,11 @@ package org.apache.fop.complexscripts.fonts; // 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 { diff --git a/src/java/org/apache/fop/complexscripts/fonts/GlyphSubstitutionState.java b/src/java/org/apache/fop/complexscripts/fonts/GlyphSubstitutionState.java index 8aca846ae..65fdee9e0 100644 --- a/src/java/org/apache/fop/complexscripts/fonts/GlyphSubstitutionState.java +++ b/src/java/org/apache/fop/complexscripts/fonts/GlyphSubstitutionState.java @@ -30,9 +30,10 @@ import org.apache.fop.complexscripts.util.ScriptContextTester; // 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 { diff --git a/src/java/org/apache/fop/complexscripts/fonts/GlyphSubstitutionSubtable.java b/src/java/org/apache/fop/complexscripts/fonts/GlyphSubstitutionSubtable.java index d111b465f..2f337bc6a 100644 --- a/src/java/org/apache/fop/complexscripts/fonts/GlyphSubstitutionSubtable.java +++ b/src/java/org/apache/fop/complexscripts/fonts/GlyphSubstitutionSubtable.java @@ -26,9 +26,10 @@ import org.apache.fop.complexscripts.util.ScriptContextTester; // 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 { diff --git a/src/java/org/apache/fop/complexscripts/fonts/GlyphSubstitutionTable.java b/src/java/org/apache/fop/complexscripts/fonts/GlyphSubstitutionTable.java index dfed0cc39..06ed69c4a 100644 --- a/src/java/org/apache/fop/complexscripts/fonts/GlyphSubstitutionTable.java +++ b/src/java/org/apache/fop/complexscripts/fonts/GlyphSubstitutionTable.java @@ -36,9 +36,10 @@ import org.apache.fop.complexscripts.util.GlyphTester; // 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 { diff --git a/src/java/org/apache/fop/complexscripts/fonts/GlyphSubtable.java b/src/java/org/apache/fop/complexscripts/fonts/GlyphSubtable.java index ba0141e44..776fcb029 100644 --- a/src/java/org/apache/fop/complexscripts/fonts/GlyphSubtable.java +++ b/src/java/org/apache/fop/complexscripts/fonts/GlyphSubtable.java @@ -28,9 +28,10 @@ import java.util.Map; // 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 { diff --git a/src/java/org/apache/fop/complexscripts/fonts/GlyphTable.java b/src/java/org/apache/fop/complexscripts/fonts/GlyphTable.java index 73697f6a7..c5a865b41 100644 --- a/src/java/org/apache/fop/complexscripts/fonts/GlyphTable.java +++ b/src/java/org/apache/fop/complexscripts/fonts/GlyphTable.java @@ -44,8 +44,9 @@ import org.apache.fop.complexscripts.util.ScriptContextTester; // 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 { diff --git a/src/java/org/apache/fop/complexscripts/fonts/IncompatibleSubtableException.java b/src/java/org/apache/fop/complexscripts/fonts/IncompatibleSubtableException.java index 0ad8fc105..e3e78307d 100644 --- a/src/java/org/apache/fop/complexscripts/fonts/IncompatibleSubtableException.java +++ b/src/java/org/apache/fop/complexscripts/fonts/IncompatibleSubtableException.java @@ -20,9 +20,10 @@ 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 { /** diff --git a/src/java/org/apache/fop/complexscripts/fonts/OTFAdvancedTypographicTableReader.java b/src/java/org/apache/fop/complexscripts/fonts/OTFAdvancedTypographicTableReader.java index dc5da80f8..a9110d378 100644 --- a/src/java/org/apache/fop/complexscripts/fonts/OTFAdvancedTypographicTableReader.java +++ b/src/java/org/apache/fop/complexscripts/fonts/OTFAdvancedTypographicTableReader.java @@ -39,10 +39,10 @@ import org.apache.fop.fonts.truetype.TTFFile; // 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 { diff --git a/src/java/org/apache/fop/complexscripts/fonts/Positionable.java b/src/java/org/apache/fop/complexscripts/fonts/Positionable.java index ce2da38c6..b566631dc 100644 --- a/src/java/org/apache/fop/complexscripts/fonts/Positionable.java +++ b/src/java/org/apache/fop/complexscripts/fonts/Positionable.java @@ -22,9 +22,10 @@ package org.apache.fop.complexscripts.fonts; // 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 { diff --git a/src/java/org/apache/fop/complexscripts/fonts/Substitutable.java b/src/java/org/apache/fop/complexscripts/fonts/Substitutable.java index 1ff970a5e..426ea1627 100644 --- a/src/java/org/apache/fop/complexscripts/fonts/Substitutable.java +++ b/src/java/org/apache/fop/complexscripts/fonts/Substitutable.java @@ -22,9 +22,10 @@ package org.apache.fop.complexscripts.fonts; // 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 { diff --git a/src/java/org/apache/fop/complexscripts/scripts/ArabicScriptProcessor.java b/src/java/org/apache/fop/complexscripts/scripts/ArabicScriptProcessor.java index 503ee2705..ef3c9f43a 100644 --- a/src/java/org/apache/fop/complexscripts/scripts/ArabicScriptProcessor.java +++ b/src/java/org/apache/fop/complexscripts/scripts/ArabicScriptProcessor.java @@ -42,7 +42,8 @@ import org.apache.fop.complexscripts.util.ScriptContextTester; /** * <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 { diff --git a/src/java/org/apache/fop/complexscripts/scripts/DefaultScriptProcessor.java b/src/java/org/apache/fop/complexscripts/scripts/DefaultScriptProcessor.java index 3a704e4b3..09a71db6a 100644 --- a/src/java/org/apache/fop/complexscripts/scripts/DefaultScriptProcessor.java +++ b/src/java/org/apache/fop/complexscripts/scripts/DefaultScriptProcessor.java @@ -26,10 +26,10 @@ import org.apache.fop.complexscripts.util.ScriptContextTester; // 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 { diff --git a/src/java/org/apache/fop/complexscripts/scripts/DevanagariScriptProcessor.java b/src/java/org/apache/fop/complexscripts/scripts/DevanagariScriptProcessor.java index 624c5b153..be8488baf 100644 --- a/src/java/org/apache/fop/complexscripts/scripts/DevanagariScriptProcessor.java +++ b/src/java/org/apache/fop/complexscripts/scripts/DevanagariScriptProcessor.java @@ -34,7 +34,8 @@ import org.apache.fop.complexscripts.util.GlyphSequence; /** * <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 { diff --git a/src/java/org/apache/fop/complexscripts/scripts/GujaratiScriptProcessor.java b/src/java/org/apache/fop/complexscripts/scripts/GujaratiScriptProcessor.java index fd68d4b7c..480f45f87 100644 --- a/src/java/org/apache/fop/complexscripts/scripts/GujaratiScriptProcessor.java +++ b/src/java/org/apache/fop/complexscripts/scripts/GujaratiScriptProcessor.java @@ -34,7 +34,8 @@ import org.apache.fop.complexscripts.util.GlyphSequence; /** * <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 { diff --git a/src/java/org/apache/fop/complexscripts/scripts/GurmukhiScriptProcessor.java b/src/java/org/apache/fop/complexscripts/scripts/GurmukhiScriptProcessor.java index efe8791b9..5fd84bfce 100644 --- a/src/java/org/apache/fop/complexscripts/scripts/GurmukhiScriptProcessor.java +++ b/src/java/org/apache/fop/complexscripts/scripts/GurmukhiScriptProcessor.java @@ -35,7 +35,8 @@ import org.apache.fop.complexscripts.util.GlyphSequence; /** * <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 { diff --git a/src/java/org/apache/fop/complexscripts/scripts/IndicScriptProcessor.java b/src/java/org/apache/fop/complexscripts/scripts/IndicScriptProcessor.java index 92ed31501..ce4585828 100644 --- a/src/java/org/apache/fop/complexscripts/scripts/IndicScriptProcessor.java +++ b/src/java/org/apache/fop/complexscripts/scripts/IndicScriptProcessor.java @@ -49,7 +49,8 @@ import org.apache.fop.complexscripts.util.ScriptContextTester; /** * <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 { diff --git a/src/java/org/apache/fop/complexscripts/scripts/ScriptProcessor.java b/src/java/org/apache/fop/complexscripts/scripts/ScriptProcessor.java index 4f6feffee..e9397a710 100644 --- a/src/java/org/apache/fop/complexscripts/scripts/ScriptProcessor.java +++ b/src/java/org/apache/fop/complexscripts/scripts/ScriptProcessor.java @@ -35,9 +35,10 @@ import org.apache.fop.complexscripts.util.ScriptContextTester; // 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 { diff --git a/src/java/org/apache/fop/complexscripts/util/CharMirror.java b/src/java/org/apache/fop/complexscripts/util/CharMirror.java index bb1d1587f..2490b750c 100644 --- a/src/java/org/apache/fop/complexscripts/util/CharMirror.java +++ b/src/java/org/apache/fop/complexscripts/util/CharMirror.java @@ -22,8 +22,9 @@ package org.apache.fop.complexscripts.util; 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 { diff --git a/src/java/org/apache/fop/complexscripts/util/CharScript.java b/src/java/org/apache/fop/complexscripts/util/CharScript.java index b52c5a806..d85985b17 100644 --- a/src/java/org/apache/fop/complexscripts/util/CharScript.java +++ b/src/java/org/apache/fop/complexscripts/util/CharScript.java @@ -35,8 +35,9 @@ import org.apache.fop.util.CharUtilities; // 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 { diff --git a/src/java/org/apache/fop/complexscripts/util/DiscontinuousAssociationException.java b/src/java/org/apache/fop/complexscripts/util/DiscontinuousAssociationException.java index daade8ca6..1c8310398 100644 --- a/src/java/org/apache/fop/complexscripts/util/DiscontinuousAssociationException.java +++ b/src/java/org/apache/fop/complexscripts/util/DiscontinuousAssociationException.java @@ -20,9 +20,10 @@ 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 { /** diff --git a/src/java/org/apache/fop/complexscripts/util/GlyphContextTester.java b/src/java/org/apache/fop/complexscripts/util/GlyphContextTester.java index 6bdeb2298..77c154777 100644 --- a/src/java/org/apache/fop/complexscripts/util/GlyphContextTester.java +++ b/src/java/org/apache/fop/complexscripts/util/GlyphContextTester.java @@ -22,8 +22,9 @@ package org.apache.fop.complexscripts.util; // 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 { diff --git a/src/java/org/apache/fop/complexscripts/util/GlyphSequence.java b/src/java/org/apache/fop/complexscripts/util/GlyphSequence.java index 1f52be954..f23850443 100644 --- a/src/java/org/apache/fop/complexscripts/util/GlyphSequence.java +++ b/src/java/org/apache/fop/complexscripts/util/GlyphSequence.java @@ -32,12 +32,13 @@ import java.util.Map; // 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 { diff --git a/src/java/org/apache/fop/complexscripts/util/GlyphTester.java b/src/java/org/apache/fop/complexscripts/util/GlyphTester.java index 48d0444a0..94a7c3384 100644 --- a/src/java/org/apache/fop/complexscripts/util/GlyphTester.java +++ b/src/java/org/apache/fop/complexscripts/util/GlyphTester.java @@ -20,8 +20,9 @@ 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 { diff --git a/src/java/org/apache/fop/complexscripts/util/NumberConverter.java b/src/java/org/apache/fop/complexscripts/util/NumberConverter.java index 27cefa553..24dbacefe 100644 --- a/src/java/org/apache/fop/complexscripts/util/NumberConverter.java +++ b/src/java/org/apache/fop/complexscripts/util/NumberConverter.java @@ -28,18 +28,18 @@ import java.util.List; // 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> @@ -47,7 +47,7 @@ import java.util.List; * <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[] @@ -61,7 +61,7 @@ import java.util.List; * selects female ordinals.</li> * </ul> * - * @author Glenn Adams + * <p>This work was originally authored by Glenn Adams (gadams@apache.org).</p> */ public class NumberConverter { diff --git a/src/java/org/apache/fop/complexscripts/util/ScriptContextTester.java b/src/java/org/apache/fop/complexscripts/util/ScriptContextTester.java index 3f68b00e2..2170eac73 100644 --- a/src/java/org/apache/fop/complexscripts/util/ScriptContextTester.java +++ b/src/java/org/apache/fop/complexscripts/util/ScriptContextTester.java @@ -20,8 +20,9 @@ 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 { diff --git a/src/java/org/apache/fop/complexscripts/util/UTF32.java b/src/java/org/apache/fop/complexscripts/util/UTF32.java index 44f1a48d1..c455ff474 100644 --- a/src/java/org/apache/fop/complexscripts/util/UTF32.java +++ b/src/java/org/apache/fop/complexscripts/util/UTF32.java @@ -24,8 +24,9 @@ import org.apache.fop.util.CharUtilities; // 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 { diff --git a/src/java/org/apache/fop/fo/pagination/PageNumberGenerator.java b/src/java/org/apache/fop/fo/pagination/PageNumberGenerator.java index ebd1919c4..ddc03ff53 100644 --- a/src/java/org/apache/fop/fo/pagination/PageNumberGenerator.java +++ b/src/java/org/apache/fop/fo/pagination/PageNumberGenerator.java @@ -24,14 +24,15 @@ import org.apache.fop.complexscripts.util.NumberConverter; // 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 { diff --git a/src/java/org/apache/fop/fo/properties/DimensionPropertyMaker.java b/src/java/org/apache/fop/fo/properties/DimensionPropertyMaker.java index 13efa6f30..60c069004 100644 --- a/src/java/org/apache/fop/fo/properties/DimensionPropertyMaker.java +++ b/src/java/org/apache/fop/fo/properties/DimensionPropertyMaker.java @@ -24,10 +24,7 @@ import org.apache.fop.fo.PropertyList; 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 { diff --git a/src/java/org/apache/fop/hyphenation/ByteVector.java b/src/java/org/apache/fop/hyphenation/ByteVector.java index 0df1bd925..dde7f2847 100644 --- a/src/java/org/apache/fop/hyphenation/ByteVector.java +++ b/src/java/org/apache/fop/hyphenation/ByteVector.java @@ -22,10 +22,10 @@ package org.apache.fop.hyphenation; 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 { diff --git a/src/java/org/apache/fop/hyphenation/CharVector.java b/src/java/org/apache/fop/hyphenation/CharVector.java index 97a63392e..e957be87e 100644 --- a/src/java/org/apache/fop/hyphenation/CharVector.java +++ b/src/java/org/apache/fop/hyphenation/CharVector.java @@ -22,10 +22,10 @@ package org.apache.fop.hyphenation; 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 { diff --git a/src/java/org/apache/fop/hyphenation/Hyphen.java b/src/java/org/apache/fop/hyphenation/Hyphen.java index ae33ec616..50a9b57e1 100644 --- a/src/java/org/apache/fop/hyphenation/Hyphen.java +++ b/src/java/org/apache/fop/hyphenation/Hyphen.java @@ -22,16 +22,16 @@ package org.apache.fop.hyphenation; 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> */ /** diff --git a/src/java/org/apache/fop/hyphenation/Hyphenation.java b/src/java/org/apache/fop/hyphenation/Hyphenation.java index b1e2f1cde..9b4a33339 100644 --- a/src/java/org/apache/fop/hyphenation/Hyphenation.java +++ b/src/java/org/apache/fop/hyphenation/Hyphenation.java @@ -20,9 +20,9 @@ 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 { diff --git a/src/java/org/apache/fop/hyphenation/HyphenationException.java b/src/java/org/apache/fop/hyphenation/HyphenationException.java index 484d01cbd..5fe663191 100644 --- a/src/java/org/apache/fop/hyphenation/HyphenationException.java +++ b/src/java/org/apache/fop/hyphenation/HyphenationException.java @@ -20,8 +20,10 @@ 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 { diff --git a/src/java/org/apache/fop/hyphenation/HyphenationTree.java b/src/java/org/apache/fop/hyphenation/HyphenationTree.java index fba51fdf8..d40daa5cf 100644 --- a/src/java/org/apache/fop/hyphenation/HyphenationTree.java +++ b/src/java/org/apache/fop/hyphenation/HyphenationTree.java @@ -35,11 +35,11 @@ import java.util.HashMap; 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 { diff --git a/src/java/org/apache/fop/hyphenation/HyphenationTreeCache.java b/src/java/org/apache/fop/hyphenation/HyphenationTreeCache.java index 00a622be5..c5845977f 100644 --- a/src/java/org/apache/fop/hyphenation/HyphenationTreeCache.java +++ b/src/java/org/apache/fop/hyphenation/HyphenationTreeCache.java @@ -24,7 +24,7 @@ import java.util.Map; import java.util.Set; /** - * This is a cache for HyphenationTree instances. + * <p>This is a cache for HyphenationTree instances.</p> */ public class HyphenationTreeCache { diff --git a/src/java/org/apache/fop/hyphenation/HyphenationTreeResolver.java b/src/java/org/apache/fop/hyphenation/HyphenationTreeResolver.java index 5aec688b0..c9d9ed179 100644 --- a/src/java/org/apache/fop/hyphenation/HyphenationTreeResolver.java +++ b/src/java/org/apache/fop/hyphenation/HyphenationTreeResolver.java @@ -22,7 +22,7 @@ package org.apache.fop.hyphenation; 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 { diff --git a/src/java/org/apache/fop/hyphenation/Hyphenator.java b/src/java/org/apache/fop/hyphenation/Hyphenator.java index ba52e2baf..062b0e922 100644 --- a/src/java/org/apache/fop/hyphenation/Hyphenator.java +++ b/src/java/org/apache/fop/hyphenation/Hyphenator.java @@ -36,10 +36,10 @@ import org.apache.commons.logging.Log; 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 { diff --git a/src/java/org/apache/fop/hyphenation/PatternConsumer.java b/src/java/org/apache/fop/hyphenation/PatternConsumer.java index 5fb80dcaa..f350adcbd 100644 --- a/src/java/org/apache/fop/hyphenation/PatternConsumer.java +++ b/src/java/org/apache/fop/hyphenation/PatternConsumer.java @@ -22,10 +22,10 @@ package org.apache.fop.hyphenation; 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 { diff --git a/src/java/org/apache/fop/hyphenation/PatternParser.java b/src/java/org/apache/fop/hyphenation/PatternParser.java index c08d84660..1448e6e12 100644 --- a/src/java/org/apache/fop/hyphenation/PatternParser.java +++ b/src/java/org/apache/fop/hyphenation/PatternParser.java @@ -38,10 +38,10 @@ import org.xml.sax.XMLReader; 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 { diff --git a/src/java/org/apache/fop/hyphenation/SerializeHyphPattern.java b/src/java/org/apache/fop/hyphenation/SerializeHyphPattern.java index 067e2009e..4673a6793 100644 --- a/src/java/org/apache/fop/hyphenation/SerializeHyphPattern.java +++ b/src/java/org/apache/fop/hyphenation/SerializeHyphPattern.java @@ -25,9 +25,9 @@ import java.io.IOException; 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 { diff --git a/src/java/org/apache/fop/hyphenation/TernaryTree.java b/src/java/org/apache/fop/hyphenation/TernaryTree.java index 918a747fa..2a9b7705d 100644 --- a/src/java/org/apache/fop/hyphenation/TernaryTree.java +++ b/src/java/org/apache/fop/hyphenation/TernaryTree.java @@ -62,7 +62,7 @@ import java.util.Stack; * 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 { diff --git a/src/java/org/apache/fop/pdf/DCTFilter.java b/src/java/org/apache/fop/pdf/DCTFilter.java index 183f2a694..c25227d3a 100644 --- a/src/java/org/apache/fop/pdf/DCTFilter.java +++ b/src/java/org/apache/fop/pdf/DCTFilter.java @@ -20,12 +20,12 @@ 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 { diff --git a/src/java/org/apache/fop/pdf/PDFFilter.java b/src/java/org/apache/fop/pdf/PDFFilter.java index 191e9bc66..7a02ccb68 100644 --- a/src/java/org/apache/fop/pdf/PDFFilter.java +++ b/src/java/org/apache/fop/pdf/PDFFilter.java @@ -23,11 +23,11 @@ import java.io.IOException; 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 { /* diff --git a/src/java/org/apache/fop/pdf/PDFFilterException.java b/src/java/org/apache/fop/pdf/PDFFilterException.java index 4d98584cd..c1da10398 100644 --- a/src/java/org/apache/fop/pdf/PDFFilterException.java +++ b/src/java/org/apache/fop/pdf/PDFFilterException.java @@ -20,10 +20,10 @@ 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 { /** diff --git a/src/java/org/apache/fop/pdf/PDFOutline.java b/src/java/org/apache/fop/pdf/PDFOutline.java index 57e210a7a..66116c681 100644 --- a/src/java/org/apache/fop/pdf/PDFOutline.java +++ b/src/java/org/apache/fop/pdf/PDFOutline.java @@ -24,12 +24,11 @@ import java.io.IOException; 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 { diff --git a/src/java/org/apache/fop/render/ps/AbstractPSTranscoder.java b/src/java/org/apache/fop/render/ps/AbstractPSTranscoder.java index ad5090686..3cda75fac 100644 --- a/src/java/org/apache/fop/render/ps/AbstractPSTranscoder.java +++ b/src/java/org/apache/fop/render/ps/AbstractPSTranscoder.java @@ -42,7 +42,7 @@ import org.apache.fop.svg.AbstractFOPTranscoder; 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 @@ -65,8 +65,7 @@ import org.apache.fop.svg.PDFDocumentGraphics2DConfigurator; * 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 { diff --git a/src/java/org/apache/fop/render/ps/EPSTranscoder.java b/src/java/org/apache/fop/render/ps/EPSTranscoder.java index 6e20b3852..79856b835 100644 --- a/src/java/org/apache/fop/render/ps/EPSTranscoder.java +++ b/src/java/org/apache/fop/render/ps/EPSTranscoder.java @@ -23,7 +23,7 @@ import org.apache.xmlgraphics.java2d.ps.AbstractPSDocumentGraphics2D; 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 @@ -46,8 +46,7 @@ import org.apache.xmlgraphics.java2d.ps.EPSDocumentGraphics2D; * 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 { diff --git a/src/java/org/apache/fop/render/ps/PSTextElementBridge.java b/src/java/org/apache/fop/render/ps/PSTextElementBridge.java index 524fbdad8..c5240dff2 100644 --- a/src/java/org/apache/fop/render/ps/PSTextElementBridge.java +++ b/src/java/org/apache/fop/render/ps/PSTextElementBridge.java @@ -28,12 +28,9 @@ import org.apache.batik.gvt.TextNode; 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 { @@ -65,4 +62,3 @@ public class PSTextElementBridge extends SVGTextElementBridge { } } - diff --git a/src/java/org/apache/fop/render/ps/PSTranscoder.java b/src/java/org/apache/fop/render/ps/PSTranscoder.java index 6a7431aad..aeaa74714 100644 --- a/src/java/org/apache/fop/render/ps/PSTranscoder.java +++ b/src/java/org/apache/fop/render/ps/PSTranscoder.java @@ -23,7 +23,7 @@ import org.apache.xmlgraphics.java2d.ps.AbstractPSDocumentGraphics2D; 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 @@ -46,8 +46,7 @@ import org.apache.xmlgraphics.java2d.ps.PSDocumentGraphics2D; * 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 { diff --git a/src/java/org/apache/fop/render/rtf/FoUnitsConverter.java b/src/java/org/apache/fop/render/rtf/FoUnitsConverter.java index 647b3f53b..66c3b01ab 100644 --- a/src/java/org/apache/fop/render/rtf/FoUnitsConverter.java +++ b/src/java/org/apache/fop/render/rtf/FoUnitsConverter.java @@ -28,14 +28,10 @@ import org.apache.fop.apps.FOPException; 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 { diff --git a/src/java/org/apache/fop/render/rtf/PageAttributesConverter.java b/src/java/org/apache/fop/render/rtf/PageAttributesConverter.java index d50a81656..360e5c1df 100644 --- a/src/java/org/apache/fop/render/rtf/PageAttributesConverter.java +++ b/src/java/org/apache/fop/render/rtf/PageAttributesConverter.java @@ -33,9 +33,11 @@ import org.apache.fop.render.rtf.rtflib.rtfdoc.RtfAttributes; 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 { diff --git a/src/java/org/apache/fop/render/rtf/TableAttributesConverter.java b/src/java/org/apache/fop/render/rtf/TableAttributesConverter.java index a9be38d16..78a8bcf12 100644 --- a/src/java/org/apache/fop/render/rtf/TableAttributesConverter.java +++ b/src/java/org/apache/fop/render/rtf/TableAttributesConverter.java @@ -33,11 +33,12 @@ import org.apache.fop.render.rtf.rtflib.rtfdoc.ITableAttributes; 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. diff --git a/src/java/org/apache/fop/render/rtf/TextAttributesConverter.java b/src/java/org/apache/fop/render/rtf/TextAttributesConverter.java index d377f740d..8537d4559 100644 --- a/src/java/org/apache/fop/render/rtf/TextAttributesConverter.java +++ b/src/java/org/apache/fop/render/rtf/TextAttributesConverter.java @@ -48,14 +48,15 @@ import org.apache.fop.render.rtf.rtflib.rtfdoc.RtfFontManager; 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 { diff --git a/src/java/org/apache/fop/render/rtf/rtflib/exceptions/RtfException.java b/src/java/org/apache/fop/render/rtf/rtflib/exceptions/RtfException.java index 71bc9ed88..cb82168a3 100644 --- a/src/java/org/apache/fop/render/rtf/rtflib/exceptions/RtfException.java +++ b/src/java/org/apache/fop/render/rtf/rtflib/exceptions/RtfException.java @@ -26,8 +26,10 @@ package org.apache.fop.render.rtf.rtflib.exceptions; * 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 { /** diff --git a/src/java/org/apache/fop/render/rtf/rtflib/exceptions/RtfStructureException.java b/src/java/org/apache/fop/render/rtf/rtflib/exceptions/RtfStructureException.java index 7b8a22df2..6a42c7cc7 100644 --- a/src/java/org/apache/fop/render/rtf/rtflib/exceptions/RtfStructureException.java +++ b/src/java/org/apache/fop/render/rtf/rtflib/exceptions/RtfStructureException.java @@ -26,8 +26,10 @@ package org.apache.fop.render.rtf.rtflib.exceptions; * 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 { diff --git a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfBookmarkContainer.java b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfBookmarkContainer.java index 957ce62f6..d55d78487 100644 --- a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfBookmarkContainer.java +++ b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfBookmarkContainer.java @@ -29,8 +29,9 @@ package org.apache.fop.render.rtf.rtflib.rtfdoc; 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 { diff --git a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfHyperLinkContainer.java b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfHyperLinkContainer.java index 194d25653..34fd8784c 100644 --- a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfHyperLinkContainer.java +++ b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfHyperLinkContainer.java @@ -28,8 +28,10 @@ package org.apache.fop.render.rtf.rtflib.rtfdoc; 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 { /** diff --git a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfListContainer.java b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfListContainer.java index 890e00760..f9c1a08c1 100644 --- a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfListContainer.java +++ b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfListContainer.java @@ -28,8 +28,10 @@ package org.apache.fop.render.rtf.rtflib.rtfdoc; 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 { diff --git a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfPageBreakContainer.java b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfPageBreakContainer.java index d30bbb173..fe4321d8f 100644 --- a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfPageBreakContainer.java +++ b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfPageBreakContainer.java @@ -28,8 +28,10 @@ package org.apache.fop.render.rtf.rtflib.rtfdoc; 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 { diff --git a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfPageContainer.java b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfPageContainer.java index 299ff2169..92a71218f 100644 --- a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfPageContainer.java +++ b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfPageContainer.java @@ -28,8 +28,10 @@ package org.apache.fop.render.rtf.rtflib.rtfdoc; 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 { diff --git a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfParagraphContainer.java b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfParagraphContainer.java index f940d9dec..4c1c5b7ee 100644 --- a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfParagraphContainer.java +++ b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfParagraphContainer.java @@ -28,8 +28,10 @@ package org.apache.fop.render.rtf.rtflib.rtfdoc; 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 { diff --git a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfTableContainer.java b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfTableContainer.java index afa62807f..635177727 100644 --- a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfTableContainer.java +++ b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfTableContainer.java @@ -29,9 +29,10 @@ package org.apache.fop.render.rtf.rtflib.rtfdoc; 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 { /** diff --git a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfTextContainer.java b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfTextContainer.java index 0522cdf10..5d0ab30d8 100644 --- a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfTextContainer.java +++ b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfTextContainer.java @@ -28,8 +28,10 @@ package org.apache.fop.render.rtf.rtflib.rtfdoc; 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 { diff --git a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfTextrunContainer.java b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfTextrunContainer.java index e9c7307a2..f9164bce2 100644 --- a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfTextrunContainer.java +++ b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/IRtfTextrunContainer.java @@ -25,8 +25,10 @@ package org.apache.fop.render.rtf.rtflib.rtfdoc; 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 { diff --git a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/ITableAttributes.java b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/ITableAttributes.java index 87f7fe520..e0639f6e5 100644 --- a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/ITableAttributes.java +++ b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/ITableAttributes.java @@ -30,10 +30,9 @@ package org.apache.fop.render.rtf.rtflib.rtfdoc; */ /** - * 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 */ diff --git a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/ITableColumnsInfo.java b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/ITableColumnsInfo.java index dc0e559cc..7c420db31 100644 --- a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/ITableColumnsInfo.java +++ b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/ITableColumnsInfo.java @@ -26,8 +26,10 @@ package org.apache.fop.render.rtf.rtflib.rtfdoc; * 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 { diff --git a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfAfterBeforeBase.java b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfAfterBeforeBase.java index 6038ebfdd..d05ed8cc3 100644 --- a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfAfterBeforeBase.java +++ b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfAfterBeforeBase.java @@ -29,11 +29,13 @@ package org.apache.fop.render.rtf.rtflib.rtfdoc; 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 diff --git a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfAttributes.java b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfAttributes.java index 5ec5e907e..b5d4db114 100644 --- a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfAttributes.java +++ b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfAttributes.java @@ -33,8 +33,10 @@ import org.xml.sax.Attributes; 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 diff --git a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfBookmark.java b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfBookmark.java index 714026848..f43e3d83c 100644 --- a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfBookmark.java +++ b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfBookmark.java @@ -30,10 +30,11 @@ import java.io.IOException; 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 { ////////////////////////////////////////////////// diff --git a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfBookmarkContainerImpl.java b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfBookmarkContainerImpl.java index b8bcc5614..3fad459a3 100644 --- a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfBookmarkContainerImpl.java +++ b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfBookmarkContainerImpl.java @@ -30,10 +30,11 @@ import java.io.IOException; 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 { ////////////////////////////////////////////////// diff --git a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfColorTable.java b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfColorTable.java index 118c810e0..eff6aaba6 100644 --- a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfColorTable.java +++ b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfColorTable.java @@ -31,9 +31,10 @@ import java.util.Hashtable; 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 { diff --git a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfContainer.java b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfContainer.java index b138f722b..022f03051 100644 --- a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfContainer.java +++ b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfContainer.java @@ -34,8 +34,10 @@ import java.util.List; 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 { diff --git a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfDocumentArea.java b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfDocumentArea.java index c94f24554..598fc71ff 100644 --- a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfDocumentArea.java +++ b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfDocumentArea.java @@ -29,8 +29,10 @@ package org.apache.fop.render.rtf.rtflib.rtfdoc; 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 diff --git a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfElement.java b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfElement.java index 424fd22b1..57951110b 100644 --- a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfElement.java +++ b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfElement.java @@ -30,9 +30,11 @@ import java.io.IOException; 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 */ diff --git a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfExternalGraphic.java b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfExternalGraphic.java index e2a19389e..02a31ed35 100644 --- a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfExternalGraphic.java +++ b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfExternalGraphic.java @@ -39,23 +39,27 @@ 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 <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 { diff --git a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfExtraRowSet.java b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfExtraRowSet.java index 42888ee59..cf334f716 100644 --- a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfExtraRowSet.java +++ b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfExtraRowSet.java @@ -35,17 +35,20 @@ import java.util.List; /** - * 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 { diff --git a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfFile.java b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfFile.java index de29afd2a..ceade4ede 100644 --- a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfFile.java +++ b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfFile.java @@ -35,10 +35,11 @@ import java.io.Writer; 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 diff --git a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfFontManager.java b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfFontManager.java index 6694f0a7d..2a4131e55 100644 --- a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfFontManager.java +++ b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfFontManager.java @@ -31,8 +31,9 @@ import java.util.Hashtable; 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 { ////////////////////////////////////////////////// diff --git a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfFontTable.java b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfFontTable.java index 236919c96..0d3e8099e 100644 --- a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfFontTable.java +++ b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfFontTable.java @@ -29,9 +29,11 @@ package org.apache.fop.render.rtf.rtflib.rtfdoc; 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 { diff --git a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfFootnote.java b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfFootnote.java index 394d12680..5ecf5351c 100644 --- a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfFootnote.java +++ b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfFootnote.java @@ -22,9 +22,11 @@ package org.apache.fop.render.rtf.rtflib.rtfdoc; 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 { diff --git a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfHeader.java b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfHeader.java index b093eab49..f293d9774 100644 --- a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfHeader.java +++ b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfHeader.java @@ -32,10 +32,12 @@ import java.util.HashMap; 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 { diff --git a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfHyperLink.java b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfHyperLink.java index 6e0028b55..0ca76715b 100644 --- a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfHyperLink.java +++ b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfHyperLink.java @@ -30,11 +30,10 @@ import java.io.IOException; 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 diff --git a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfLineBreak.java b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfLineBreak.java index 2b1db99ce..84c6ee0ad 100644 --- a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfLineBreak.java +++ b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfLineBreak.java @@ -29,8 +29,10 @@ package org.apache.fop.render.rtf.rtflib.rtfdoc; 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 { diff --git a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfList.java b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfList.java index 13748a3bf..2e50e4eb4 100644 --- a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfList.java +++ b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfList.java @@ -31,10 +31,11 @@ import java.io.Writer; 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; diff --git a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfListItem.java b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfListItem.java index 13628a49d..ac1c7e46b 100644 --- a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfListItem.java +++ b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfListItem.java @@ -29,9 +29,11 @@ package org.apache.fop.render.rtf.rtflib.rtfdoc; 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, diff --git a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfListTable.java b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfListTable.java index 7bdda21a0..0e63dca25 100644 --- a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfListTable.java +++ b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfListTable.java @@ -32,10 +32,11 @@ import java.util.Iterator; 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; diff --git a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfNull.java b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfNull.java index bd44ae2ba..696bff8e2 100644 --- a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfNull.java +++ b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfNull.java @@ -30,7 +30,9 @@ import java.io.IOException; 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 { diff --git a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfOptions.java b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfOptions.java index 54cdb802a..d7d7b3fd8 100644 --- a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfOptions.java +++ b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfOptions.java @@ -27,8 +27,9 @@ package org.apache.fop.render.rtf.rtflib.rtfdoc; */ /** - * 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 { /** diff --git a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfPage.java b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfPage.java index f014186ed..11feb951c 100644 --- a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfPage.java +++ b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfPage.java @@ -29,9 +29,11 @@ package org.apache.fop.render.rtf.rtflib.rtfdoc; 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 diff --git a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfPageArea.java b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfPageArea.java index 0696a70c0..e78027623 100644 --- a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfPageArea.java +++ b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfPageArea.java @@ -30,7 +30,9 @@ import java.io.IOException; 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 { diff --git a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfPageBreak.java b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfPageBreak.java index b386c7c0f..85f53e37b 100644 --- a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfPageBreak.java +++ b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfPageBreak.java @@ -29,8 +29,10 @@ package org.apache.fop.render.rtf.rtflib.rtfdoc; 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 { diff --git a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfPageNumber.java b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfPageNumber.java index ad2984b9b..1fc3cd5c1 100644 --- a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfPageNumber.java +++ b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfPageNumber.java @@ -30,7 +30,9 @@ import java.io.IOException; 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 diff --git a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfPageNumberCitation.java b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfPageNumberCitation.java index 44c03c316..e422ba068 100644 --- a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfPageNumberCitation.java +++ b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfPageNumberCitation.java @@ -30,8 +30,10 @@ import java.io.IOException; 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 : diff --git a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfParagraph.java b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfParagraph.java index a4ad8e8f4..b4ff23b74 100644 --- a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfParagraph.java +++ b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfParagraph.java @@ -30,10 +30,12 @@ import java.io.IOException; 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 diff --git a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfSection.java b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfSection.java index 88ab8ec2d..e85da98af 100644 --- a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfSection.java +++ b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfSection.java @@ -29,8 +29,10 @@ package org.apache.fop.render.rtf.rtflib.rtfdoc; 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 diff --git a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfString.java b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfString.java index 7ef4b98b9..254864daf 100644 --- a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfString.java +++ b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfString.java @@ -29,8 +29,10 @@ package org.apache.fop.render.rtf.rtflib.rtfdoc; 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 { diff --git a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfStringConverter.java b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfStringConverter.java index d7774f2ed..bf32eceeb 100644 --- a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfStringConverter.java +++ b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfStringConverter.java @@ -31,8 +31,10 @@ import java.io.Writer; 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 { diff --git a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfStyleSheetTable.java b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfStyleSheetTable.java index 678508607..cce5e8142 100644 --- a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfStyleSheetTable.java +++ b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfStyleSheetTable.java @@ -32,9 +32,10 @@ import java.util.Iterator; 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 { ////////////////////////////////////////////////// diff --git a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfTable.java b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfTable.java index 3747103d1..9b74f5b45 100644 --- a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfTable.java +++ b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfTable.java @@ -29,8 +29,10 @@ package org.apache.fop.render.rtf.rtflib.rtfdoc; 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 { diff --git a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfTableCell.java b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfTableCell.java index da11de1bc..1e2a64b51 100644 --- a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfTableCell.java +++ b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfTableCell.java @@ -30,8 +30,10 @@ import java.io.IOException; 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 diff --git a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfTableRow.java b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfTableRow.java index f5e5978ec..74634da7f 100644 --- a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfTableRow.java +++ b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfTableRow.java @@ -30,10 +30,12 @@ import java.io.IOException; 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 { diff --git a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfText.java b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfText.java index f7c08d628..4df178af1 100644 --- a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfText.java +++ b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfText.java @@ -29,8 +29,10 @@ package org.apache.fop.render.rtf.rtflib.rtfdoc; 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 { diff --git a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfTextrun.java b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfTextrun.java index 95e7ff3e5..9a407fe30 100644 --- a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfTextrun.java +++ b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/RtfTextrun.java @@ -31,9 +31,10 @@ import org.apache.commons.logging.Log; 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 { diff --git a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/WhitespaceCollapser.java b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/WhitespaceCollapser.java index 723b4fb00..abe903a73 100644 --- a/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/WhitespaceCollapser.java +++ b/src/java/org/apache/fop/render/rtf/rtflib/rtfdoc/WhitespaceCollapser.java @@ -29,8 +29,10 @@ package org.apache.fop.render.rtf.rtflib.rtfdoc; 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 { diff --git a/src/java/org/apache/fop/render/rtf/rtflib/tools/BuilderContext.java b/src/java/org/apache/fop/render/rtf/rtflib/tools/BuilderContext.java index 1591bbe26..f0a29a0ab 100644 --- a/src/java/org/apache/fop/render/rtf/rtflib/tools/BuilderContext.java +++ b/src/java/org/apache/fop/render/rtf/rtflib/tools/BuilderContext.java @@ -26,14 +26,15 @@ import org.apache.fop.render.rtf.rtflib.rtfdoc.IRtfOptions; 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 { diff --git a/src/java/org/apache/fop/render/rtf/rtflib/tools/ImageConstants.java b/src/java/org/apache/fop/render/rtf/rtflib/tools/ImageConstants.java index c3dadb652..7f65f9c10 100644 --- a/src/java/org/apache/fop/render/rtf/rtflib/tools/ImageConstants.java +++ b/src/java/org/apache/fop/render/rtf/rtflib/tools/ImageConstants.java @@ -26,9 +26,11 @@ package org.apache.fop.render.rtf.rtflib.tools; * 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 { diff --git a/src/java/org/apache/fop/render/rtf/rtflib/tools/ImageUtil.java b/src/java/org/apache/fop/render/rtf/rtflib/tools/ImageUtil.java index 82367e0ad..8e9c1a1be 100644 --- a/src/java/org/apache/fop/render/rtf/rtflib/tools/ImageUtil.java +++ b/src/java/org/apache/fop/render/rtf/rtflib/tools/ImageUtil.java @@ -26,9 +26,11 @@ package org.apache.fop.render.rtf.rtflib.tools; * 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 { diff --git a/src/java/org/apache/fop/render/rtf/rtflib/tools/PercentContext.java b/src/java/org/apache/fop/render/rtf/rtflib/tools/PercentContext.java index ef9b248f1..7e2633409 100644 --- a/src/java/org/apache/fop/render/rtf/rtflib/tools/PercentContext.java +++ b/src/java/org/apache/fop/render/rtf/rtflib/tools/PercentContext.java @@ -32,7 +32,7 @@ import org.apache.fop.fo.flow.table.Table; 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); diff --git a/src/java/org/apache/fop/render/rtf/rtflib/tools/TableContext.java b/src/java/org/apache/fop/render/rtf/rtflib/tools/TableContext.java index 3cdd454f5..5fa53d750 100644 --- a/src/java/org/apache/fop/render/rtf/rtflib/tools/TableContext.java +++ b/src/java/org/apache/fop/render/rtf/rtflib/tools/TableContext.java @@ -28,13 +28,13 @@ import org.apache.fop.render.rtf.rtflib.rtfdoc.ITableColumnsInfo; 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. diff --git a/src/java/org/apache/fop/render/txt/TXTRenderer.java b/src/java/org/apache/fop/render/txt/TXTRenderer.java index d20ca3bed..6c58561a8 100644 --- a/src/java/org/apache/fop/render/txt/TXTRenderer.java +++ b/src/java/org/apache/fop/render/txt/TXTRenderer.java @@ -43,11 +43,10 @@ import org.apache.fop.render.txt.border.AbstractBorderElement; 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 { diff --git a/src/java/org/apache/fop/servlet/FopPrintServlet.java b/src/java/org/apache/fop/servlet/FopPrintServlet.java index 3972b6fec..0fe77142f 100644 --- a/src/java/org/apache/fop/servlet/FopPrintServlet.java +++ b/src/java/org/apache/fop/servlet/FopPrintServlet.java @@ -55,9 +55,6 @@ import org.apache.fop.apps.MimeConstants; * <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 { diff --git a/src/java/org/apache/fop/servlet/FopServlet.java b/src/java/org/apache/fop/servlet/FopServlet.java index 7eb8a2f89..cfe7f6cbf 100644 --- a/src/java/org/apache/fop/servlet/FopServlet.java +++ b/src/java/org/apache/fop/servlet/FopServlet.java @@ -63,9 +63,6 @@ import org.apache.fop.apps.MimeConstants; * <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 { diff --git a/src/java/org/apache/fop/svg/AbstractFOPImageElementBridge.java b/src/java/org/apache/fop/svg/AbstractFOPImageElementBridge.java index b7e82b858..399d1d8bd 100644 --- a/src/java/org/apache/fop/svg/AbstractFOPImageElementBridge.java +++ b/src/java/org/apache/fop/svg/AbstractFOPImageElementBridge.java @@ -47,9 +47,9 @@ import org.apache.xmlgraphics.java2d.Graphics2DImagePainter; 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 { diff --git a/src/java/org/apache/fop/svg/AbstractFOPTextElementBridge.java b/src/java/org/apache/fop/svg/AbstractFOPTextElementBridge.java index aec4126b4..6efa31e45 100644 --- a/src/java/org/apache/fop/svg/AbstractFOPTextElementBridge.java +++ b/src/java/org/apache/fop/svg/AbstractFOPTextElementBridge.java @@ -28,11 +28,11 @@ import org.apache.batik.gvt.TextNode; 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 { diff --git a/src/java/org/apache/fop/svg/PDFAElementBridge.java b/src/java/org/apache/fop/svg/PDFAElementBridge.java index eed567447..cd70bed34 100644 --- a/src/java/org/apache/fop/svg/PDFAElementBridge.java +++ b/src/java/org/apache/fop/svg/PDFAElementBridge.java @@ -29,9 +29,9 @@ import org.apache.batik.bridge.BridgeContext; 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; diff --git a/src/java/org/apache/fop/svg/PDFANode.java b/src/java/org/apache/fop/svg/PDFANode.java index 8fadc11e2..005a34a71 100644 --- a/src/java/org/apache/fop/svg/PDFANode.java +++ b/src/java/org/apache/fop/svg/PDFANode.java @@ -28,9 +28,9 @@ import java.util.StringTokenizer; 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; diff --git a/src/java/org/apache/fop/svg/PDFGraphics2D.java b/src/java/org/apache/fop/svg/PDFGraphics2D.java index 018653dbb..ef81180ce 100644 --- a/src/java/org/apache/fop/svg/PDFGraphics2D.java +++ b/src/java/org/apache/fop/svg/PDFGraphics2D.java @@ -95,12 +95,12 @@ import org.apache.fop.render.pdf.ImageRawJPEGAdapter; 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 { diff --git a/src/java/org/apache/fop/svg/PDFImageElementBridge.java b/src/java/org/apache/fop/svg/PDFImageElementBridge.java index 4e5983e64..0cc14b7e3 100644 --- a/src/java/org/apache/fop/svg/PDFImageElementBridge.java +++ b/src/java/org/apache/fop/svg/PDFImageElementBridge.java @@ -24,9 +24,9 @@ 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. + * <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 { diff --git a/src/java/org/apache/fop/svg/PDFTextElementBridge.java b/src/java/org/apache/fop/svg/PDFTextElementBridge.java index c983d2b45..339bb36f3 100644 --- a/src/java/org/apache/fop/svg/PDFTextElementBridge.java +++ b/src/java/org/apache/fop/svg/PDFTextElementBridge.java @@ -22,11 +22,11 @@ package org.apache.fop.svg; 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 { diff --git a/src/java/org/apache/fop/svg/PDFTranscoder.java b/src/java/org/apache/fop/svg/PDFTranscoder.java index 04b1b5497..e222a08dd 100644 --- a/src/java/org/apache/fop/svg/PDFTranscoder.java +++ b/src/java/org/apache/fop/svg/PDFTranscoder.java @@ -41,7 +41,7 @@ import org.apache.fop.Version; 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 @@ -70,8 +70,7 @@ import org.apache.fop.fonts.FontInfo; * 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 { diff --git a/src/java/org/apache/fop/util/CharUtilities.java b/src/java/org/apache/fop/util/CharUtilities.java index 8b90e3d25..04390d938 100644 --- a/src/java/org/apache/fop/util/CharUtilities.java +++ b/src/java/org/apache/fop/util/CharUtilities.java @@ -279,7 +279,6 @@ public class CharUtilities { * @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(); @@ -310,7 +309,6 @@ public class CharUtilities { * @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(); @@ -326,7 +324,6 @@ public class CharUtilities { * 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 ) { @@ -341,7 +338,6 @@ public class CharUtilities { * @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; |