Apply patch from [CODEC-128] Documentation spelling fixes. https://issues.apache.org/jira/secure/attachment/12494312/codec-spelling.patch

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

Author: garydgregory

src/java/org/apache/commons/codec/CharEncoding.java

@@ -45,7 +45,7 @@
  * </ul>
  * 
  * This perhaps would best belong in the [lang] project. Even if a similar interface is defined in [lang], it is not
- * forseen that [codec] would be made to depend on [lang].
+ * foreseen that [codec] would be made to depend on [lang].
  * 
  * @see <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/nio/charset/Charset.html">Standard charsets</a>
  * @author Apache Software Foundation

src/java/org/apache/commons/codec/Encoder.java

@@ -33,7 +33,7 @@ public interface Encoder {
      * as an Object.  The Objects here may just be <code>byte[]</code>
      * or <code>String</code>s depending on the implementation used.
      *   
-     * @param source An object ot encode
+     * @param source An object to encode
      * 
      * @return An "encoded" Object
      * 

src/java/org/apache/commons/codec/StringEncoder.java

@@ -33,7 +33,7 @@ public interface StringEncoder extends Encoder {
      * @return the encoded String
      * 
      * @throws EncoderException thrown if there is
-     *  an error conidition during the Encoding process.
+     *  an error condition during the encoding process.
      */
     String encode(String source) throws EncoderException;
 }  

src/java/org/apache/commons/codec/binary/StringUtils.java

@@ -175,7 +175,7 @@ private static IllegalStateException newIllegalStateException(String charsetName
      * @param charsetName
      *            The name of a required {@link java.nio.charset.Charset}
      * @return A new <code>String</code> decoded from the specified array of bytes using the given charset,
-     *         or <code>null</code> if the input byte arrray was <code>null</code>.
+     *         or <code>null</code> if the input byte array was <code>null</code>.
      * @throws IllegalStateException
      *             Thrown when a {@link UnsupportedEncodingException} is caught, which should never happen for a
      *             required charset name.

src/java/org/apache/commons/codec/language/ColognePhonetic.java

@@ -42,9 +42,9 @@
  * 
  * <li>
  * <h3>Step 1:</h3>
- * After preprocessing (convertion to upper case, transcription of <a
+ * After preprocessing (conversion to upper case, transcription of <a
  * href="http://en.wikipedia.org/wiki/Germanic_umlaut">germanic umlauts</a>, removal of non alphabetical characters) the
- * letters of the supplied text are replaced by their phonetic code according to the folowing table.
+ * letters of the supplied text are replaced by their phonetic code according to the following table.
  * <table border="1">
  * <tbody>
  * <tr>

src/java/org/apache/commons/codec/language/RefinedSoundex.java

@@ -163,7 +163,7 @@ char getMappingCode(char c) {
     }
 
     /**
-     * Retreives the Refined Soundex code for a given String object.
+     * Retrieves the Refined Soundex code for a given String object.
      * 
      * @param str
      *                  String to encode using the Refined Soundex algorithm

src/java/org/apache/commons/codec/net/QCodec.java

@@ -294,7 +294,7 @@ public String getDefaultCharset() {
     }
 
     /**
-     * Tests if optional tranformation of SPACE characters is to be used
+     * Tests if optional transformation of SPACE characters is to be used
      * 
      * @return <code>true</code> if SPACE characters are to be transformed, <code>false</code> otherwise
      */
@@ -303,7 +303,7 @@ public boolean isEncodeBlanks() {
     }
 
     /**
-     * Defines whether optional tranformation of SPACE characters is to be used
+     * Defines whether optional transformation of SPACE characters is to be used
      * 
      * @param b
      *                  <code>true</code> if SPACE characters are to be transformed, <code>false</code> otherwise

src/java/org/apache/commons/codec/net/RFC1522Codec.java

@@ -65,14 +65,14 @@ abstract class RFC1522Codec {
      * Applies an RFC 1522 compliant encoding scheme to the given string of text with the 
      * given charset. This method constructs the "encoded-word" header common to all the 
      * RFC 1522 codecs and then invokes {@link #doEncoding(byte [])} method of a concrete 
-     * class to perform the specific enconding.
+     * class to perform the specific encoding.
      * 
      * @param text a string to encode
      * @param charset a charset to be used
      * 
      * @return RFC 1522 compliant "encoded-word"
      * 
-     * @throws EncoderException thrown if there is an error conidition during the Encoding 
+     * @throws EncoderException thrown if there is an error condition during the Encoding 
      *  process.
      * @throws UnsupportedEncodingException thrown if charset is not supported 
      * 
@@ -99,12 +99,12 @@ protected String encodeText(final String text, final String charset)
     /**
      * Applies an RFC 1522 compliant decoding scheme to the given string of text. This method 
      * processes the "encoded-word" header common to all the RFC 1522 codecs and then invokes 
-     * {@link #doEncoding(byte [])} method of a concrete class to perform the specific deconding.
+     * {@link #doEncoding(byte [])} method of a concrete class to perform the specific decoding.
      * 
      * @param text a string to decode
      * @return A new decoded String or <code>null</code> if the input is <code>null</code>.
      * 
-     * @throws DecoderException thrown if there is an error conidition during the Decoding 
+     * @throws DecoderException thrown if there is an error condition during the decoding 
      *  process.
      * @throws UnsupportedEncodingException thrown if charset specified in the "encoded-word" 
      *  header is not supported 

src/java/org/apache/commons/codec/package.html

@@ -50,7 +50,7 @@ <h4><a name="Common Encoders">Binary Encoders</a></h4>
           </td>
           <td> 
             Converts an array of bytes into an array of characters
-            representing the hexidecimal values of each byte in order 
+            representing the hexadecimal values of each byte in order 
           </td>
           <td>Production</td>
         </tr>