Skip to content

Commit 81df57c

Browse files
committed
Javadoc
1 parent 6ef32f5 commit 81df57c

1 file changed

Lines changed: 6 additions & 11 deletions

File tree

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

Lines changed: 6 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -183,9 +183,8 @@
183183
public class ColognePhonetic implements StringEncoder {
184184

185185
/**
186-
* This class is not thread-safe; the field {@link #length} is mutable.
187-
* However, it is not shared between threads, as it is constructed on demand
188-
* by the method {@link ColognePhonetic#colognePhonetic(String)}
186+
* This class is not thread-safe; the field {@link #length} is mutable. However, it is not shared between threads, as it is constructed on demand by the
187+
* method {@link ColognePhonetic#colognePhonetic(String)}.
189188
*/
190189
private abstract static class CologneBuffer {
191190

@@ -262,10 +261,8 @@ protected char[] copyData(final int start, final int length) {
262261
}
263262

264263
/**
265-
* Stores the next code in the output buffer, keeping track of the previous code.
266-
* '0' is only stored if it is the first entry.
267-
* Ignored chars are never stored.
268-
* If the code is the same as the last code (whether stored or not) it is not stored.
264+
* Stores the next code in the output buffer, keeping track of the previous code. '0' is only stored if it is the first entry. Ignored chars are never
265+
* stored. If the code is the same as the last code (whether stored or not) it is not stored.
269266
*
270267
* @param code the code to store.
271268
*/
@@ -418,16 +415,14 @@ public String encode(final String text) {
418415
*
419416
* @param text1 source text to encode before testing for equality.
420417
* @param text2 source text to encode before testing for equality.
421-
* @return {@code true} if the encoding the first string equals the encoding of the second string, {@code false}
422-
* otherwise.
418+
* @return {@code true} if the encoding the first string equals the encoding of the second string, {@code false} otherwise.
423419
*/
424420
public boolean isEncodeEqual(final String text1, final String text2) {
425421
return colognePhonetic(text1).equals(colognePhonetic(text2));
426422
}
427423

428424
/**
429-
* Converts the string to upper case and replaces Germanic umlaut characters
430-
* The following characters are mapped:
425+
* Converts the string to upper case and replaces Germanic umlaut characters The following characters are mapped:
431426
* <ul>
432427
* <li>capital A, umlaut mark</li>
433428
* <li>capital U, umlaut mark</li>

0 commit comments

Comments
 (0)