diff options
Diffstat (limited to 'src/java/org/apache/fop/hyphenation')
13 files changed, 33 insertions, 31 deletions
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 { |