Skip to content

Commit 4357dc9

Browse files
committed
Javadoc typo
1 parent fa89e5c commit 4357dc9

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

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

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@ public Soundex() {
146146
}
147147

148148
/**
149-
* Creates a soundex instance using the given mapping. This constructor can be used to provide an internationalized
149+
* Creates a Soundex instance using the given mapping. This constructor can be used to provide an internationalized
150150
* mapping for a non-Western character set.
151151
* <p>
152152
* Every letter of the alphabet is "mapped" to a numerical value. This char array holds the values to which each
@@ -165,7 +165,7 @@ public Soundex(final char[] mapping) {
165165
}
166166

167167
/**
168-
* Creates a refined soundex instance using a custom mapping. This constructor can be used to customize the mapping,
168+
* Creates a refined Soundex instance using a custom mapping. This constructor can be used to customize the mapping,
169169
* and/or possibly provide an internationalized mapping for a non-Western character set.
170170
* <p>
171171
* If the mapping contains an instance of {@link #SILENT_MARKER} then H and W are not given special treatment
@@ -181,7 +181,7 @@ public Soundex(final String mapping) {
181181
}
182182

183183
/**
184-
* Creates a refined soundex instance using a custom mapping. This constructor can be used to customize the mapping,
184+
* Creates a refined Soundex instance using a custom mapping. This constructor can be used to customize the mapping,
185185
* and/or possibly provide an internationalized mapping for a non-Western character set.
186186
*
187187
* @param mapping
@@ -217,12 +217,12 @@ public int difference(final String s1, final String s2) throws EncoderException
217217
}
218218

219219
/**
220-
* Encodes an Object using the soundex algorithm. This method is provided in order to satisfy the requirements of
220+
* Encodes an Object using the Soundex algorithm. This method is provided in order to satisfy the requirements of
221221
* the Encoder interface, and will throw an EncoderException if the supplied object is not of type {@link String}.
222222
*
223223
* @param obj
224224
* Object to encode
225-
* @return An object (or type {@link String}) containing the soundex code which corresponds to the String
225+
* @return An object (or type {@link String}) containing the Soundex code which corresponds to the String
226226
* supplied.
227227
* @throws EncoderException
228228
* if the parameter supplied is not of type {@link String}
@@ -238,7 +238,7 @@ public Object encode(final Object obj) throws EncoderException {
238238
}
239239

240240
/**
241-
* Encodes a String using the soundex algorithm.
241+
* Encodes a String using the Soundex algorithm.
242242
*
243243
* @param str
244244
* A String object to encode
@@ -305,7 +305,7 @@ public void setMaxLength(final int maxLength) {
305305
*
306306
* @param str
307307
* String to encode using the Soundex algorithm
308-
* @return A soundex code for the String supplied
308+
* @return A Soundex code for the String supplied
309309
* @throws IllegalArgumentException
310310
* if a character is not mapped
311311
*/

0 commit comments

Comments
 (0)