Skip to content

Commit 112463e

Browse files
committed
Javadoc typo
1 parent 43943fc commit 112463e

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

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

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@
3939
* accuracy in matching especially Slavish and Yiddish surnames with similar pronunciation but differences in spelling.
4040
* </p>
4141
* <p>
42-
* The main differences compared to the other soundex variants are:
42+
* The main differences compared to the other Soundex variants are:
4343
* </p>
4444
* <ul>
4545
* <li>coded names are 6 digits long
@@ -75,7 +75,7 @@ public class DaitchMokotoffSoundex implements StringEncoder {
7575
private static final char NUL = '\0';
7676

7777
/**
78-
* Inner class representing a branch during DM soundex encoding.
78+
* Inner class representing a branch during DM Soundex encoding.
7979
*/
8080
private static final class Branch {
8181
private final StringBuilder builder;
@@ -219,7 +219,7 @@ public String toString() {
219219
/** The resource file containing the replacement and folding rules */
220220
private static final String RESOURCE_FILE = "/org/apache/commons/codec/language/dmrules.txt";
221221

222-
/** The code length of a DM soundex value. */
222+
/** The code length of a DM Soundex value. */
223223
private static final int MAX_LENGTH = 6;
224224

225225
/** Transformation rules indexed by the first character of their pattern. */
@@ -353,7 +353,7 @@ public DaitchMokotoffSoundex(final boolean folding) {
353353
}
354354

355355
/**
356-
* Performs a cleanup of the input string before the actual soundex transformation.
356+
* Performs a cleanup of the input string before the actual Soundex transformation.
357357
* <p>
358358
* Removes all whitespace characters and performs ASCII folding if enabled.
359359
* </p>
@@ -380,7 +380,7 @@ private String cleanup(final String input) {
380380
}
381381

382382
/**
383-
* Encodes an Object using the Daitch-Mokotoff soundex algorithm without branching.
383+
* Encodes an Object using the Daitch-Mokotoff Soundex algorithm without branching.
384384
* <p>
385385
* This method is provided in order to satisfy the requirements of the Encoder interface, and will throw an
386386
* EncoderException if the supplied object is not of type {@link String}.
@@ -389,7 +389,7 @@ private String cleanup(final String input) {
389389
* @see #soundex(String)
390390
* @param obj
391391
* Object to encode
392-
* @return An object (of type {@link String}) containing the DM soundex code, which corresponds to the String
392+
* @return An object (of type {@link String}) containing the DM Soundex code, which corresponds to the String
393393
* supplied.
394394
* @throws EncoderException
395395
* if the parameter supplied is not of type {@link String}
@@ -406,7 +406,7 @@ public Object encode(final Object obj) throws EncoderException {
406406
}
407407

408408
/**
409-
* Encodes a String using the Daitch-Mokotoff soundex algorithm without branching.
409+
* Encodes a String using the Daitch-Mokotoff Soundex algorithm without branching.
410410
*
411411
* @see #soundex(String)
412412
* @param source
@@ -424,7 +424,7 @@ public String encode(final String source) {
424424
}
425425

426426
/**
427-
* Encodes a String using the Daitch-Mokotoff soundex algorithm with branching.
427+
* Encodes a String using the Daitch-Mokotoff Soundex algorithm with branching.
428428
* <p>
429429
* In case a string is encoded into multiple codes (see branching rules), the result will contain all codes,
430430
* separated by '|'.

0 commit comments

Comments
 (0)