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

24 files changed, 92 insertions, 69 deletions

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 {