Skip to content

Commit 1092079

Browse files
committed
[CODEC-123] ColognePhonetic Javadoc should use HTML entities for special characters.
git-svn-id: https://svn.apache.org/repos/asf/commons/proper/codec/trunk@1124223 13f79535-47bb-0310-9956-ffa450edef68
1 parent 94a565c commit 1092079

1 file changed

Lines changed: 7 additions & 7 deletions

File tree

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

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -27,12 +27,12 @@
2727
* Encodes a string into a Cologne Phonetic value.
2828
* </p>
2929
* <p>
30-
* Implements the <a href="http://de.wikipedia.org/wiki/K%C3%B6lner_Phonetik">“Kölner Phonetic�</a> (Cologne Phonetic)
30+
* Implements the <a href="http://de.wikipedia.org/wiki/K%C3%B6lner_Phonetik">K&ouml;lner Phonetik</a> (Cologne Phonetic)
3131
* algorithm issued by Hans Joachim Postel in 1969.
3232
* </p>
3333
*
3434
* <p>
35-
* The <i>Kölner Phonetik</i> is a phonetic algorithm which is optimized for the German language. It is related to the
35+
* The <i>K&ouml;lner Phonetik</i> is a phonetic algorithm which is optimized for the German language. It is related to the
3636
* well-known soundex algorithm.
3737
* </p>
3838
*
@@ -151,12 +151,12 @@
151151
* </table>
152152
* <p>
153153
* <small><i>(Source: <a href= "http://de.wikipedia.org/wiki/K%C3%B6lner_Phonetik#Buchstabencodes" >Wikipedia (de):
154-
* Kölner Phonetik – Buchstabencodes</a>)</i></small>
154+
* K&ouml;lner Phonetik -- Buchstabencodes</a>)</i></small>
155155
* </p>
156156
*
157157
* <h4>Example:</h4>
158158
*
159-
* {@code "Müller-Lüdenscheidt" => "MULLERLUDENSCHEIDT" => "6005507500206880022"}
159+
* {@code "M}&uuml;{@code ller-L}&uuml;{@code denscheidt" => "MULLERLUDENSCHEIDT" => "6005507500206880022"}
160160
*
161161
* </li>
162162
*
@@ -168,15 +168,15 @@
168168
*
169169
* <li>
170170
* <h3>Step 3:</h3>
171-
* Removal of all codes “0� except at the beginning. This means that two or more identical consecutive digits can occur
171+
* Removal of all codes "0" except at the beginning. This means that two or more identical consecutive digits can occur
172172
* if they occur after removing the "0" digits.
173173
*
174174
* <h4>Example:</h4>
175175
* {@code "6050750206802" => "65752682"}</li>
176176
*
177177
* </ul>
178178
*
179-
* @see <a href="http://de.wikipedia.org/wiki/K%C3%B6lner_Phonetik">Wikipedia (de): Kölner Phonetik (in German)</a>
179+
* @see <a href="http://de.wikipedia.org/wiki/K%C3%B6lner_Phonetik">Wikipedia (de): K&ouml;lner Phonetik (in German)</a>
180180
* @author Apache Software Foundation
181181
* @since 1.5
182182
*/
@@ -282,7 +282,7 @@ private static boolean arrayContains(char[] arr, char key) {
282282

283283
/**
284284
* <p>
285-
* <b>colognePhonetic()</b> is the actual implementations of the <i>Kölner Phonetik</i> algorithm.
285+
* Implements the <i>K&ouml;lner Phonetik</i> algorithm.
286286
* </p>
287287
* <p>
288288
* In contrast to the initial description of the algorithm, this implementation does the encoding in one pass.

0 commit comments

Comments
 (0)