Author: ggregory
Date: Tue Sep 13 21:09:09 2011
New Revision: 1170351
URL: http://svn.apache.org/viewvc?rev=1170351&view=rev
Log:
Apply patch from [CODEC-128] Documentation spelling fixes.
https://issues.apache.org/jira/secure/attachment/12494312/codec-spelling.patch
Modified:
commons/proper/codec/trunk/src/java/org/apache/commons/codec/CharEncoding.java
commons/proper/codec/trunk/src/java/org/apache/commons/codec/Encoder.java
commons/proper/codec/trunk/src/java/org/apache/commons/codec/StringEncoder.java
commons/proper/codec/trunk/src/java/org/apache/commons/codec/binary/StringUtils.java
commons/proper/codec/trunk/src/java/org/apache/commons/codec/language/ColognePhonetic.java
commons/proper/codec/trunk/src/java/org/apache/commons/codec/language/RefinedSoundex.java
commons/proper/codec/trunk/src/java/org/apache/commons/codec/net/QCodec.java
commons/proper/codec/trunk/src/java/org/apache/commons/codec/net/RFC1522Codec.java
commons/proper/codec/trunk/src/java/org/apache/commons/codec/package.html
Modified:
commons/proper/codec/trunk/src/java/org/apache/commons/codec/CharEncoding.java
URL:
http://svn.apache.org/viewvc/commons/proper/codec/trunk/src/java/org/apache/commons/codec/CharEncoding.java?rev=1170351&r1=1170350&r2=1170351&view=diff
==============================================================================
---
commons/proper/codec/trunk/src/java/org/apache/commons/codec/CharEncoding.java
(original)
+++
commons/proper/codec/trunk/src/java/org/apache/commons/codec/CharEncoding.java
Tue Sep 13 21:09:09 2011
@@ -45,7 +45,7 @@ package org.apache.commons.codec;
* </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
Modified:
commons/proper/codec/trunk/src/java/org/apache/commons/codec/Encoder.java
URL:
http://svn.apache.org/viewvc/commons/proper/codec/trunk/src/java/org/apache/commons/codec/Encoder.java?rev=1170351&r1=1170350&r2=1170351&view=diff
==============================================================================
--- commons/proper/codec/trunk/src/java/org/apache/commons/codec/Encoder.java
(original)
+++ commons/proper/codec/trunk/src/java/org/apache/commons/codec/Encoder.java
Tue Sep 13 21:09:09 2011
@@ -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
*
Modified:
commons/proper/codec/trunk/src/java/org/apache/commons/codec/StringEncoder.java
URL:
http://svn.apache.org/viewvc/commons/proper/codec/trunk/src/java/org/apache/commons/codec/StringEncoder.java?rev=1170351&r1=1170350&r2=1170351&view=diff
==============================================================================
---
commons/proper/codec/trunk/src/java/org/apache/commons/codec/StringEncoder.java
(original)
+++
commons/proper/codec/trunk/src/java/org/apache/commons/codec/StringEncoder.java
Tue Sep 13 21:09:09 2011
@@ -33,7 +33,7 @@ public interface StringEncoder extends E
* @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;
}
Modified:
commons/proper/codec/trunk/src/java/org/apache/commons/codec/binary/StringUtils.java
URL:
http://svn.apache.org/viewvc/commons/proper/codec/trunk/src/java/org/apache/commons/codec/binary/StringUtils.java?rev=1170351&r1=1170350&r2=1170351&view=diff
==============================================================================
---
commons/proper/codec/trunk/src/java/org/apache/commons/codec/binary/StringUtils.java
(original)
+++
commons/proper/codec/trunk/src/java/org/apache/commons/codec/binary/StringUtils.java
Tue Sep 13 21:09:09 2011
@@ -175,7 +175,7 @@ public class StringUtils {
* @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.
Modified:
commons/proper/codec/trunk/src/java/org/apache/commons/codec/language/ColognePhonetic.java
URL:
http://svn.apache.org/viewvc/commons/proper/codec/trunk/src/java/org/apache/commons/codec/language/ColognePhonetic.java?rev=1170351&r1=1170350&r2=1170351&view=diff
==============================================================================
---
commons/proper/codec/trunk/src/java/org/apache/commons/codec/language/ColognePhonetic.java
(original)
+++
commons/proper/codec/trunk/src/java/org/apache/commons/codec/language/ColognePhonetic.java
Tue Sep 13 21:09:09 2011
@@ -42,9 +42,9 @@ import org.apache.commons.codec.StringEn
*
* <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>
Modified:
commons/proper/codec/trunk/src/java/org/apache/commons/codec/language/RefinedSoundex.java
URL:
http://svn.apache.org/viewvc/commons/proper/codec/trunk/src/java/org/apache/commons/codec/language/RefinedSoundex.java?rev=1170351&r1=1170350&r2=1170351&view=diff
==============================================================================
---
commons/proper/codec/trunk/src/java/org/apache/commons/codec/language/RefinedSoundex.java
(original)
+++
commons/proper/codec/trunk/src/java/org/apache/commons/codec/language/RefinedSoundex.java
Tue Sep 13 21:09:09 2011
@@ -163,7 +163,7 @@ public class RefinedSoundex implements S
}
/**
- * 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
Modified:
commons/proper/codec/trunk/src/java/org/apache/commons/codec/net/QCodec.java
URL:
http://svn.apache.org/viewvc/commons/proper/codec/trunk/src/java/org/apache/commons/codec/net/QCodec.java?rev=1170351&r1=1170350&r2=1170351&view=diff
==============================================================================
---
commons/proper/codec/trunk/src/java/org/apache/commons/codec/net/QCodec.java
(original)
+++
commons/proper/codec/trunk/src/java/org/apache/commons/codec/net/QCodec.java
Tue Sep 13 21:09:09 2011
@@ -294,7 +294,7 @@ public class QCodec extends RFC1522Codec
}
/**
- * 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 class QCodec extends RFC1522Codec
}
/**
- * 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
Modified:
commons/proper/codec/trunk/src/java/org/apache/commons/codec/net/RFC1522Codec.java
URL:
http://svn.apache.org/viewvc/commons/proper/codec/trunk/src/java/org/apache/commons/codec/net/RFC1522Codec.java?rev=1170351&r1=1170350&r2=1170351&view=diff
==============================================================================
---
commons/proper/codec/trunk/src/java/org/apache/commons/codec/net/RFC1522Codec.java
(original)
+++
commons/proper/codec/trunk/src/java/org/apache/commons/codec/net/RFC1522Codec.java
Tue Sep 13 21:09:09 2011
@@ -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 @@ abstract class RFC1522Codec {
/**
* 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
Modified:
commons/proper/codec/trunk/src/java/org/apache/commons/codec/package.html
URL:
http://svn.apache.org/viewvc/commons/proper/codec/trunk/src/java/org/apache/commons/codec/package.html?rev=1170351&r1=1170350&r2=1170351&view=diff
==============================================================================
--- commons/proper/codec/trunk/src/java/org/apache/commons/codec/package.html
(original)
+++ commons/proper/codec/trunk/src/java/org/apache/commons/codec/package.html
Tue Sep 13 21:09:09 2011
@@ -50,7 +50,7 @@ limitations under the License.
</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>
