Skip to content

Commit f3b0eb5

Browse files
committed
Javadoc
1 parent 537e313 commit f3b0eb5

5 files changed

Lines changed: 12 additions & 18 deletions

File tree

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
package org.apache.commons.codec;
1919

2020
/**
21-
* Defines encoding and decoding policies.
21+
* Enumerates encoding and decoding policies.
2222
*
2323
* @since 1.15
2424
*/

src/main/java/org/apache/commons/codec/binary/Base64.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -168,7 +168,7 @@ public Builder setUrlSafe(final boolean urlSafe) {
168168
}
169169

170170
/**
171-
* Defines the Base64 table format to be used on decoding.
171+
* Enumerates the Base64 table format to be used on decoding.
172172
* <p>
173173
* By default, the method uses {@link DecodeTableFormat#MIXED} approach, allowing a seamless handling of both {@link DecodeTableFormat#URL_SAFE} and
174174
* {@link DecodeTableFormat#STANDARD} base64 options.

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

Lines changed: 7 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -18,22 +18,17 @@
1818
package org.apache.commons.codec.digest;
1919

2020
/**
21-
* Standard {@link HmacUtils} algorithm names from the <cite>Java Cryptography Architecture Standard Algorithm Name
22-
* Documentation</cite>.
23-
*
21+
* Enumerates the standard {@link HmacUtils} algorithm names from the <cite>Java Cryptography Architecture Standard Algorithm Name Documentation</cite>.
2422
* <p>
2523
* <strong>Note: Not all JCE implementations support all the algorithms in this enum.</strong>
2624
* </p>
2725
*
28-
* @see <a href="https://docs.oracle.com/javase/8/docs/technotes/guides/security/SunProviders.html#SunJCEProvider"> Java
29-
* 8 Cryptography Architecture Sun Providers Documentation</a>
30-
* @see <a href=
31-
* "https://docs.oracle.com/en/java/javase/11/security/oracle-providers.html#GUID-A47B1249-593C-4C38-A0D0-68FA7681E0A7">
32-
* Java 11 Cryptography Architecture Sun Providers Documentation</a>
33-
* @see <a href=
34-
* "https://docs.oracle.com/en/java/javase/17/security/oracle-providers.html#GUID-A47B1249-593C-4C38-A0D0-68FA7681E0A7">
35-
* Java 17 Cryptography Architecture Sun Providers Documentation</a>
36-
*
26+
* @see <a href="https://docs.oracle.com/javase/8/docs/technotes/guides/security/SunProviders.html#SunJCEProvider"> Java 8 Cryptography Architecture Sun
27+
* Providers Documentation</a>
28+
* @see <a href= "https://docs.oracle.com/en/java/javase/11/security/oracle-providers.html#GUID-A47B1249-593C-4C38-A0D0-68FA7681E0A7"> Java 11 Cryptography
29+
* Architecture Sun Providers Documentation</a>
30+
* @see <a href= "https://docs.oracle.com/en/java/javase/17/security/oracle-providers.html#GUID-A47B1249-593C-4C38-A0D0-68FA7681E0A7"> Java 17 Cryptography
31+
* Architecture Sun Providers Documentation</a>
3732
* @since 1.10
3833
*/
3934
public enum HmacAlgorithms {

src/main/java/org/apache/commons/codec/language/bm/NameType.java

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,8 @@
1818
package org.apache.commons.codec.language.bm;
1919

2020
/**
21-
* Supported types of names. Unless you are matching particular family names, use {@link #GENERIC}. The
22-
* {@code GENERIC} NameType should work reasonably well for non-name words. The other encodings are
23-
* specifically tuned to family names, and may not work well at all for general text.
21+
* Enumerates the supported types of names. Unless you are matching particular family names, use {@link #GENERIC}. The {@code GENERIC} NameType should work
22+
* reasonably well for non-name words. The other encodings are specifically tuned to family names, and may not work well at all for general text.
2423
*
2524
* @since 1.6
2625
*/

src/main/java/org/apache/commons/codec/language/bm/RuleType.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
package org.apache.commons.codec.language.bm;
1919

2020
/**
21-
* Types of rule.
21+
* Enumerates the types of rule.
2222
*
2323
* @since 1.6
2424
*/

0 commit comments

Comments
 (0)