You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by ah...@apache.org on 2019/11/28 10:50:39 UTC
[commons-codec] 04/05: Remove javadoc references to non-visible
fields.
This is an automated email from the ASF dual-hosted git repository.
aherbert pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-codec.git
commit 242d3fec8cc32e08a01f03b03962161febb06425
Author: aherbert <ah...@apache.org>
AuthorDate: Thu Nov 28 10:44:58 2019 +0000
Remove javadoc references to non-visible fields.
---
src/main/java/org/apache/commons/codec/binary/BaseNCodec.java | 6 +++---
.../java/org/apache/commons/codec/language/DoubleMetaphone.java | 2 +-
src/main/java/org/apache/commons/codec/language/Metaphone.java | 2 +-
src/main/java/org/apache/commons/codec/language/Soundex.java | 9 +++------
src/main/java/org/apache/commons/codec/net/QCodec.java | 2 +-
5 files changed, 9 insertions(+), 12 deletions(-)
diff --git a/src/main/java/org/apache/commons/codec/binary/BaseNCodec.java b/src/main/java/org/apache/commons/codec/binary/BaseNCodec.java
index 4f24538..fb254e3 100644
--- a/src/main/java/org/apache/commons/codec/binary/BaseNCodec.java
+++ b/src/main/java/org/apache/commons/codec/binary/BaseNCodec.java
@@ -179,7 +179,7 @@ public abstract class BaseNCodec implements BinaryEncoder, BinaryDecoder {
private final int chunkSeparatorLength;
/**
- * Note <code>lineLength</code> is rounded down to the nearest multiple of {@link #encodedBlockSize}
+ * Note <code>lineLength</code> is rounded down to the nearest multiple of the encoded block size.
* If <code>chunkSeparatorLength</code> is zero, then chunking is disabled.
* @param unencodedBlockSize the size of an unencoded block (e.g. Base64 = 3)
* @param encodedBlockSize the size of an encoded block (e.g. Base64 = 4)
@@ -192,7 +192,7 @@ public abstract class BaseNCodec implements BinaryEncoder, BinaryDecoder {
}
/**
- * Note <code>lineLength</code> is rounded down to the nearest multiple of {@link #encodedBlockSize}
+ * Note <code>lineLength</code> is rounded down to the nearest multiple of the encoded block size.
* If <code>chunkSeparatorLength</code> is zero, then chunking is disabled.
* @param unencodedBlockSize the size of an unencoded block (e.g. Base64 = 3)
* @param encodedBlockSize the size of an encoded block (e.g. Base64 = 4)
@@ -234,7 +234,7 @@ public abstract class BaseNCodec implements BinaryEncoder, BinaryDecoder {
/**
* Get the default buffer size. Can be overridden.
*
- * @return {@link #DEFAULT_BUFFER_SIZE}
+ * @return the default buffer size.
*/
protected int getDefaultBufferSize() {
return DEFAULT_BUFFER_SIZE;
diff --git a/src/main/java/org/apache/commons/codec/language/DoubleMetaphone.java b/src/main/java/org/apache/commons/codec/language/DoubleMetaphone.java
index ede1e46..0d8640b 100644
--- a/src/main/java/org/apache/commons/codec/language/DoubleMetaphone.java
+++ b/src/main/java/org/apache/commons/codec/language/DoubleMetaphone.java
@@ -25,7 +25,7 @@ import org.apache.commons.codec.binary.StringUtils;
* Encodes a string into a double metaphone value. This Implementation is based on the algorithm by <CITE>Lawrence
* Philips</CITE>.
* <p>
- * This class is conditionally thread-safe. The instance field {@link #maxCodeLen} is mutable
+ * This class is conditionally thread-safe. The instance field for the maximum code length is mutable
* {@link #setMaxCodeLen(int)} but is not volatile, and accesses are not synchronized. If an instance of the class is
* shared between threads, the caller needs to ensure that suitable synchronization is used to ensure safe publication
* of the value between threads, and must not invoke {@link #setMaxCodeLen(int)} after initial setup.
diff --git a/src/main/java/org/apache/commons/codec/language/Metaphone.java b/src/main/java/org/apache/commons/codec/language/Metaphone.java
index ae4425a..b38a518 100644
--- a/src/main/java/org/apache/commons/codec/language/Metaphone.java
+++ b/src/main/java/org/apache/commons/codec/language/Metaphone.java
@@ -42,7 +42,7 @@ import org.apache.commons.codec.StringEncoder;
* For more information, see <a href="https://issues.apache.org/jira/browse/CODEC-57">CODEC-57</a>.
* <p>
* This class is conditionally thread-safe.
- * The instance field {@link #maxCodeLen} is mutable {@link #setMaxCodeLen(int)}
+ * The instance field for maximum code length is mutable {@link #setMaxCodeLen(int)}
* but is not volatile, and accesses are not synchronized.
* If an instance of the class is shared between threads, the caller needs to ensure that suitable synchronization
* is used to ensure safe publication of the value between threads, and must not invoke {@link #setMaxCodeLen(int)}
diff --git a/src/main/java/org/apache/commons/codec/language/Soundex.java b/src/main/java/org/apache/commons/codec/language/Soundex.java
index 5eac90c..0a4b767 100644
--- a/src/main/java/org/apache/commons/codec/language/Soundex.java
+++ b/src/main/java/org/apache/commons/codec/language/Soundex.java
@@ -24,9 +24,8 @@ import org.apache.commons.codec.StringEncoder;
* Encodes a string into a Soundex value. Soundex is an encoding used to relate similar names, but can also be used as a
* general purpose scheme to find word with similar phonemes.
*
- * This class is thread-safe.
- * Although not strictly immutable, the {@link #maxLength} field is not actually used.
- *
+ * <p>This class is thread-safe.
+ * Although not strictly immutable, the mutable fields are not actually used.</p>
*/
public class Soundex implements StringEncoder {
@@ -53,7 +52,6 @@ public class Soundex implements StringEncoder {
* <b>Note that letters H and W are treated specially.</b>
* They are ignored (after the first letter) and don't act as separators
* between consonants with the same code.
- * @see #US_ENGLISH_MAPPING
*/
// ABCDEFGHIJKLMNOPQRSTUVWXYZ
public static final String US_ENGLISH_MAPPING_STRING = "01230120022455012623010202";
@@ -72,7 +70,6 @@ public class Soundex implements StringEncoder {
* Apart from when they appear as the first letter, they are ignored.
* They don't act as separators between duplicate codes.
*
- * @see #US_ENGLISH_MAPPING
* @see #US_ENGLISH_MAPPING_STRING
*/
public static final Soundex US_ENGLISH = new Soundex();
@@ -133,7 +130,7 @@ public class Soundex implements StringEncoder {
* Creates an instance using US_ENGLISH_MAPPING
*
* @see Soundex#Soundex(char[])
- * @see Soundex#US_ENGLISH_MAPPING
+ * @see Soundex#US_ENGLISH_MAPPING_STRING
*/
public Soundex() {
this.soundexMapping = US_ENGLISH_MAPPING;
diff --git a/src/main/java/org/apache/commons/codec/net/QCodec.java b/src/main/java/org/apache/commons/codec/net/QCodec.java
index 221dac7..5f056df 100644
--- a/src/main/java/org/apache/commons/codec/net/QCodec.java
+++ b/src/main/java/org/apache/commons/codec/net/QCodec.java
@@ -37,7 +37,7 @@ import org.apache.commons.codec.StringEncoder;
* handling software.
* <p>
* This class is conditionally thread-safe.
- * The instance field {@link #encodeBlanks} is mutable {@link #setEncodeBlanks(boolean)}
+ * The instance field for encoding blanks is mutable {@link #setEncodeBlanks(boolean)}
* but is not volatile, and accesses are not synchronised.
* If an instance of the class is shared between threads, the caller needs to ensure that suitable synchronisation
* is used to ensure safe publication of the value between threads, and must not invoke