Skip to content

Commit d8acbb0

Browse files
committed
Javadoc clean ups (especially @see tags)
git-svn-id: https://svn.apache.org/repos/asf/commons/proper/codec/trunk@1062642 13f79535-47bb-0310-9956-ffa450edef68
1 parent 6b08732 commit d8acbb0

1 file changed

Lines changed: 12 additions & 26 deletions

File tree

src/java/org/apache/commons/codec/language/ColognePhonetic.java

Lines changed: 12 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -23,18 +23,14 @@
2323
import org.apache.commons.codec.StringEncoder;
2424

2525
/**
26-
* <h1>ColognePhonetic</h1>
27-
*
2826
* <p>
29-
* <b>ColognePhonetic</b> provides an implementation of the <a
30-
* href="http://de.wikipedia.org/wiki/K%C3%B6lner_Phonetik">“Kölner
31-
* Phonetic”</a> (cologne phonetic) algorithm issued by Hans Joachim Postel in
32-
* 1969.
27+
* Implements of the <a href="http://de.wikipedia.org/wiki/K%C3%B6lner_Phonetik">“Kölner Phonetic”</a> (cologne
28+
* phonetic) algorithm issued by Hans Joachim Postel in 1969.
3329
* </p>
3430
*
3531
* <p>
36-
* The <i>Kölner Phonetik</i> is a phonetic algorithm which is optimized for the
37-
* German language. It is related to the well-known soundex algorithm.
32+
* The <i>Kölner Phonetik</i> is a phonetic algorithm which is optimized for the German language. It is related to the
33+
* well-known soundex algorithm.
3834
* </p>
3935
*
4036
* <h2>Algorithm</h2>
@@ -44,9 +40,8 @@
4440
* <li>
4541
* <h3>First step:</h3>
4642
* After a preprocessing (convertion to upper case, transcription of <a
47-
* href="http://en.wikipedia.org/wiki/Germanic_umlaut">germanic umlauts</a>,
48-
* removal of non alphabetical characters) the letters of the supplied text are
49-
* replaced by their phonetic code according to the folowing table.
43+
* href="http://en.wikipedia.org/wiki/Germanic_umlaut">germanic umlauts</a>, removal of non alphabetical characters) the
44+
* letters of the supplied text are replaced by their phonetic code according to the folowing table.
5045
* <table border="1">
5146
* <tbody>
5247
* <tr>
@@ -152,9 +147,8 @@
152147
* </tbody>
153148
* </table>
154149
* <p>
155-
* <small><i>(Source: <a href=
156-
* "http://de.wikipedia.org/wiki/K%C3%B6lner_Phonetik#Buchstabencodes"
157-
* >Wikipedia (de): Kölner Phonetik – Buchstabencodes</a>)</i></small>
150+
* <small><i>(Source: <a href= "http://de.wikipedia.org/wiki/K%C3%B6lner_Phonetik#Buchstabencodes" >Wikipedia (de):
151+
* Kölner Phonetik – Buchstabencodes</a>)</i></small>
158152
* </p>
159153
*
160154
* <h4>Example:</h4>
@@ -178,20 +172,12 @@
178172
*
179173
* </ul>
180174
*
181-
* @see<ul> <li><a
182-
* href="http://de.wikipedia.org/wiki/K%C3%B6lner_Phonetik"><span
183-
* style="font-variant:small-caps">Wikipedia</span> (de): <i>Kölner
184-
* Phonetik</i></a>—for German description of the algorithm and more
185-
* sources.</li> <li>{@linkplain #colognePhonetic(String)}—for the
186-
* description of the actual implementation</li> <li>
187-
* {@linkplain #isCologneEqual(String, String)}</li> <li>
188-
* {@linkplain StringEncoder}—for the interface implemented by this
189-
* class</li> </ul>
190-
*
175+
* @see <a href="http://de.wikipedia.org/wiki/K%C3%B6lner_Phonetik"><span
176+
* style="font-variant:small-caps">Wikipedia</span> (de): <i>Kölner Phonetik</i></a> (a German description of the
177+
* algorithm and more sources)
191178
* @author Apache Software Foundation
192-
* @version 1.5
179+
* @since 1.5
193180
*/
194-
195181
public class ColognePhonetic implements StringEncoder {
196182

197183
private class CologneLeftBuffer implements CharSequence {

0 commit comments

Comments
 (0)