Skip to content

Commit 38cc09c

Browse files
committed
Fix Javadoc 8 errors.
git-svn-id: https://svn.apache.org/repos/asf/commons/proper/codec/trunk@1636492 13f79535-47bb-0310-9956-ffa450edef68
1 parent 2118816 commit 38cc09c

1 file changed

Lines changed: 14 additions & 3 deletions

File tree

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

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,10 @@
3737
* <p>
3838
* The Daitch-Mokotoff Soundex algorithm is a refinement of the Russel and American Soundex algorithms, yielding greater
3939
* accuracy in matching especially Slavish and Yiddish surnames with similar pronunciation but differences in spelling.
40+
* </p>
4041
* <p>
4142
* The main differences compared to the other soundex variants are:
43+
* </p>
4244
* <ul>
4345
* <li>coded names are 6 digits long
4446
* <li>the initial character of the name is coded
@@ -55,8 +57,10 @@
5557
* Note: this implementation has additional branching rules compared to the original description of the algorithm. The
5658
* rules can be customized by overriding the default rules contained in the resource file
5759
* {@code org/apache/commons/codec/language/dmrules.txt}.
60+
* </p>
5861
* <p>
5962
* This class is thread-safe.
63+
* </p>
6064
*
6165
* @see Soundex
6266
* @see <a href="http://en.wikipedia.org/wiki/Daitch%E2%80%93Mokotoff_Soundex"> Wikipedia - Daitch-Mokotoff Soundex</a>
@@ -351,6 +355,7 @@ public DaitchMokotoffSoundex() {
351355
* <p>
352356
* With ASCII-folding enabled, certain accented characters will be transformed to equivalent ASCII characters, e.g.
353357
* è -&gt; e.
358+
* </p>
354359
*
355360
* @param folding
356361
* if ASCII-folding shall be performed before encoding
@@ -363,6 +368,7 @@ public DaitchMokotoffSoundex(final boolean folding) {
363368
* Performs a cleanup of the input string before the actual soundex transformation.
364369
* <p>
365370
* Removes all whitespace characters and performs ASCII folding if enabled.
371+
* </p>
366372
*
367373
* @param input
368374
* the input string to cleanup
@@ -391,6 +397,7 @@ private String cleanup(final String input) {
391397
* <p>
392398
* This method is provided in order to satisfy the requirements of the Encoder interface, and will throw an
393399
* EncoderException if the supplied object is not of type java.lang.String.
400+
* </p>
394401
*
395402
* @see #soundex(String)
396403
*
@@ -417,7 +424,7 @@ public Object encode(final Object obj) throws EncoderException {
417424
*
418425
* @see #soundex(String)
419426
*
420-
* @param str
427+
* @param source
421428
* A String object to encode
422429
* @return A DM Soundex code corresponding to the String supplied
423430
* @throws IllegalArgumentException
@@ -438,15 +445,19 @@ public String encode(final String source) {
438445
* <p>
439446
* In case a string is encoded into multiple codes (see branching rules), the result will contain all codes,
440447
* separated by '|'.
448+
* </p>
441449
* <p>
442450
* Example: the name "AUERBACH" is encoded as both
451+
* </p>
443452
* <ul>
444453
* <li>097400</li>
445454
* <li>097500</li>
446455
* </ul>
456+
* <p>
447457
* Thus the result will be "097400|097500".
458+
* </p>
448459
*
449-
* @param str
460+
* @param source
450461
* A String object to encode
451462
* @return A string containing a set of DM Soundex codes corresponding to the String supplied
452463
* @throws IllegalArgumentException
@@ -466,7 +477,7 @@ public String soundex(final String source) {
466477
}
467478

468479
/**
469-
* Perform the actual DM soundex algorithm on the input string.
480+
* Perform the actual DM Soundex algorithm on the input string.
470481
*
471482
* @param source
472483
* A String object to encode

0 commit comments

Comments
 (0)