Skip to content

Commit

Permalink
Javadoc: Use paragraph tags.
Browse files Browse the repository at this point in the history
  • Loading branch information
Gary Gregory authored and tmousaw-ptc committed May 20, 2019
1 parent 66d1a15 commit 66d3232
Show file tree
Hide file tree
Showing 3 changed files with 37 additions and 26 deletions.
31 changes: 19 additions & 12 deletions src/main/java/org/apache/commons/codec/CharEncoding.java
Original file line number Diff line number Diff line change
Expand Up @@ -29,19 +29,19 @@
* </p>
*
* <ul>
* <li><code>US-ASCII</code><br>
* Seven-bit ASCII, a.k.a. ISO646-US, a.k.a. the Basic Latin block of the Unicode character set.</li>
* <li><code>ISO-8859-1</code><br>
* ISO Latin Alphabet No. 1, a.k.a. ISO-LATIN-1.</li>
* <li><code>UTF-8</code><br>
* Eight-bit Unicode Transformation Format.</li>
* <li><code>UTF-16BE</code><br>
* Sixteen-bit Unicode Transformation Format, big-endian byte order.</li>
* <li><code>UTF-16LE</code><br>
* Sixteen-bit Unicode Transformation Format, little-endian byte order.</li>
* <li><code>UTF-16</code><br>
* <li><code>US-ASCII</code><p>
* Seven-bit ASCII, a.k.a. ISO646-US, a.k.a. the Basic Latin block of the Unicode character set.</p></li>
* <li><code>ISO-8859-1</code><p>
* ISO Latin Alphabet No. 1, a.k.a. ISO-LATIN-1.</p></li>
* <li><code>UTF-8</code><p>
* Eight-bit Unicode Transformation Format.</p></li>
* <li><code>UTF-16BE</code><p>
* Sixteen-bit Unicode Transformation Format, big-endian byte order.</p></li>
* <li><code>UTF-16LE</code><p>
* Sixteen-bit Unicode Transformation Format, little-endian byte order.</p></li>
* <li><code>UTF-16</code><p>
* Sixteen-bit Unicode Transformation Format, byte order specified by a mandatory initial byte-order mark (either order
* accepted on input, big-endian used on output.)</li>
* accepted on input, big-endian used on output.)</p></li>
* </ul>
*
* This perhaps would best belong in the [lang] project. Even if a similar interface is defined in [lang], it is not
Expand All @@ -55,10 +55,12 @@
* @since 1.4
*/
public class CharEncoding {

/**
* CharEncodingISO Latin Alphabet No. 1, a.k.a. ISO-LATIN-1.
* <p>
* Every implementation of the Java platform is required to support this character encoding.
* </p>
*
* @see <a href="http://download.oracle.com/javase/7/docs/api/java/nio/charset/Charset.html">Standard charsets</a>
*/
Expand All @@ -68,6 +70,7 @@ public class CharEncoding {
* Seven-bit ASCII, also known as ISO646-US, also known as the Basic Latin block of the Unicode character set.
* <p>
* Every implementation of the Java platform is required to support this character encoding.
* </p>
*
* @see <a href="http://download.oracle.com/javase/7/docs/api/java/nio/charset/Charset.html">Standard charsets</a>
*/
Expand All @@ -78,6 +81,7 @@ public class CharEncoding {
* (either order accepted on input, big-endian used on output)
* <p>
* Every implementation of the Java platform is required to support this character encoding.
* </p>
*
* @see <a href="http://download.oracle.com/javase/7/docs/api/java/nio/charset/Charset.html">Standard charsets</a>
*/
Expand All @@ -87,6 +91,7 @@ public class CharEncoding {
* Sixteen-bit Unicode Transformation Format, big-endian byte order.
* <p>
* Every implementation of the Java platform is required to support this character encoding.
* </p>
*
* @see <a href="http://download.oracle.com/javase/7/docs/api/java/nio/charset/Charset.html">Standard charsets</a>
*/
Expand All @@ -96,6 +101,7 @@ public class CharEncoding {
* Sixteen-bit Unicode Transformation Format, little-endian byte order.
* <p>
* Every implementation of the Java platform is required to support this character encoding.
* </p>
*
* @see <a href="http://download.oracle.com/javase/7/docs/api/java/nio/charset/Charset.html">Standard charsets</a>
*/
Expand All @@ -105,6 +111,7 @@ public class CharEncoding {
* Eight-bit Unicode Transformation Format.
* <p>
* Every implementation of the Java platform is required to support this character encoding.
* </p>
*
* @see <a href="http://download.oracle.com/javase/7/docs/api/java/nio/charset/Charset.html">Standard charsets</a>
*/
Expand Down
24 changes: 12 additions & 12 deletions src/main/java/org/apache/commons/codec/Charsets.java
Original file line number Diff line number Diff line change
Expand Up @@ -30,19 +30,19 @@
* </p>
*
* <ul>
* <li><code>US-ASCII</code><br>
* Seven-bit ASCII, a.k.a. ISO646-US, a.k.a. the Basic Latin block of the Unicode character set.</li>
* <li><code>ISO-8859-1</code><br>
* ISO Latin Alphabet No. 1, a.k.a. ISO-LATIN-1.</li>
* <li><code>UTF-8</code><br>
* Eight-bit Unicode Transformation Format.</li>
* <li><code>UTF-16BE</code><br>
* Sixteen-bit Unicode Transformation Format, big-endian byte order.</li>
* <li><code>UTF-16LE</code><br>
* Sixteen-bit Unicode Transformation Format, little-endian byte order.</li>
* <li><code>UTF-16</code><br>
* <li><code>US-ASCII</code><p>
* Seven-bit ASCII, a.k.a. ISO646-US, a.k.a. the Basic Latin block of the Unicode character set.</p></li>
* <li><code>ISO-8859-1</code><p>
* ISO Latin Alphabet No. 1, a.k.a. ISO-LATIN-1.</p></li>
* <li><code>UTF-8</code><p>
* Eight-bit Unicode Transformation Format.</p></li>
* <li><code>UTF-16BE</code><p>
* Sixteen-bit Unicode Transformation Format, big-endian byte order.</p></li>
* <li><code>UTF-16LE</code><p>
* Sixteen-bit Unicode Transformation Format, little-endian byte order.</p></li>
* <li><code>UTF-16</code><p>
* Sixteen-bit Unicode Transformation Format, byte order specified by a mandatory initial byte-order mark (either order
* accepted on input, big-endian used on output.)</li>
* accepted on input, big-endian used on output.)</p></li>
* </ul>
*
* This perhaps would best belong in the Commons Lang project. Even if a similar class is defined in Commons Lang, it is
Expand Down
8 changes: 6 additions & 2 deletions src/main/java/org/apache/commons/codec/digest/Md5Crypt.java
Original file line number Diff line number Diff line change
Expand Up @@ -31,19 +31,23 @@
* <p>
* Based on the public domain ("beer-ware") C implementation from Poul-Henning Kamp which was found at: <a
* href="http://www.freebsd.org/cgi/cvsweb.cgi/src/lib/libcrypt/crypt-md5.c?rev=1.1;content-type=text%2Fplain">
* crypt-md5.c @ freebsd.org</a><br>
* crypt-md5.c @ freebsd.org</a>
* </p>
* <p>
* Source:
*
* </p>
* <pre>
* $FreeBSD: src/lib/libcrypt/crypt-md5.c,v 1.1 1999/01/21 13:50:09 brandon Exp $
* </pre>
* <p>
* Conversion to Kotlin and from there to Java in 2012.
* </p>
* <p>
* The C style comments are from the original C code, the ones with "//" from the port.
* </p>
* <p>
* This class is immutable and thread-safe.
* </p>
*
* @since 1.7
*/
Expand Down

0 comments on commit 66d3232

Please sign in to comment.