You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by gg...@apache.org on 2019/05/19 13:06:04 UTC
[commons-codec] branch master updated: Javadoc: Use paragraph tags.
This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-codec.git
The following commit(s) were added to refs/heads/master by this push:
new 0bf5b8a Javadoc: Use paragraph tags.
0bf5b8a is described below
commit 0bf5b8a05a535895916a57817b226aec0e05ba13
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Sun May 19 09:06:00 2019 -0400
Javadoc: Use paragraph tags.
---
.../org/apache/commons/codec/CharEncoding.java | 31 +++++++++++++---------
.../java/org/apache/commons/codec/Charsets.java | 24 ++++++++---------
.../org/apache/commons/codec/digest/Md5Crypt.java | 8 ++++--
3 files changed, 37 insertions(+), 26 deletions(-)
diff --git a/src/main/java/org/apache/commons/codec/CharEncoding.java b/src/main/java/org/apache/commons/codec/CharEncoding.java
index 27c7aa4..6457933 100644
--- a/src/main/java/org/apache/commons/codec/CharEncoding.java
+++ b/src/main/java/org/apache/commons/codec/CharEncoding.java
@@ -29,19 +29,19 @@ package org.apache.commons.codec;
* </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
@@ -55,10 +55,12 @@ package org.apache.commons.codec;
* @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>
*/
@@ -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>
*/
@@ -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>
*/
@@ -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>
*/
@@ -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>
*/
@@ -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>
*/
diff --git a/src/main/java/org/apache/commons/codec/Charsets.java b/src/main/java/org/apache/commons/codec/Charsets.java
index f553b60..44bb0bb 100644
--- a/src/main/java/org/apache/commons/codec/Charsets.java
+++ b/src/main/java/org/apache/commons/codec/Charsets.java
@@ -30,19 +30,19 @@ import java.nio.charset.Charset;
* </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
diff --git a/src/main/java/org/apache/commons/codec/digest/Md5Crypt.java b/src/main/java/org/apache/commons/codec/digest/Md5Crypt.java
index 10635bd..b6a14dd 100644
--- a/src/main/java/org/apache/commons/codec/digest/Md5Crypt.java
+++ b/src/main/java/org/apache/commons/codec/digest/Md5Crypt.java
@@ -31,19 +31,23 @@ import org.apache.commons.codec.Charsets;
* <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
*/