Skip to content

Commit cfd44eb

Browse files
garydgregorygarydgregory
committed
[CODEC-180] Patch from Ville Skyttä applied and then some (well, just one more). Fix Javadoc 1.8.0 errors.
git-svn-id: https://svn.apache.org/repos/asf/commons/proper/codec/trunk@1563226 13f79535-47bb-0310-9956-ffa450edef68
1 parent 6643637 commit cfd44eb

17 files changed

Lines changed: 62 additions & 63 deletions

‎src/changes/changes.xml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@ The <action> type attribute can be add,update,fix,remove.
4343
</properties>
4444
<body>
4545
<release version="1.10" date="DD Mmmm 2014" description="Feature and fix release.">
46+
<action dev="ggregory" type="fix" issue="CODEC-180" due-to="Ville Skyttä">Fix Javadoc 1.8.0 errors</action>
4647
<action dev="ggregory" type="update" issue="CODEC-178">Deprecate Charsets Charset constants in favor of Java 7's java.nio.charset.StandardCharsets</action>
4748
</release>
4849
<release version="1.9" date="20 December 2013" description="Feature and fix release.">

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -29,17 +29,17 @@
2929
* </p>
3030
*
3131
* <ul>
32-
* <li><code>US-ASCII</code><br/>
32+
* <li><code>US-ASCII</code><br>
3333
* 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/>
34+
* <li><code>ISO-8859-1</code><br>
3535
* ISO Latin Alphabet No. 1, a.k.a. ISO-LATIN-1.</li>
36-
* <li><code>UTF-8</code><br/>
36+
* <li><code>UTF-8</code><br>
3737
* Eight-bit Unicode Transformation Format.</li>
38-
* <li><code>UTF-16BE</code><br/>
38+
* <li><code>UTF-16BE</code><br>
3939
* Sixteen-bit Unicode Transformation Format, big-endian byte order.</li>
40-
* <li><code>UTF-16LE</code><br/>
40+
* <li><code>UTF-16LE</code><br>
4141
* Sixteen-bit Unicode Transformation Format, little-endian byte order.</li>
42-
* <li><code>UTF-16</code><br/>
42+
* <li><code>UTF-16</code><br>
4343
* Sixteen-bit Unicode Transformation Format, byte order specified by a mandatory initial byte-order mark (either order
4444
* accepted on input, big-endian used on output.)</li>
4545
* </ul>

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -30,17 +30,17 @@
3030
* </p>
3131
*
3232
* <ul>
33-
* <li><code>US-ASCII</code><br/>
33+
* <li><code>US-ASCII</code><br>
3434
* 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/>
35+
* <li><code>ISO-8859-1</code><br>
3636
* ISO Latin Alphabet No. 1, a.k.a. ISO-LATIN-1.</li>
37-
* <li><code>UTF-8</code><br/>
37+
* <li><code>UTF-8</code><br>
3838
* Eight-bit Unicode Transformation Format.</li>
39-
* <li><code>UTF-16BE</code><br/>
39+
* <li><code>UTF-16BE</code><br>
4040
* Sixteen-bit Unicode Transformation Format, big-endian byte order.</li>
41-
* <li><code>UTF-16LE</code><br/>
41+
* <li><code>UTF-16LE</code><br>
4242
* Sixteen-bit Unicode Transformation Format, little-endian byte order.</li>
43-
* <li><code>UTF-16</code><br/>
43+
* <li><code>UTF-16</code><br>
4444
* Sixteen-bit Unicode Transformation Format, byte order specified by a mandatory initial byte-order mark (either order
4545
* accepted on input, big-endian used on output.)</li>
4646
* </ul>

‎src/main/java/org/apache/commons/codec/binary/Base32.java‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,13 +22,13 @@
2222
*
2323
* <p>
2424
* The class can be parameterized in the following manner with various constructors:
25+
* </p>
2526
* <ul>
2627
* <li>Whether to use the "base32hex" variant instead of the default "base32"</li>
2728
* <li>Line length: Default 76. Line length that aren't multiples of 8 will still essentially end up being multiples of
2829
* 8 in the encoded data.
2930
* <li>Line separator: Default is CRLF ("\r\n")</li>
3031
* </ul>
31-
* </p>
3232
* <p>
3333
* This class operates directly on byte streams, and not character streams.
3434
* </p>
@@ -144,7 +144,7 @@ public class Base32 extends BaseNCodec {
144144
private final byte[] encodeTable;
145145

146146
/**
147-
* Line separator for encoding. Not used when decoding. Only used if lineLength > 0.
147+
* Line separator for encoding. Not used when decoding. Only used if lineLength &gt; 0.
148148
*/
149149
private final byte[] lineSeparator;
150150

@@ -178,7 +178,7 @@ public Base32(final boolean useHex) {
178178
*
179179
* @param lineLength
180180
* Each line of encoded data will be at most of the given length (rounded down to nearest multiple of
181-
* 8). If lineLength <= 0, then the output will not be divided into lines (chunks). Ignored when
181+
* 8). If lineLength &lt;= 0, then the output will not be divided into lines (chunks). Ignored when
182182
* decoding.
183183
*/
184184
public Base32(final int lineLength) {
@@ -196,7 +196,7 @@ public Base32(final int lineLength) {
196196
*
197197
* @param lineLength
198198
* Each line of encoded data will be at most of the given length (rounded down to nearest multiple of
199-
* 8). If lineLength <= 0, then the output will not be divided into lines (chunks). Ignored when
199+
* 8). If lineLength &lt;= 0, then the output will not be divided into lines (chunks). Ignored when
200200
* decoding.
201201
* @param lineSeparator
202202
* Each line of encoded data will end with this sequence of bytes.
@@ -218,15 +218,15 @@ public Base32(final int lineLength, final byte[] lineSeparator) {
218218
*
219219
* @param lineLength
220220
* Each line of encoded data will be at most of the given length (rounded down to nearest multiple of
221-
* 8). If lineLength <= 0, then the output will not be divided into lines (chunks). Ignored when
221+
* 8). If lineLength &lt;= 0, then the output will not be divided into lines (chunks). Ignored when
222222
* decoding.
223223
* @param lineSeparator
224224
* Each line of encoded data will end with this sequence of bytes.
225225
* @param useHex
226226
* if {@code true}, then use Base32 Hex alphabet, otherwise use Base32 alphabet
227227
* @throws IllegalArgumentException
228228
* The provided lineSeparator included some Base32 characters. That's not going to work! Or the
229-
* lineLength > 0 and lineSeparator is null.
229+
* lineLength &gt; 0 and lineSeparator is null.
230230
*/
231231
public Base32(final int lineLength, final byte[] lineSeparator, final boolean useHex) {
232232
super(BYTES_PER_UNENCODED_BLOCK, BYTES_PER_ENCODED_BLOCK,

‎src/main/java/org/apache/commons/codec/binary/Base32InputStream.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,11 +71,11 @@ public Base32InputStream(final InputStream in, final boolean doEncode) {
7171
* true if we should encode all data read from us, false if we should decode.
7272
* @param lineLength
7373
* If doEncode is true, each line of encoded data will contain lineLength characters (rounded down to
74-
* nearest multiple of 4). If lineLength <=0, the encoded data is not divided into lines. If doEncode is
74+
* nearest multiple of 4). If lineLength &lt;= 0, the encoded data is not divided into lines. If doEncode is
7575
* false, lineLength is ignored.
7676
* @param lineSeparator
7777
* If doEncode is true, each line of encoded data will be terminated with this byte sequence (e.g. \r\n).
78-
* If lineLength <= 0, the lineSeparator is not used. If doEncode is false lineSeparator is ignored.
78+
* If lineLength &lt;= 0, the lineSeparator is not used. If doEncode is false lineSeparator is ignored.
7979
*/
8080
public Base32InputStream(final InputStream in, final boolean doEncode,
8181
final int lineLength, final byte[] lineSeparator) {

‎src/main/java/org/apache/commons/codec/binary/Base32OutputStream.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,11 +71,11 @@ public Base32OutputStream(final OutputStream out, final boolean doEncode) {
7171
* true if we should encode all data written to us, false if we should decode.
7272
* @param lineLength
7373
* If doEncode is true, each line of encoded data will contain lineLength characters (rounded down to
74-
* nearest multiple of 4). If lineLength <=0, the encoded data is not divided into lines. If doEncode is
74+
* nearest multiple of 4). If lineLength &lt;= 0, the encoded data is not divided into lines. If doEncode is
7575
* false, lineLength is ignored.
7676
* @param lineSeparator
7777
* If doEncode is true, each line of encoded data will be terminated with this byte sequence (e.g. \r\n).
78-
* If lineLength <= 0, the lineSeparator is not used. If doEncode is false lineSeparator is ignored.
78+
* If lineLength &lt;= 0, the lineSeparator is not used. If doEncode is false lineSeparator is ignored.
7979
*/
8080
public Base32OutputStream(final OutputStream out, final boolean doEncode,
8181
final int lineLength, final byte[] lineSeparator) {

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -28,13 +28,13 @@
2828
* </p>
2929
* <p>
3030
* The class can be parameterized in the following manner with various constructors:
31+
* </p>
3132
* <ul>
3233
* <li>URL-safe mode: Default off.</li>
3334
* <li>Line length: Default 76. Line length that aren't multiples of 4 will still essentially end up being multiples of
3435
* 4 in the encoded data.
3536
* <li>Line separator: Default is CRLF ("\r\n")</li>
3637
* </ul>
37-
* </p>
3838
* <p>
3939
* Since this class operates directly on byte streams, and not character streams, it is hard-coded to only
4040
* encode/decode character encodings which are compatible with the lower 127 ASCII chart (ISO-8859-1, Windows-1252,
@@ -140,7 +140,7 @@ public class Base64 extends BaseNCodec {
140140
private final byte[] decodeTable = DECODE_TABLE;
141141

142142
/**
143-
* Line separator for encoding. Not used when decoding. Only used if lineLength > 0.
143+
* Line separator for encoding. Not used when decoding. Only used if lineLength &gt; 0.
144144
*/
145145
private final byte[] lineSeparator;
146146

@@ -204,7 +204,7 @@ public Base64(final boolean urlSafe) {
204204
*
205205
* @param lineLength
206206
* Each line of encoded data will be at most of the given length (rounded down to nearest multiple of
207-
* 4). If lineLength <= 0, then the output will not be divided into lines (chunks). Ignored when
207+
* 4). If lineLength &lt;= 0, then the output will not be divided into lines (chunks). Ignored when
208208
* decoding.
209209
* @since 1.4
210210
*/
@@ -227,7 +227,7 @@ public Base64(final int lineLength) {
227227
*
228228
* @param lineLength
229229
* Each line of encoded data will be at most of the given length (rounded down to nearest multiple of
230-
* 4). If lineLength <= 0, then the output will not be divided into lines (chunks). Ignored when
230+
* 4). If lineLength &lt;= 0, then the output will not be divided into lines (chunks). Ignored when
231231
* decoding.
232232
* @param lineSeparator
233233
* Each line of encoded data will end with this sequence of bytes.
@@ -254,7 +254,7 @@ public Base64(final int lineLength, final byte[] lineSeparator) {
254254
*
255255
* @param lineLength
256256
* Each line of encoded data will be at most of the given length (rounded down to nearest multiple of
257-
* 4). If lineLength <= 0, then the output will not be divided into lines (chunks). Ignored when
257+
* 4). If lineLength &lt;= 0, then the output will not be divided into lines (chunks). Ignored when
258258
* decoding.
259259
* @param lineSeparator
260260
* Each line of encoded data will end with this sequence of bytes.

‎src/main/java/org/apache/commons/codec/binary/Base64InputStream.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -75,11 +75,11 @@ public Base64InputStream(final InputStream in, final boolean doEncode) {
7575
* true if we should encode all data read from us, false if we should decode.
7676
* @param lineLength
7777
* If doEncode is true, each line of encoded data will contain lineLength characters (rounded down to
78-
* nearest multiple of 4). If lineLength <=0, the encoded data is not divided into lines. If doEncode is
78+
* nearest multiple of 4). If lineLength &lt;= 0, the encoded data is not divided into lines. If doEncode is
7979
* false, lineLength is ignored.
8080
* @param lineSeparator
8181
* If doEncode is true, each line of encoded data will be terminated with this byte sequence (e.g. \r\n).
82-
* If lineLength <= 0, the lineSeparator is not used. If doEncode is false lineSeparator is ignored.
82+
* If lineLength &lt;= 0, the lineSeparator is not used. If doEncode is false lineSeparator is ignored.
8383
*/
8484
public Base64InputStream(final InputStream in, final boolean doEncode,
8585
final int lineLength, final byte[] lineSeparator) {

‎src/main/java/org/apache/commons/codec/binary/Base64OutputStream.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -75,11 +75,11 @@ public Base64OutputStream(final OutputStream out, final boolean doEncode) {
7575
* true if we should encode all data written to us, false if we should decode.
7676
* @param lineLength
7777
* If doEncode is true, each line of encoded data will contain lineLength characters (rounded down to
78-
* nearest multiple of 4). If lineLength <=0, the encoded data is not divided into lines. If doEncode is
78+
* nearest multiple of 4). If lineLength &lt;= 0, the encoded data is not divided into lines. If doEncode is
7979
* false, lineLength is ignored.
8080
* @param lineSeparator
8181
* If doEncode is true, each line of encoded data will be terminated with this byte sequence (e.g. \r\n).
82-
* If lineLength <= 0, the lineSeparator is not used. If doEncode is false lineSeparator is ignored.
82+
* If lineLength &lt;= 0, the lineSeparator is not used. If doEncode is false lineSeparator is ignored.
8383
*/
8484
public Base64OutputStream(final OutputStream out, final boolean doEncode,
8585
final int lineLength, final byte[] lineSeparator) {

‎src/main/java/org/apache/commons/codec/binary/BaseNCodec.java‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ static class Context {
7979

8080
/**
8181
* Variable tracks how many characters have been written to the current line. Only used when encoding. We use
82-
* it to make sure each encoded line never goes beyond lineLength (if lineLength > 0).
82+
* it to make sure each encoded line never goes beyond lineLength (if lineLength &gt; 0).
8383
*/
8484
int currentLinePos;
8585

@@ -169,7 +169,7 @@ public String toString() {
169169
protected final int lineLength;
170170

171171
/**
172-
* Size of chunk separator. Not used unless {@link #lineLength} > 0.
172+
* Size of chunk separator. Not used unless {@link #lineLength} &gt; 0.
173173
*/
174174
private final int chunkSeparatorLength;
175175

@@ -487,7 +487,7 @@ protected boolean containsAlphabetOrPad(final byte[] arrayOctet) {
487487
* @param pArray byte[] array which will later be encoded
488488
*
489489
* @return amount of space needed to encoded the supplied array.
490-
* Returns a long since a max-len array will require > Integer.MAX_VALUE
490+
* Returns a long since a max-len array will require &gt; Integer.MAX_VALUE
491491
*/
492492
public long getEncodedLength(final byte[] pArray) {
493493
// Calculate non-chunked size - rounded up to allow for padding

0 commit comments

Comments
 (0)