commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ggreg...@apache.org
Subject cvs commit: jakarta-commons/lang/src/java/org/apache/commons/lang BitField.java
Date Fri, 22 Aug 2003 16:57:04 GMT
ggregory    2003/08/22 09:57:04

  Modified:    lang/src/java/org/apache/commons/lang BitField.java
  Log:
  Javadoc: Normalize on the active voice, "Returns", "Sets", etc.
  
  Revision  Changes    Path
  1.2       +19 -18    jakarta-commons/lang/src/java/org/apache/commons/lang/BitField.java
  
  Index: BitField.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/lang/src/java/org/apache/commons/lang/BitField.java,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- BitField.java	19 Aug 2003 02:32:15 -0000	1.1
  +++ BitField.java	22 Aug 2003 16:57:04 -0000	1.2
  @@ -54,7 +54,7 @@
   package org.apache.commons.lang;
   
   /**
  - * <p>Manage operations dealing with bit-mapped fields.</p>
  + * <p>Operations on bit-mapped fields.</p>
    *
    * @author Apache Jakarta POI
    * @author Scott Sanders (sanders at apache dot org)
  @@ -62,6 +62,7 @@
    * @author Andrew C. Oliver (acoliver at apache dot org)
    * @author Stephen Colebourne
    * @author Pete Gieser
  + * @author Gary Gregory
    * @since 2.0
    * @version $Id$
    */
  @@ -71,7 +72,7 @@
       private final int _shift_count;
   
       /**
  -     * <p>Create a BitField instance.</p>
  +     * <p>Creates a BitField instance.</p>
        *
        * @param mask the mask specifying which bits apply to this
        *  BitField. Bits that are set in this mask are the bits
  @@ -92,7 +93,7 @@
       }
   
       /**
  -     * <p>Obtain the value for the specified BitField, appropriately
  +     * <p>Obtains the value for the specified BitField, appropriately
        * shifted right.</p>
        *
        * <p>Many users of a BitField will want to treat the specified
  @@ -110,7 +111,7 @@
       }
   
       /**
  -     * <p>Obtain the value for the specified BitField, appropriately
  +     * <p>Obtains the value for the specified BitField, appropriately
        * shifted right, as a short.</p>
        *
        * <p>Many users of a BitField will want to treat the specified
  @@ -128,7 +129,7 @@
       }
   
       /**
  -     * <p>Obtain the value for the specified BitField, unshifted.</p>
  +     * <p>Obtains the value for the specified BitField, unshifted.</p>
        *
        * @param holder the int data containing the bits we're
        *  interested in
  @@ -139,7 +140,7 @@
       }
   
       /**
  -     * <p>Obtain the value for the specified BitField, unshifted.</p>
  +     * <p>Obtains the value for the specified BitField, unshifted.</p>
        *
        * @param holder the short data containing the bits we're
        *  interested in
  @@ -183,7 +184,7 @@
       }
   
       /**
  -     * <p>Replace the bits with new values.</p>
  +     * <p>Replaces the bits with new values.</p>
        *
        * @see #getValue
        * @param holder the int data containint the bits we're
  @@ -197,7 +198,7 @@
       }
   
       /**
  -     * <p>Replace the bits with new values.</p>
  +     * <p>Replaces the bits with new values.</p>
        *
        * @see #getShortValue
        * @param holder the short data containing the bits we're
  @@ -211,7 +212,7 @@
       }
   
       /**
  -     * <p>Clear the bits.</p>
  +     * <p>Clears the bits.</p>
        *
        * @param holder the int data containing the bits we're
        *  interested in
  @@ -223,7 +224,7 @@
       }
   
       /**
  -     * <p>Clear the bits.</p>
  +     * <p>Clears the bits.</p>
        *
        * @param holder the short data containing the bits we're
        *  interested in
  @@ -235,7 +236,7 @@
       }
   
       /**
  -     * <p>Clear the bits.</p>
  +     * <p>Clears the bits.</p>
        *
        * @param holder the byte data containing the bits we're
        *  interested in
  @@ -248,7 +249,7 @@
       }
   
       /**
  -     * <p>Set the bits.</p>
  +     * <p>Sets the bits.</p>
        *
        * @param holder the int data containing the bits we're
        *  interested in
  @@ -260,7 +261,7 @@
       }
   
       /**
  -     * <p>Set the bits.</p>
  +     * <p>Sets the bits.</p>
        *
        * @param holder the short data containing the bits we're
        *  interested in
  @@ -272,7 +273,7 @@
       }
   
       /**
  -     * <p>Set the bits.</p>
  +     * <p>Sets the bits.</p>
        *
        * @param holder the byte data containing the bits we're
        *  interested in
  @@ -285,7 +286,7 @@
       }
   
       /**
  -     * <p>Set a boolean BitField.</p>
  +     * <p>Sets a boolean BitField.</p>
        *
        * @param holder the int data containing the bits we're
        *  interested in
  @@ -298,7 +299,7 @@
       }
   
       /**
  -     * <p>Set a boolean BitField.</p>
  +     * <p>Sets a boolean BitField.</p>
        *
        * @param holder the short data containing the bits we're
        *  interested in
  @@ -311,7 +312,7 @@
       }
   
       /**
  -     * <p>Set a boolean BitField.</p>
  +     * <p>Sets a boolean BitField.</p>
        *
        * @param holder the byte data containing the bits we're
        *  interested in
  
  
  

Mime
View raw message