Improving Javadoc

git-svn-id: https://svn.apache.org/repos/asf/commons/proper/lang/trunk@795891 13f79535-47bb-0310-9956-ffa450edef68

src/java/org/apache/commons/lang/text/translate/AggregateTranslator.java

@@ -30,6 +30,8 @@ public class AggregateTranslator extends CharSequenceTranslator {
 
     /**
      * Specify the translators to be used at creation time. 
+     *
+     * @param translators CharSequenceTranslator array to aggregate
      */
     public AggregateTranslator(CharSequenceTranslator... translators) {
         this.translators = translators;

src/java/org/apache/commons/lang/text/translate/CharSequenceTranslator.java

@@ -41,6 +41,7 @@ public abstract class CharSequenceTranslator {
      * @param index int representing the current point of translation
      * @param out Writer to translate the text to
      * @return int count of codepoints consumed
+     * @throws IOException if and only if the Writer produces an IOException
      */
     public abstract int translate(CharSequence input, int index, Writer out) throws IOException;
 
@@ -106,6 +107,9 @@ public abstract class CharSequenceTranslator {
     /**
      * Helper method to create a merger of this translator with another set of 
      * translators. Useful in customizing the standard functionality.
+     *
+     * @param translators CharSequenceTranslator array of translators to merge with this one
+     * @return CharSequenceTranslator merging this translator with the others
      */
     public final CharSequenceTranslator with(CharSequenceTranslator... translators) {
         CharSequenceTranslator[] newArray = new CharSequenceTranslator[translators.length + 1];

src/java/org/apache/commons/lang/text/translate/CodePointTranslator.java

@@ -46,6 +46,7 @@ public abstract class CodePointTranslator extends CharSequenceTranslator {
      * @param codepoint int character input to translate
      * @param out Writer to optionally push the translated output to
      * @return boolean as to whether translation occurred or not
+     * @throws IOException if and only if the Writer produces an IOException
      */
     public abstract boolean translate(int codepoint, Writer out) throws IOException;
 

src/java/org/apache/commons/lang/text/translate/LookupTranslator.java

@@ -34,7 +34,7 @@ public class LookupTranslator extends CharSequenceTranslator {
     /**
      * Define the lookup table to be used in translation
      *
-     * @param CharSequence[][] Lookup table of size [*][2]
+     * @param lookup CharSequence[][] table of size [*][2]
      */
     public LookupTranslator(CharSequence[][] lookup) {
         lookupMap = new HashMap<CharSequence, CharSequence>();