Skip to content

Commit 242d3fe

Browse files
committed
Remove javadoc references to non-visible fields.
1 parent 73c8b5e commit 242d3fe

5 files changed

Lines changed: 9 additions & 12 deletions

File tree

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -179,7 +179,7 @@ public String toString() {
179179
private final int chunkSeparatorLength;
180180

181181
/**
182-
* Note <code>lineLength</code> is rounded down to the nearest multiple of {@link #encodedBlockSize}
182+
* Note <code>lineLength</code> is rounded down to the nearest multiple of the encoded block size.
183183
* If <code>chunkSeparatorLength</code> is zero, then chunking is disabled.
184184
* @param unencodedBlockSize the size of an unencoded block (e.g. Base64 = 3)
185185
* @param encodedBlockSize the size of an encoded block (e.g. Base64 = 4)
@@ -192,7 +192,7 @@ protected BaseNCodec(final int unencodedBlockSize, final int encodedBlockSize,
192192
}
193193

194194
/**
195-
* Note <code>lineLength</code> is rounded down to the nearest multiple of {@link #encodedBlockSize}
195+
* Note <code>lineLength</code> is rounded down to the nearest multiple of the encoded block size.
196196
* If <code>chunkSeparatorLength</code> is zero, then chunking is disabled.
197197
* @param unencodedBlockSize the size of an unencoded block (e.g. Base64 = 3)
198198
* @param encodedBlockSize the size of an encoded block (e.g. Base64 = 4)
@@ -234,7 +234,7 @@ int available(final Context context) { // package protected for access from I/O
234234
/**
235235
* Get the default buffer size. Can be overridden.
236236
*
237-
* @return {@link #DEFAULT_BUFFER_SIZE}
237+
* @return the default buffer size.
238238
*/
239239
protected int getDefaultBufferSize() {
240240
return DEFAULT_BUFFER_SIZE;

src/main/java/org/apache/commons/codec/language/DoubleMetaphone.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
* Encodes a string into a double metaphone value. This Implementation is based on the algorithm by <CITE>Lawrence
2626
* Philips</CITE>.
2727
* <p>
28-
* This class is conditionally thread-safe. The instance field {@link #maxCodeLen} is mutable
28+
* This class is conditionally thread-safe. The instance field for the maximum code length is mutable
2929
* {@link #setMaxCodeLen(int)} but is not volatile, and accesses are not synchronized. If an instance of the class is
3030
* shared between threads, the caller needs to ensure that suitable synchronization is used to ensure safe publication
3131
* of the value between threads, and must not invoke {@link #setMaxCodeLen(int)} after initial setup.

src/main/java/org/apache/commons/codec/language/Metaphone.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@
4242
* For more information, see <a href="https://issues.apache.org/jira/browse/CODEC-57">CODEC-57</a>.
4343
* <p>
4444
* This class is conditionally thread-safe.
45-
* The instance field {@link #maxCodeLen} is mutable {@link #setMaxCodeLen(int)}
45+
* The instance field for maximum code length is mutable {@link #setMaxCodeLen(int)}
4646
* but is not volatile, and accesses are not synchronized.
4747
* If an instance of the class is shared between threads, the caller needs to ensure that suitable synchronization
4848
* is used to ensure safe publication of the value between threads, and must not invoke {@link #setMaxCodeLen(int)}

src/main/java/org/apache/commons/codec/language/Soundex.java

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,8 @@
2424
* Encodes a string into a Soundex value. Soundex is an encoding used to relate similar names, but can also be used as a
2525
* general purpose scheme to find word with similar phonemes.
2626
*
27-
* This class is thread-safe.
28-
* Although not strictly immutable, the {@link #maxLength} field is not actually used.
29-
*
27+
* <p>This class is thread-safe.
28+
* Although not strictly immutable, the mutable fields are not actually used.</p>
3029
*/
3130
public class Soundex implements StringEncoder {
3231

@@ -53,7 +52,6 @@ public class Soundex implements StringEncoder {
5352
* <b>Note that letters H and W are treated specially.</b>
5453
* They are ignored (after the first letter) and don't act as separators
5554
* between consonants with the same code.
56-
* @see #US_ENGLISH_MAPPING
5755
*/
5856
// ABCDEFGHIJKLMNOPQRSTUVWXYZ
5957
public static final String US_ENGLISH_MAPPING_STRING = "01230120022455012623010202";
@@ -72,7 +70,6 @@ public class Soundex implements StringEncoder {
7270
* Apart from when they appear as the first letter, they are ignored.
7371
* They don't act as separators between duplicate codes.
7472
*
75-
* @see #US_ENGLISH_MAPPING
7673
* @see #US_ENGLISH_MAPPING_STRING
7774
*/
7875
public static final Soundex US_ENGLISH = new Soundex();
@@ -133,7 +130,7 @@ public class Soundex implements StringEncoder {
133130
* Creates an instance using US_ENGLISH_MAPPING
134131
*
135132
* @see Soundex#Soundex(char[])
136-
* @see Soundex#US_ENGLISH_MAPPING
133+
* @see Soundex#US_ENGLISH_MAPPING_STRING
137134
*/
138135
public Soundex() {
139136
this.soundexMapping = US_ENGLISH_MAPPING;

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@
3737
* handling software.
3838
* <p>
3939
* This class is conditionally thread-safe.
40-
* The instance field {@link #encodeBlanks} is mutable {@link #setEncodeBlanks(boolean)}
40+
* The instance field for encoding blanks is mutable {@link #setEncodeBlanks(boolean)}
4141
* but is not volatile, and accesses are not synchronised.
4242
* If an instance of the class is shared between threads, the caller needs to ensure that suitable synchronisation
4343
* is used to ensure safe publication of the value between threads, and must not invoke

0 commit comments

Comments
 (0)