Author: ggregory Date: Thu May 24 13:03:14 2012 New Revision: 1342240 URL: http://svn.apache.org/viewvc?rev=1342240&view=rev Log: Replace "This class is immutable and thread-safe." with "<p>This class is immutable and thread-safe.</p>" per Konstantin Kolinko's comment on the dev ML.
Modified: commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/CharEncoding.java commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/Charsets.java commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/StringEncoderComparator.java commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/binary/BinaryCodec.java commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/binary/StringUtils.java commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/digest/B64.java commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/digest/Crypt.java commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/digest/Md5Crypt.java commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/digest/Sha2Crypt.java commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/digest/UnixCrypt.java commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/AbstractCaverphone.java commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/Caverphone1.java commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/Caverphone2.java commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/Nysiis.java commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/RefinedSoundex.java commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/SoundexUtils.java commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/bm/Languages.java commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/bm/ResourceConstants.java commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/net/BCodec.java commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/net/QuotedPrintableCodec.java commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/net/RFC1522Codec.java commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/net/URLCodec.java commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/net/Utils.java Modified: commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/CharEncoding.java URL: http://svn.apache.org/viewvc/commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/CharEncoding.java?rev=1342240&r1=1342239&r2=1342240&view=diff ============================================================================== --- commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/CharEncoding.java (original) +++ commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/CharEncoding.java Thu May 24 13:03:14 2012 @@ -47,7 +47,7 @@ package org.apache.commons.codec; * This perhaps would best belong in the [lang] project. Even if a similar interface is defined in [lang], it is not * foreseen that [codec] would be made to depend on [lang]. * - * This class is immutable and thread-safe. + * <p>This class is immutable and thread-safe.</p> * * @see <a href="http://download.oracle.com/javase/6/docs/api/java/nio/charset/Charset.html">Standard charsets</a> * @since 1.4 Modified: commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/Charsets.java URL: http://svn.apache.org/viewvc/commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/Charsets.java?rev=1342240&r1=1342239&r2=1342240&view=diff ============================================================================== --- commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/Charsets.java (original) +++ commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/Charsets.java Thu May 24 13:03:14 2012 @@ -49,7 +49,7 @@ import java.nio.charset.UnsupportedChars * This perhaps would best belong in the Commons Lang project. Even if a similar class is defined in Commons Lang, it is * not foreseen that Commons Codec would be made to depend on Commons Lang. * - * This class is immutable and thread-safe. + * <p>This class is immutable and thread-safe.</p> * * @see <a href="http://docs.oracle.com/javase/6/docs/api/java/nio/charset/Charset.html">Standard charsets</a> * @since 1.7 Modified: commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/StringEncoderComparator.java URL: http://svn.apache.org/viewvc/commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/StringEncoderComparator.java?rev=1342240&r1=1342239&r2=1342240&view=diff ============================================================================== --- commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/StringEncoderComparator.java (original) +++ commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/StringEncoderComparator.java Thu May 24 13:03:14 2012 @@ -24,7 +24,7 @@ import java.util.Comparator; * Soundex, Metaphone, etc. This class can come in handy if one need to sort Strings by an encoded form of a name such * as Soundex. * - * This class is immutable and thread-safe. + * <p>This class is immutable and thread-safe.</p> * * @version $Id$ */ Modified: commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/binary/BinaryCodec.java URL: http://svn.apache.org/viewvc/commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/binary/BinaryCodec.java?rev=1342240&r1=1342239&r2=1342240&view=diff ============================================================================== --- commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/binary/BinaryCodec.java (original) +++ commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/binary/BinaryCodec.java Thu May 24 13:03:14 2012 @@ -25,7 +25,7 @@ import org.apache.commons.codec.EncoderE /** * Converts between byte arrays and strings of "0"s and "1"s. * - * This class is immutable and thread-safe. + * <p>This class is immutable and thread-safe.</p> * * TODO: may want to add more bit vector functions like and/or/xor/nand * TODO: also might be good to generate boolean[] from byte[] et cetera. Modified: commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/binary/StringUtils.java URL: http://svn.apache.org/viewvc/commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/binary/StringUtils.java?rev=1342240&r1=1342239&r2=1342240&view=diff ============================================================================== --- commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/binary/StringUtils.java (original) +++ commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/binary/StringUtils.java Thu May 24 13:03:14 2012 @@ -27,7 +27,7 @@ import org.apache.commons.codec.Charsets * Converts String to and from bytes using the encodings required by the Java specification. These encodings are specified in <a * href="http://download.oracle.com/javase/6/docs/api/java/nio/charset/Charset.html">Standard charsets</a> * - * This class is immutable and thread-safe. + * <p>This class is immutable and thread-safe.</p> * * @see CharEncoding * @see <a href="http://download.oracle.com/javase/6/docs/api/java/nio/charset/Charset.html">Standard charsets</a> Modified: commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/digest/B64.java URL: http://svn.apache.org/viewvc/commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/digest/B64.java?rev=1342240&r1=1342239&r2=1342240&view=diff ============================================================================== --- commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/digest/B64.java (original) +++ commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/digest/B64.java Thu May 24 13:03:14 2012 @@ -23,7 +23,7 @@ import java.util.Random; * * TODO: Can Base64 be reused? * - * This class is immutable and thread-safe. + * <p>This class is immutable and thread-safe.</p> * * @version $Id$ * @since 1.7 Modified: commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/digest/Crypt.java URL: http://svn.apache.org/viewvc/commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/digest/Crypt.java?rev=1342240&r1=1342239&r2=1342240&view=diff ============================================================================== --- commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/digest/Crypt.java (original) +++ commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/digest/Crypt.java Thu May 24 13:03:14 2012 @@ -23,7 +23,7 @@ import org.apache.commons.codec.Charsets * * See {@link #crypt(String, String)} for further details. * - * This class is immutable and thread-safe. + * <p>This class is immutable and thread-safe.</p> * * @version $Id$ * @since 1.7 Modified: commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/digest/Md5Crypt.java URL: http://svn.apache.org/viewvc/commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/digest/Md5Crypt.java?rev=1342240&r1=1342239&r2=1342240&view=diff ============================================================================== --- commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/digest/Md5Crypt.java (original) +++ commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/digest/Md5Crypt.java Thu May 24 13:03:14 2012 @@ -39,7 +39,7 @@ import org.apache.commons.codec.Charsets * The C style comments are from the original C code, the ones with "//" from the port. * </p> * - * This class is immutable and thread-safe. + * <p>This class is immutable and thread-safe.</p> * * @version $Id$ * @since 1.7 Modified: commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/digest/Sha2Crypt.java URL: http://svn.apache.org/viewvc/commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/digest/Sha2Crypt.java?rev=1342240&r1=1342239&r2=1342240&view=diff ============================================================================== --- commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/digest/Sha2Crypt.java (original) +++ commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/digest/Sha2Crypt.java Thu May 24 13:03:14 2012 @@ -34,7 +34,7 @@ import java.util.regex.Pattern; * into the Public Domain. * </p> * - * This class is immutable and thread-safe. + * <p>This class is immutable and thread-safe.</p> * * @version $Id$ * @since 1.7 Modified: commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/digest/UnixCrypt.java URL: http://svn.apache.org/viewvc/commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/digest/UnixCrypt.java?rev=1342240&r1=1342239&r2=1342240&view=diff ============================================================================== --- commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/digest/UnixCrypt.java (original) +++ commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/digest/UnixCrypt.java Thu May 24 13:03:14 2012 @@ -33,7 +33,7 @@ import org.apache.commons.codec.Charsets * This class is slightly incompatible if the given salt contains characters * that are not part of the allowed range [a-zA-Z0-9./]. * - * This class is immutable and thread-safe. + * <p>This class is immutable and thread-safe.</p> * * @version $Id$ * @since 1.7 Modified: commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/AbstractCaverphone.java URL: http://svn.apache.org/viewvc/commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/AbstractCaverphone.java?rev=1342240&r1=1342239&r2=1342240&view=diff ============================================================================== --- commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/AbstractCaverphone.java (original) +++ commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/AbstractCaverphone.java Thu May 24 13:03:14 2012 @@ -26,7 +26,7 @@ import org.apache.commons.codec.StringEn * This is an algorithm created by the Caversham Project at the University of Otago. It implements the Caverphone 2.0 * algorithm: * - * This class is immutable and thread-safe. + * <p>This class is immutable and thread-safe.</p> * * @version $Id: Caverphone.java 1075947 2011-03-01 17:56:14Z ggregory $ * @see <a href="http://en.wikipedia.org/wiki/Caverphone">Wikipedia - Caverphone</a> Modified: commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/Caverphone1.java URL: http://svn.apache.org/viewvc/commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/Caverphone1.java?rev=1342240&r1=1342239&r2=1342240&view=diff ============================================================================== --- commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/Caverphone1.java (original) +++ commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/Caverphone1.java Thu May 24 13:03:14 2012 @@ -28,7 +28,7 @@ package org.apache.commons.codec.languag * @see <a href="http://caversham.otago.ac.nz/files/working/ctp060902.pdf">Caverphone 1.0 specification</a> * @since 1.5 * - * This class is immutable and thread-safe. + * <p>This class is immutable and thread-safe.</p> */ public class Caverphone1 extends AbstractCaverphone { Modified: commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/Caverphone2.java URL: http://svn.apache.org/viewvc/commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/Caverphone2.java?rev=1342240&r1=1342239&r2=1342240&view=diff ============================================================================== --- commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/Caverphone2.java (original) +++ commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/Caverphone2.java Thu May 24 13:03:14 2012 @@ -28,7 +28,7 @@ package org.apache.commons.codec.languag * @see <a href="http://caversham.otago.ac.nz/files/working/ctp150804.pdf">Caverphone 2.0 specification</a> * @since 1.5 * - * This class is immutable and thread-safe. + * <p>This class is immutable and thread-safe.</p> */ public class Caverphone2 extends AbstractCaverphone { Modified: commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/Nysiis.java URL: http://svn.apache.org/viewvc/commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/Nysiis.java?rev=1342240&r1=1342239&r2=1342240&view=diff ============================================================================== --- commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/Nysiis.java (original) +++ commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/Nysiis.java Thu May 24 13:03:14 2012 @@ -61,7 +61,7 @@ import org.apache.commons.codec.StringEn * 9. Add original first character of name as first character of key * </pre></p> * - * This class is immutable and thread-safe. + * <p>This class is immutable and thread-safe.</p> * * @see <a href="http://en.wikipedia.org/wiki/NYSIIS">NYSIIS on Wikipedia</a> * @see <a href="http://www.dropby.com/NYSIIS.html">NYSIIS on dropby.com</a> Modified: commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/RefinedSoundex.java URL: http://svn.apache.org/viewvc/commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/RefinedSoundex.java?rev=1342240&r1=1342239&r2=1342240&view=diff ============================================================================== --- commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/RefinedSoundex.java (original) +++ commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/RefinedSoundex.java Thu May 24 13:03:14 2012 @@ -25,7 +25,7 @@ import org.apache.commons.codec.StringEn * optimized for spell checking words. Soundex method originally developed by * <CITE>Margaret Odell</CITE> and <CITE>Robert Russell</CITE>. * - * This class is immutable and thread-safe. + * <p>This class is immutable and thread-safe.</p> * * @version $Id$ */ Modified: commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/SoundexUtils.java URL: http://svn.apache.org/viewvc/commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/SoundexUtils.java?rev=1342240&r1=1342239&r2=1342240&view=diff ============================================================================== --- commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/SoundexUtils.java (original) +++ commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/SoundexUtils.java Thu May 24 13:03:14 2012 @@ -23,7 +23,7 @@ import org.apache.commons.codec.StringEn /** * Utility methods for {@link Soundex} and {@link RefinedSoundex} classes. * - * This class is immutable and thread-safe. + * <p>This class is immutable and thread-safe.</p> * * @version $Id$ * @since 1.3 Modified: commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/bm/Languages.java URL: http://svn.apache.org/viewvc/commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/bm/Languages.java?rev=1342240&r1=1342239&r2=1342240&view=diff ============================================================================== --- commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/bm/Languages.java (original) +++ commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/bm/Languages.java Thu May 24 13:03:14 2012 @@ -51,7 +51,7 @@ import java.util.Set; * * @since 1.6 * - * This class is immutable and thread-safe. + * <p>This class is immutable and thread-safe.</p> */ public class Languages { // Iimplementation note: This class is divided into two sections. The first part is a static factory interface that Modified: commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/bm/ResourceConstants.java URL: http://svn.apache.org/viewvc/commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/bm/ResourceConstants.java?rev=1342240&r1=1342239&r2=1342240&view=diff ============================================================================== --- commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/bm/ResourceConstants.java (original) +++ commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/bm/ResourceConstants.java Thu May 24 13:03:14 2012 @@ -22,7 +22,7 @@ import org.apache.commons.codec.CharEnco /** * Constants used to process resource files. * - * This class is immutable and thread-safe. + * <p>This class is immutable and thread-safe.</p> * * @since 1.6 */ Modified: commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/net/BCodec.java URL: http://svn.apache.org/viewvc/commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/net/BCodec.java?rev=1342240&r1=1342239&r2=1342240&view=diff ============================================================================== --- commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/net/BCodec.java (original) +++ commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/net/BCodec.java Thu May 24 13:03:14 2012 @@ -40,7 +40,7 @@ import org.apache.commons.codec.binary.B * handling software. * </p> * - * This class is immutable and thread-safe. + * <p>This class is immutable and thread-safe.</p> * * @see <a href="http://www.ietf.org/rfc/rfc1522.txt">MIME (Multipurpose Internet Mail Extensions) Part Two: Message * Header Extensions for Non-ASCII Text</a> Modified: commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/net/QuotedPrintableCodec.java URL: http://svn.apache.org/viewvc/commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/net/QuotedPrintableCodec.java?rev=1342240&r1=1342239&r2=1342240&view=diff ============================================================================== --- commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/net/QuotedPrintableCodec.java (original) +++ commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/net/QuotedPrintableCodec.java Thu May 24 13:03:14 2012 @@ -55,7 +55,7 @@ import org.apache.commons.codec.binary.S * for those applications that do not require quoted-printable line formatting (rules #3, #4, #5), for instance Q codec. * </p> * - * This class is immutable and thread-safe. + * <p>This class is immutable and thread-safe.</p> * * @see <a href="http://www.ietf.org/rfc/rfc1521.txt"> RFC 1521 MIME (Multipurpose Internet Mail Extensions) Part One: * Mechanisms for Specifying and Describing the Format of Internet Message Bodies </a> Modified: commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/net/RFC1522Codec.java URL: http://svn.apache.org/viewvc/commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/net/RFC1522Codec.java?rev=1342240&r1=1342239&r2=1342240&view=diff ============================================================================== --- commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/net/RFC1522Codec.java (original) +++ commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/net/RFC1522Codec.java Thu May 24 13:03:14 2012 @@ -41,7 +41,7 @@ import org.apache.commons.codec.binary.S * Message Header Extensions for Non-ASCII Text</a> * </p> * - * This class is immutable and thread-safe. + * <p>This class is immutable and thread-safe.</p> * * @since 1.3 * @version $Id$ Modified: commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/net/URLCodec.java URL: http://svn.apache.org/viewvc/commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/net/URLCodec.java?rev=1342240&r1=1342239&r2=1342240&view=diff ============================================================================== --- commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/net/URLCodec.java (original) +++ commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/net/URLCodec.java Thu May 24 13:03:14 2012 @@ -46,7 +46,7 @@ import org.apache.commons.codec.binary.S * 1.4 rely on the platform's default charset encoding. * </p> * - * This class is immutable and thread-safe. + * <p>This class is immutable and thread-safe.</p> * * @since 1.2 * @version $Id$ Modified: commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/net/Utils.java URL: http://svn.apache.org/viewvc/commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/net/Utils.java?rev=1342240&r1=1342239&r2=1342240&view=diff ============================================================================== --- commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/net/Utils.java (original) +++ commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/net/Utils.java Thu May 24 13:03:14 2012 @@ -22,7 +22,7 @@ import org.apache.commons.codec.DecoderE /** * Utility methods for this package. * - * This class is immutable and thread-safe. + * <p>This class is immutable and thread-safe.</p> * * @version $Id$ * @since 1.4