Skip to content

Commit 0bf5b8a

Browse files
author
Gary Gregory
committed
Javadoc: Use paragraph tags.
1 parent 1406889 commit 0bf5b8a

3 files changed

Lines changed: 37 additions & 26 deletions

File tree

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

Lines changed: 19 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -29,19 +29,19 @@
2929
* </p>
3030
*
3131
* <ul>
32-
* <li><code>US-ASCII</code><br>
33-
* Seven-bit ASCII, a.k.a. ISO646-US, a.k.a. the Basic Latin block of the Unicode character set.</li>
34-
* <li><code>ISO-8859-1</code><br>
35-
* ISO Latin Alphabet No. 1, a.k.a. ISO-LATIN-1.</li>
36-
* <li><code>UTF-8</code><br>
37-
* Eight-bit Unicode Transformation Format.</li>
38-
* <li><code>UTF-16BE</code><br>
39-
* Sixteen-bit Unicode Transformation Format, big-endian byte order.</li>
40-
* <li><code>UTF-16LE</code><br>
41-
* Sixteen-bit Unicode Transformation Format, little-endian byte order.</li>
42-
* <li><code>UTF-16</code><br>
32+
* <li><code>US-ASCII</code><p>
33+
* Seven-bit ASCII, a.k.a. ISO646-US, a.k.a. the Basic Latin block of the Unicode character set.</p></li>
34+
* <li><code>ISO-8859-1</code><p>
35+
* ISO Latin Alphabet No. 1, a.k.a. ISO-LATIN-1.</p></li>
36+
* <li><code>UTF-8</code><p>
37+
* Eight-bit Unicode Transformation Format.</p></li>
38+
* <li><code>UTF-16BE</code><p>
39+
* Sixteen-bit Unicode Transformation Format, big-endian byte order.</p></li>
40+
* <li><code>UTF-16LE</code><p>
41+
* Sixteen-bit Unicode Transformation Format, little-endian byte order.</p></li>
42+
* <li><code>UTF-16</code><p>
4343
* Sixteen-bit Unicode Transformation Format, byte order specified by a mandatory initial byte-order mark (either order
44-
* accepted on input, big-endian used on output.)</li>
44+
* accepted on input, big-endian used on output.)</p></li>
4545
* </ul>
4646
*
4747
* This perhaps would best belong in the [lang] project. Even if a similar interface is defined in [lang], it is not
@@ -55,10 +55,12 @@
5555
* @since 1.4
5656
*/
5757
public class CharEncoding {
58+
5859
/**
5960
* CharEncodingISO Latin Alphabet No. 1, a.k.a. ISO-LATIN-1.
6061
* <p>
6162
* Every implementation of the Java platform is required to support this character encoding.
63+
* </p>
6264
*
6365
* @see <a href="http://download.oracle.com/javase/7/docs/api/java/nio/charset/Charset.html">Standard charsets</a>
6466
*/
@@ -68,6 +70,7 @@ public class CharEncoding {
6870
* Seven-bit ASCII, also known as ISO646-US, also known as the Basic Latin block of the Unicode character set.
6971
* <p>
7072
* Every implementation of the Java platform is required to support this character encoding.
73+
* </p>
7174
*
7275
* @see <a href="http://download.oracle.com/javase/7/docs/api/java/nio/charset/Charset.html">Standard charsets</a>
7376
*/
@@ -78,6 +81,7 @@ public class CharEncoding {
7881
* (either order accepted on input, big-endian used on output)
7982
* <p>
8083
* Every implementation of the Java platform is required to support this character encoding.
84+
* </p>
8185
*
8286
* @see <a href="http://download.oracle.com/javase/7/docs/api/java/nio/charset/Charset.html">Standard charsets</a>
8387
*/
@@ -87,6 +91,7 @@ public class CharEncoding {
8791
* Sixteen-bit Unicode Transformation Format, big-endian byte order.
8892
* <p>
8993
* Every implementation of the Java platform is required to support this character encoding.
94+
* </p>
9095
*
9196
* @see <a href="http://download.oracle.com/javase/7/docs/api/java/nio/charset/Charset.html">Standard charsets</a>
9297
*/
@@ -96,6 +101,7 @@ public class CharEncoding {
96101
* Sixteen-bit Unicode Transformation Format, little-endian byte order.
97102
* <p>
98103
* Every implementation of the Java platform is required to support this character encoding.
104+
* </p>
99105
*
100106
* @see <a href="http://download.oracle.com/javase/7/docs/api/java/nio/charset/Charset.html">Standard charsets</a>
101107
*/
@@ -105,6 +111,7 @@ public class CharEncoding {
105111
* Eight-bit Unicode Transformation Format.
106112
* <p>
107113
* Every implementation of the Java platform is required to support this character encoding.
114+
* </p>
108115
*
109116
* @see <a href="http://download.oracle.com/javase/7/docs/api/java/nio/charset/Charset.html">Standard charsets</a>
110117
*/

src/main/java/org/apache/commons/codec/Charsets.java

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -30,19 +30,19 @@
3030
* </p>
3131
*
3232
* <ul>
33-
* <li><code>US-ASCII</code><br>
34-
* Seven-bit ASCII, a.k.a. ISO646-US, a.k.a. the Basic Latin block of the Unicode character set.</li>
35-
* <li><code>ISO-8859-1</code><br>
36-
* ISO Latin Alphabet No. 1, a.k.a. ISO-LATIN-1.</li>
37-
* <li><code>UTF-8</code><br>
38-
* Eight-bit Unicode Transformation Format.</li>
39-
* <li><code>UTF-16BE</code><br>
40-
* Sixteen-bit Unicode Transformation Format, big-endian byte order.</li>
41-
* <li><code>UTF-16LE</code><br>
42-
* Sixteen-bit Unicode Transformation Format, little-endian byte order.</li>
43-
* <li><code>UTF-16</code><br>
33+
* <li><code>US-ASCII</code><p>
34+
* Seven-bit ASCII, a.k.a. ISO646-US, a.k.a. the Basic Latin block of the Unicode character set.</p></li>
35+
* <li><code>ISO-8859-1</code><p>
36+
* ISO Latin Alphabet No. 1, a.k.a. ISO-LATIN-1.</p></li>
37+
* <li><code>UTF-8</code><p>
38+
* Eight-bit Unicode Transformation Format.</p></li>
39+
* <li><code>UTF-16BE</code><p>
40+
* Sixteen-bit Unicode Transformation Format, big-endian byte order.</p></li>
41+
* <li><code>UTF-16LE</code><p>
42+
* Sixteen-bit Unicode Transformation Format, little-endian byte order.</p></li>
43+
* <li><code>UTF-16</code><p>
4444
* Sixteen-bit Unicode Transformation Format, byte order specified by a mandatory initial byte-order mark (either order
45-
* accepted on input, big-endian used on output.)</li>
45+
* accepted on input, big-endian used on output.)</p></li>
4646
* </ul>
4747
*
4848
* This perhaps would best belong in the Commons Lang project. Even if a similar class is defined in Commons Lang, it is

src/main/java/org/apache/commons/codec/digest/Md5Crypt.java

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,19 +31,23 @@
3131
* <p>
3232
* Based on the public domain ("beer-ware") C implementation from Poul-Henning Kamp which was found at: <a
3333
* href="http://www.freebsd.org/cgi/cvsweb.cgi/src/lib/libcrypt/crypt-md5.c?rev=1.1;content-type=text%2Fplain">
34-
* crypt-md5.c @ freebsd.org</a><br>
34+
* crypt-md5.c @ freebsd.org</a>
35+
* </p>
3536
* <p>
3637
* Source:
37-
*
38+
* </p>
3839
* <pre>
3940
* $FreeBSD: src/lib/libcrypt/crypt-md5.c,v 1.1 1999/01/21 13:50:09 brandon Exp $
4041
* </pre>
4142
* <p>
4243
* Conversion to Kotlin and from there to Java in 2012.
44+
* </p>
4345
* <p>
4446
* The C style comments are from the original C code, the ones with "//" from the port.
47+
* </p>
4548
* <p>
4649
* This class is immutable and thread-safe.
50+
* </p>
4751
*
4852
* @since 1.7
4953
*/

0 commit comments

Comments
 (0)