Skip to content

Commit 555b2b5

Browse files
committed
Javadoc cleanup, removal of leading paragraph.
git-svn-id: https://svn.apache.org/repos/asf/commons/proper/codec/trunk@1376686 13f79535-47bb-0310-9956-ffa450edef68
1 parent f3d0617 commit 555b2b5

7 files changed

Lines changed: 33 additions & 61 deletions

File tree

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

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -18,14 +18,12 @@
1818
package org.apache.commons.codec;
1919

2020
/**
21-
* <p>Provides the highest level of abstraction for Decoders.
22-
* This is the sister interface of {@link Encoder}. All
23-
* Decoders implement this common generic interface.</p>
24-
*
25-
* <p>Allows a user to pass a generic Object to any Decoder
26-
* implementation in the codec package.</p>
27-
*
28-
* <p>One of the two interfaces at the center of the codec package.</p>
21+
* Provides the highest level of abstraction for Decoders.
22+
* <p>
23+
* This is the sister interface of {@link Encoder}. All Decoders implement this common generic interface.
24+
* Allows a user to pass a generic Object to any Decoder implementation in the codec package.
25+
* <p>
26+
* One of the two interfaces at the center of the codec package.
2927
*
3028
* @version $Id$
3129
*/

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

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,11 @@
1818
package org.apache.commons.codec;
1919

2020
/**
21-
* <p>Provides the highest level of abstraction for Encoders.
22-
* This is the sister interface of {@link Decoder}. Every implementation of
23-
* Encoder provides this common generic interface which allows a user to pass a
24-
* generic Object to any Encoder implementation in the codec package.</p>
21+
* Provides the highest level of abstraction for Encoders.
22+
* <p>
23+
* This is the sister interface of {@link Decoder}. Every implementation of Encoder provides this
24+
* common generic interface which allows a user to pass a generic Object to any Encoder implementation
25+
* in the codec package.
2526
*
2627
* @version $Id$
2728
*/

src/main/java/org/apache/commons/codec/net/BCodec.java

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -29,18 +29,14 @@
2929
import org.apache.commons.codec.binary.Base64;
3030

3131
/**
32-
* <p>
33-
* Identical to the Base64 encoding defined by <a href="http://www.ietf.org/rfc/rfc1521.txt">RFC
34-
* 1521</a> and allows a character set to be specified.
35-
* </p>
36-
*
32+
* Identical to the Base64 encoding defined by <a href="http://www.ietf.org/rfc/rfc1521.txt">RFC 1521</a>
33+
* and allows a character set to be specified.
3734
* <p>
3835
* <a href="http://www.ietf.org/rfc/rfc1522.txt">RFC 1522</a> describes techniques to allow the encoding of non-ASCII
3936
* text in various portions of a RFC 822 [2] message header, in a manner which is unlikely to confuse existing message
4037
* handling software.
41-
* </p>
42-
*
43-
* <p>This class is immutable and thread-safe.</p>
38+
* <p>
39+
* This class is immutable and thread-safe.
4440
*
4541
* @see <a href="http://www.ietf.org/rfc/rfc1522.txt">MIME (Multipurpose Internet Mail Extensions) Part Two: Message
4642
* Header Extensions for Non-ASCII Text</a>

src/main/java/org/apache/commons/codec/net/QCodec.java

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -29,18 +29,14 @@
2929
import org.apache.commons.codec.StringEncoder;
3030

3131
/**
32-
* <p>
33-
* Similar to the Quoted-Printable content-transfer-encoding defined in <a
34-
* href="http://www.ietf.org/rfc/rfc1521.txt">RFC 1521</a> and designed to allow text containing mostly ASCII
32+
* Similar to the Quoted-Printable content-transfer-encoding defined in
33+
* <a href="http://www.ietf.org/rfc/rfc1521.txt">RFC 1521</a> and designed to allow text containing mostly ASCII
3534
* characters to be decipherable on an ASCII terminal without decoding.
36-
* </p>
37-
*
3835
* <p>
3936
* <a href="http://www.ietf.org/rfc/rfc1522.txt">RFC 1522</a> describes techniques to allow the encoding of non-ASCII
4037
* text in various portions of a RFC 822 [2] message header, in a manner which is unlikely to confuse existing message
4138
* handling software.
42-
* </p>
43-
*
39+
* <p>
4440
* This class is conditionally thread-safe.
4541
* The instance field {@link #encodeBlanks} is mutable {@link #setEncodeBlanks(boolean)}
4642
* but is not volatile, and accesses are not synchronised.

src/main/java/org/apache/commons/codec/net/QuotedPrintableCodec.java

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -33,29 +33,23 @@
3333
import org.apache.commons.codec.binary.StringUtils;
3434

3535
/**
36-
* <p>
3736
* Codec for the Quoted-Printable section of <a href="http://www.ietf.org/rfc/rfc1521.txt">RFC 1521</a>.
38-
* </p>
3937
* <p>
4038
* The Quoted-Printable encoding is intended to represent data that largely consists of octets that correspond to
4139
* printable characters in the ASCII character set. It encodes the data in such a way that the resulting octets are
4240
* unlikely to be modified by mail transport. If the data being encoded are mostly ASCII text, the encoded form of the
4341
* data remains largely recognizable by humans. A body which is entirely ASCII may also be encoded in Quoted-Printable
4442
* to ensure the integrity of the data should the message pass through a character- translating, and/or line-wrapping
4543
* gateway.
46-
* </p>
47-
*
4844
* <p>
4945
* Note:
50-
* </p>
5146
* <p>
5247
* Rules #3, #4, and #5 of the quoted-printable spec are not implemented yet because the complete quoted-printable spec
5348
* does not lend itself well into the byte[] oriented codec framework. Complete the codec once the streamable codec
5449
* framework is ready. The motivation behind providing the codec in a partial form is that it can already come in handy
5550
* for those applications that do not require quoted-printable line formatting (rules #3, #4, #5), for instance Q codec.
56-
* </p>
57-
*
58-
* <p>This class is immutable and thread-safe.</p>
51+
* <p>
52+
* This class is immutable and thread-safe.
5953
*
6054
* @see <a href="http://www.ietf.org/rfc/rfc1521.txt"> RFC 1521 MIME (Multipurpose Internet Mail Extensions) Part One:
6155
* Mechanisms for Specifying and Describing the Format of Internet Message Bodies </a>

src/main/java/org/apache/commons/codec/net/RFC1522Codec.java

Lines changed: 6 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -25,23 +25,16 @@
2525
import org.apache.commons.codec.binary.StringUtils;
2626

2727
/**
28-
* <p>
2928
* Implements methods common to all codecs defined in RFC 1522.
30-
* </p>
31-
*
3229
* <p>
33-
* <a href="http://www.ietf.org/rfc/rfc1522.txt">RFC 1522</a>
34-
* describes techniques to allow the encoding of non-ASCII text in
35-
* various portions of a RFC 822 [2] message header, in a manner which
30+
* <a href="http://www.ietf.org/rfc/rfc1522.txt">RFC 1522</a> describes techniques to allow the
31+
* encoding of non-ASCII text in various portions of a RFC 822 [2] message header, in a manner which
3632
* is unlikely to confuse existing message handling software.
37-
* </p>
38-
39-
* @see <a href="http://www.ietf.org/rfc/rfc1522.txt">
40-
* MIME (Multipurpose Internet Mail Extensions) Part Two:
41-
* Message Header Extensions for Non-ASCII Text</a>
42-
* </p>
33+
* <p>
34+
* This class is immutable and thread-safe.
4335
*
44-
* <p>This class is immutable and thread-safe.</p>
36+
* @see <a href="http://www.ietf.org/rfc/rfc1522.txt">MIME (Multipurpose Internet Mail Extensions) Part Two:
37+
* Message Header Extensions for Non-ASCII Text</a>
4538
*
4639
* @since 1.3
4740
* @version $Id$

src/main/java/org/apache/commons/codec/net/URLCodec.java

Lines changed: 7 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -31,22 +31,16 @@
3131
import org.apache.commons.codec.binary.StringUtils;
3232

3333
/**
34-
* <p>Implements the 'www-form-urlencoded' encoding scheme,
35-
* also misleadingly known as URL encoding.</p>
36-
*
37-
* <p>For more detailed information please refer to
38-
* <a href="http://www.w3.org/TR/html4/interact/forms.html#h-17.13.4.1">
39-
* Chapter 17.13.4 'Form content types'</a> of the
40-
* <a href="http://www.w3.org/TR/html4/">HTML 4.01 Specification<a></p>
41-
*
34+
* Implements the 'www-form-urlencoded' encoding scheme, also misleadingly known as URL encoding.
4235
* <p>
43-
* This codec is meant to be a replacement for standard Java classes
44-
* {@link java.net.URLEncoder} and {@link java.net.URLDecoder}
45-
* on older Java platforms, as these classes in Java versions below
36+
* This codec is meant to be a replacement for standard Java classes {@link java.net.URLEncoder} and
37+
* {@link java.net.URLDecoder} on older Java platforms, as these classes in Java versions below
4638
* 1.4 rely on the platform's default charset encoding.
47-
* </p>
39+
* <p>
40+
* This class is immutable and thread-safe.
4841
*
49-
* <p>This class is immutable and thread-safe.</p>
42+
* @see <a href="http://www.w3.org/TR/html4/interact/forms.html#h-17.13.4.1">Chapter 17.13.4 'Form content types'</a>
43+
* of the <a href="http://www.w3.org/TR/html4/">HTML 4.01 Specification<a>
5044
*
5145
* @since 1.2
5246
* @version $Id$

0 commit comments

Comments
 (0)