commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ggreg...@apache.org
Subject svn commit: r1201514 - in /commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/bm: BeiderMorseEncoder.java Lang.java Languages.java PhoneticEngine.java
Date Sun, 13 Nov 2011 21:09:30 GMT
Author: ggregory
Date: Sun Nov 13 21:09:30 2011
New Revision: 1201514

URL: http://svn.apache.org/viewvc?rev=1201514&view=rev
Log:
Javadoc: Use the active voice and small typos.

Modified:
    commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/bm/BeiderMorseEncoder.java
    commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/bm/Lang.java
    commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/bm/Languages.java
    commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/bm/PhoneticEngine.java

Modified: commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/bm/BeiderMorseEncoder.java
URL: http://svn.apache.org/viewvc/commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/bm/BeiderMorseEncoder.java?rev=1201514&r1=1201513&r2=1201514&view=diff
==============================================================================
--- commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/bm/BeiderMorseEncoder.java
(original)
+++ commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/bm/BeiderMorseEncoder.java
Sun Nov 13 21:09:30 2011
@@ -78,7 +78,7 @@ import org.apache.commons.codec.StringEn
  * @since 1.6
  */
 public class BeiderMorseEncoder implements StringEncoder {
-    // implementation note: This class is a spring-friendly facade to PhoneticEngine. It
allows read/write configuration
+    // Implementation note: This class is a spring-friendly facade to PhoneticEngine. It
allows read/write configuration
     // of an immutable PhoneticEngine instance that will be delegated to for the actual encoding.
 
     // a cached object

Modified: commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/bm/Lang.java
URL: http://svn.apache.org/viewvc/commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/bm/Lang.java?rev=1201514&r1=1201513&r2=1201514&view=diff
==============================================================================
--- commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/bm/Lang.java
(original)
+++ commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/bm/Lang.java
Sun Nov 13 21:09:30 2011
@@ -71,7 +71,7 @@ import java.util.regex.Pattern;
  * @since 1.6
  */
 public class Lang {
-    // implementation note: This class is divided into two sections. The first part is a
static factory interface that
+    // Implementation note: This class is divided into two sections. The first part is a
static factory interface that
     // exposes the LANGUAGE_RULES_RN resource as a Lang instance. The second part is the
Lang instance methods that
     // encapsulate a particular language-guessing rule table and the language guessing itself.
     //

Modified: commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/bm/Languages.java
URL: http://svn.apache.org/viewvc/commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/bm/Languages.java?rev=1201514&r1=1201513&r2=1201514&view=diff
==============================================================================
--- commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/bm/Languages.java
(original)
+++ commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/bm/Languages.java
Sun Nov 13 21:09:30 2011
@@ -53,7 +53,7 @@ import java.util.Set;
  * @since 1.6
  */
 public class Languages {
-    // implementation note: This class is divided into two sections. The first part is a
static factory interface that
+    // Iimplementation note: This class is divided into two sections. The first part is a
static factory interface that
     // exposes org/apache/commons/codec/language/bm/%s_languages.txt for %s in NameType.*
as a list of supported
     // languages, and a second part that provides instance methods for accessing this set
fo supported languages.
 

Modified: commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/bm/PhoneticEngine.java
URL: http://svn.apache.org/viewvc/commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/bm/PhoneticEngine.java?rev=1201514&r1=1201513&r2=1201514&view=diff
==============================================================================
--- commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/bm/PhoneticEngine.java
(original)
+++ commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/bm/PhoneticEngine.java
Sun Nov 13 21:09:30 2011
@@ -79,7 +79,7 @@ public class PhoneticEngine {
         }
 
         /**
-         * Create a new phoneme builder containing all phonemes in this one extended by <code>str</code>.
+         * Creates a new phoneme builder containing all phonemes in this one extended by
<code>str</code>.
          *
          * @param str   the characters to append to the phonemes
          * @return  a new phoneme builder lenghened by <code>str</code>
@@ -95,7 +95,7 @@ public class PhoneticEngine {
         }
 
         /**
-         * Create a new phoneme builder containing the application of the expression to all
phonemes in this builder.
+         * Creates a new phoneme builder containing the application of the expression to
all phonemes in this builder.
          *
          * This will lengthen phonemes that have compatible language sets to the expression,
and drop those that are
          * incompatible.
@@ -120,7 +120,7 @@ public class PhoneticEngine {
         }
 
         /**
-         * The underlying phoneme set. Please don't mutate.
+         * Gets underlying phoneme set. Please don't mutate.
          *
          * @return  the phoneme set
          */
@@ -129,7 +129,7 @@ public class PhoneticEngine {
         }
 
         /**
-         * Stringify the phoneme set. This produces a single string of the strings of each
phoneme, joined with a pipe.
+         * Stringifies the phoneme set. This produces a single string of the strings of each
phoneme, joined with a pipe.
          * This is explicitly provied in place of toString as it is a potentially expensive
operation, which should be
          * avoided when debugging.
          *
@@ -189,8 +189,8 @@ public class PhoneticEngine {
         }
 
         /**
-         * This invokes the rules. It loops over the rules list, stopping at the first one
that has a matching context
-         * and pattern. It then applies this rule to the phoneme builder to produce updated
phonemes. If there was no
+         * Invokes the rules. Loops over the rules list, stopping at the first one that has
a matching context
+         * and pattern. Then applies this rule to the phoneme builder to produce updated
phonemes. If there was no
          * match, <code>i</code> is advanced one and the character is silently
dropped from the phonetic spelling.
          *
          * @return <code>this</code>
@@ -271,7 +271,7 @@ public class PhoneticEngine {
     }
 
     /**
-     * Join some strings with an internal separater.
+     * Joins some strings with an internal separator.
      * @param strings   Strings to join
      * @param sep       String to separate them with
      * @return          a single String consisting of each element of <code>strings</code>
interlieved by <code>sep</code>
@@ -318,7 +318,7 @@ public class PhoneticEngine {
     }
 
     /**
-     * Apply the final rules to convert from a language-specific phonetic representation
to a language-independent
+     * Applies the final rules to convert from a language-specific phonetic representation
to a language-independent
      * representation.
      *
      * @param phonemeBuilder



Mime
View raw message