commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From m..@apache.org
Subject cvs commit: jakarta-commons/collections/src/java/org/apache/commons/collections/comparators TransformingComparator.java
Date Sun, 16 Jun 2002 03:39:40 GMT
mas         2002/06/15 20:39:40

  Modified:    collections/src/java/org/apache/commons/collections
                        CursorableLinkedList.java DefaultMapEntry.java
                        LazyCollections.java PredicateUtils.java
               collections/src/java/org/apache/commons/collections/comparators
                        TransformingComparator.java
  Log:
  Fixed javadoc warnings, most of which only appear with javadoc 1.4.  I
  really don't understand why javadoc likes references to inner classes in
  some cases, but in others, it requires it to be fully qualified.  This
  fixes all the warnings reported though.
  
  Revision  Changes    Path
  1.8       +17 -10    jakarta-commons/collections/src/java/org/apache/commons/collections/CursorableLinkedList.java
  
  Index: CursorableLinkedList.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/CursorableLinkedList.java,v
  retrieving revision 1.7
  retrieving revision 1.8
  diff -u -r1.7 -r1.8
  --- CursorableLinkedList.java	15 Jun 2002 03:52:24 -0000	1.7
  +++ CursorableLinkedList.java	16 Jun 2002 03:39:40 -0000	1.8
  @@ -743,7 +743,8 @@
        * list, after the specified <i>before</i> element, and before the
        * specified <i>after</i> element
        *
  -     * @returns the newly created {@link CursorableLinkedList.Listable}
  +     * @return the newly created 
  +     * {@link org.apache.commons.collections.CursorableLinkedList.Listable}
        */
       protected Listable insertListable(Listable before, Listable after, Object value) {
           _modCount++;
  @@ -765,7 +766,9 @@
       }
   
       /**
  -     * Removes the given {@link CursorableLinkedList.Listable} from my list.
  +     * Removes the given 
  +     * {@link org.apache.commons.collections.CursorableLinkedList.Listable} 
  +     * from my list.
        */
       protected void removeListable(Listable elt) {
           _modCount++;
  @@ -786,8 +789,10 @@
       }
   
       /**
  -     * Returns the {@link CursorableLinkedList.Listable} at the specified
  -     * index.
  +     * Returns the 
  +     * {@link org.apache.commons.collections.CursorableLinkedList.Listable} 
  +     * at the specified index.
  +     *
        * @throws IndexOutOfBoundsException if index is less than zero or
        *         greater than or equal to the size of this list.
        */
  @@ -905,7 +910,9 @@
        * <tt>_head.next().prev()</tt> and <tt>_head.prev().next()</tt>
to be
        * non-null, as when I am a sublist for some larger list.
        * Use <tt>== _head.next()</tt> and <tt>== _head.prev()</tt>
to determine
  -     * if a given {@link CursorableLinkedList.Listable} is the first or last element in
the list.
  +     * if a given 
  +     * {@link org.apache.commons.collections.CursorableLinkedList.Listable} 
  +     * is the first or last element in the list.
        */
       transient protected Listable _head = new Listable(null,null,null);
   
  @@ -1354,7 +1361,7 @@
        * list, after the specified <i>before</i> element, and before the
        * specified <i>after</i> element
        *
  -     * @returns the newly created {@link CursorableLinkedList.Listable}
  +     * @return the newly created {@link CursorableLinkedList.Listable}
        */
       protected Listable insertListable(Listable before, Listable after, Object value) {
           _modCount++;
  
  
  
  1.7       +8 -7      jakarta-commons/collections/src/java/org/apache/commons/collections/DefaultMapEntry.java
  
  Index: DefaultMapEntry.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/DefaultMapEntry.java,v
  retrieving revision 1.6
  retrieving revision 1.7
  diff -u -r1.6 -r1.7
  --- DefaultMapEntry.java	12 Jun 2002 03:59:15 -0000	1.6
  +++ DefaultMapEntry.java	16 Jun 2002 03:39:40 -0000	1.7
  @@ -61,9 +61,8 @@
   package org.apache.commons.collections;
   
   import java.util.Map;
  -import java.util.Map.Entry; // to keep javadoc from spewing warnings
   
  -/** A default implementation of {@link Map.Entry}
  +/** A default implementation of {@link java.util.Map.Entry}
     *
     * @since 1.0
     * @author <a href="mailto:jstrachan@apache.org">James Strachan</a>
  @@ -84,7 +83,8 @@
       }
   
       /**
  -     *  Implemented per API documentation of {@link Map.Entry#equals(Object)}
  +     *  Implemented per API documentation of 
  +     *  {@link java.util.Map.Entry#equals(Object)}
        **/
       public boolean equals(Object o) {
           if( o == null ) return false;
  @@ -101,7 +101,8 @@
        
        
       /**
  -     *  Implemented per API documentation of {@link Map.Entry#hashCode()}
  +     *  Implemented per API documentation of 
  +     *  {@link java.util.Map.Entry#hashCode()}
        **/
       public int hashCode() {
           return ( ( getKey() == null ? 0 : getKey().hashCode() ) ^
  
  
  
  1.3       +5 -9      jakarta-commons/collections/src/java/org/apache/commons/collections/LazyCollections.java
  
  Index: LazyCollections.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/LazyCollections.java,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- LazyCollections.java	29 May 2002 03:22:42 -0000	1.2
  +++ LazyCollections.java	16 Jun 2002 03:39:40 -0000	1.3
  @@ -76,10 +76,6 @@
    * new class built from an empty constructor, then all you need to provide is
    * the class definition.
    *
  - * @see org.apache.commons.collections.LazyList
  - * @see org.apache.commons.collections.LazyMap
  - * @see org.apache.commons.collections.LazySortedMap
  - *
    * @author Arron Bates
    * @version $Revision$
    */
  @@ -590,4 +586,4 @@
         return ((SortedMap)super.mapImpl).lastKey();
       }
     }
  -}
  \ No newline at end of file
  +}
  
  
  
  1.2       +6 -6      jakarta-commons/collections/src/java/org/apache/commons/collections/PredicateUtils.java
  
  Index: PredicateUtils.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/PredicateUtils.java,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- PredicateUtils.java	2 May 2002 06:17:19 -0000	1.1
  +++ PredicateUtils.java	16 Jun 2002 03:39:40 -0000	1.2
  @@ -1116,21 +1116,21 @@
   	    }
   	    
           /**
  -         * @see Map.Entry#getKey()
  +         * @see java.util.Map.Entry#getKey()
            */
           public Object getKey() {
               return iEntry.getKey();
           }
   
           /**
  -         * @see Map.Entry#getValue()
  +         * @see java.util.Map.Entry#getValue()
            */
           public Object getValue() {
               return iEntry.getValue();
           }
   
           /**
  -         * @see Map.Entry#setValue()
  +         * @see java.util.Map.Entry#setValue(Object)
            */
           public Object setValue(Object object) {
               validate(iValuePredicate, object);
  
  
  
  1.2       +1 -1      jakarta-commons/collections/src/java/org/apache/commons/collections/comparators/TransformingComparator.java
  
  Index: TransformingComparator.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/comparators/TransformingComparator.java,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- TransformingComparator.java	8 Jun 2002 06:42:00 -0000	1.1
  +++ TransformingComparator.java	16 Jun 2002 03:39:40 -0000	1.2
  @@ -59,7 +59,7 @@
   import org.apache.commons.collections.Transformer;
   
   /**
  - * Decorates another Comparator with transformation behavior.&nbsp;That is, the
  + * Decorates another Comparator with transformation behavior. That is, the
    * return value from the transform operation will be passed to the decorated
    * <CODE>Comparator#compare</CODE> method.
    * <p>
  
  
  

--
To unsubscribe, e-mail:   <mailto:commons-dev-unsubscribe@jakarta.apache.org>
For additional commands, e-mail: <mailto:commons-dev-help@jakarta.apache.org>


Mime
View raw message