@@ -146,7 +146,7 @@ public Soundex() {
146
146
}
147
147
148
148
/**
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
150
150
* mapping for a non-Western character set.
151
151
* <p>
152
152
* 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) {
165
165
}
166
166
167
167
/**
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,
169
169
* and/or possibly provide an internationalized mapping for a non-Western character set.
170
170
* <p>
171
171
* 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) {
181
181
}
182
182
183
183
/**
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,
185
185
* and/or possibly provide an internationalized mapping for a non-Western character set.
186
186
*
187
187
* @param mapping
@@ -217,12 +217,12 @@ public int difference(final String s1, final String s2) throws EncoderException
217
217
}
218
218
219
219
/**
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
221
221
* the Encoder interface, and will throw an EncoderException if the supplied object is not of type {@link String}.
222
222
*
223
223
* @param obj
224
224
* 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
226
226
* supplied.
227
227
* @throws EncoderException
228
228
* if the parameter supplied is not of type {@link String}
@@ -238,7 +238,7 @@ public Object encode(final Object obj) throws EncoderException {
238
238
}
239
239
240
240
/**
241
- * Encodes a String using the soundex algorithm.
241
+ * Encodes a String using the Soundex algorithm.
242
242
*
243
243
* @param str
244
244
* A String object to encode
@@ -305,7 +305,7 @@ public void setMaxLength(final int maxLength) {
305
305
*
306
306
* @param str
307
307
* 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
309
309
* @throws IllegalArgumentException
310
310
* if a character is not mapped
311
311
*/
0 commit comments