Skip to content

Commit 0a22409

Browse files
committed
Javadoc: Use the active voice and small typos.
git-svn-id: https://svn.apache.org/repos/asf/commons/proper/codec/trunk@1201514 13f79535-47bb-0310-9956-ffa450edef68
1 parent b5657da commit 0a22409

4 files changed

Lines changed: 11 additions & 11 deletions

File tree

src/main/java/org/apache/commons/codec/language/bm/BeiderMorseEncoder.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@
7878
* @since 1.6
7979
*/
8080
public class BeiderMorseEncoder implements StringEncoder {
81-
// implementation note: This class is a spring-friendly facade to PhoneticEngine. It allows read/write configuration
81+
// Implementation note: This class is a spring-friendly facade to PhoneticEngine. It allows read/write configuration
8282
// of an immutable PhoneticEngine instance that will be delegated to for the actual encoding.
8383

8484
// a cached object

src/main/java/org/apache/commons/codec/language/bm/Lang.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@
7171
* @since 1.6
7272
*/
7373
public class Lang {
74-
// implementation note: This class is divided into two sections. The first part is a static factory interface that
74+
// Implementation note: This class is divided into two sections. The first part is a static factory interface that
7575
// exposes the LANGUAGE_RULES_RN resource as a Lang instance. The second part is the Lang instance methods that
7676
// encapsulate a particular language-guessing rule table and the language guessing itself.
7777
//

src/main/java/org/apache/commons/codec/language/bm/Languages.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@
5353
* @since 1.6
5454
*/
5555
public class Languages {
56-
// implementation note: This class is divided into two sections. The first part is a static factory interface that
56+
// Iimplementation note: This class is divided into two sections. The first part is a static factory interface that
5757
// exposes org/apache/commons/codec/language/bm/%s_languages.txt for %s in NameType.* as a list of supported
5858
// languages, and a second part that provides instance methods for accessing this set fo supported languages.
5959

src/main/java/org/apache/commons/codec/language/bm/PhoneticEngine.java

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ private PhonemeBuilder(Set<Rule.Phoneme> phonemes) {
7979
}
8080

8181
/**
82-
* Create a new phoneme builder containing all phonemes in this one extended by <code>str</code>.
82+
* Creates a new phoneme builder containing all phonemes in this one extended by <code>str</code>.
8383
*
8484
* @param str the characters to append to the phonemes
8585
* @return a new phoneme builder lenghened by <code>str</code>
@@ -95,7 +95,7 @@ public PhonemeBuilder append(CharSequence str) {
9595
}
9696

9797
/**
98-
* Create a new phoneme builder containing the application of the expression to all phonemes in this builder.
98+
* Creates a new phoneme builder containing the application of the expression to all phonemes in this builder.
9999
*
100100
* This will lengthen phonemes that have compatible language sets to the expression, and drop those that are
101101
* incompatible.
@@ -120,7 +120,7 @@ public PhonemeBuilder apply(Rule.PhonemeExpr phonemeExpr) {
120120
}
121121

122122
/**
123-
* The underlying phoneme set. Please don't mutate.
123+
* Gets underlying phoneme set. Please don't mutate.
124124
*
125125
* @return the phoneme set
126126
*/
@@ -129,7 +129,7 @@ public Set<Rule.Phoneme> getPhonemes() {
129129
}
130130

131131
/**
132-
* Stringify the phoneme set. This produces a single string of the strings of each phoneme, joined with a pipe.
132+
* Stringifies the phoneme set. This produces a single string of the strings of each phoneme, joined with a pipe.
133133
* This is explicitly provied in place of toString as it is a potentially expensive operation, which should be
134134
* avoided when debugging.
135135
*
@@ -189,8 +189,8 @@ public PhonemeBuilder getPhonemeBuilder() {
189189
}
190190

191191
/**
192-
* This invokes the rules. It loops over the rules list, stopping at the first one that has a matching context
193-
* and pattern. It then applies this rule to the phoneme builder to produce updated phonemes. If there was no
192+
* Invokes the rules. Loops over the rules list, stopping at the first one that has a matching context
193+
* and pattern. Then applies this rule to the phoneme builder to produce updated phonemes. If there was no
194194
* match, <code>i</code> is advanced one and the character is silently dropped from the phonetic spelling.
195195
*
196196
* @return <code>this</code>
@@ -271,7 +271,7 @@ public CharSequence subSequence(int start, int end) {
271271
}
272272

273273
/**
274-
* Join some strings with an internal separater.
274+
* Joins some strings with an internal separator.
275275
* @param strings Strings to join
276276
* @param sep String to separate them with
277277
* @return a single String consisting of each element of <code>strings</code> interlieved by <code>sep</code>
@@ -318,7 +318,7 @@ public PhoneticEngine(NameType nameType, RuleType ruleType, boolean concat) {
318318
}
319319

320320
/**
321-
* Apply the final rules to convert from a language-specific phonetic representation to a language-independent
321+
* Applies the final rules to convert from a language-specific phonetic representation to a language-independent
322322
* representation.
323323
*
324324
* @param phonemeBuilder

0 commit comments

Comments
 (0)