Apache
/
commons-collections
mirror of https://github.com/apache/commons-collections.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

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.


git-svn-id: https://svn.apache.org/repos/asf/jakarta/commons/proper/collections/trunk@130718 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Michael Smith 2002-06-16 03:39:40 +00:00
parent e9f2bdc6a5
commit c28176cb14
5 changed files with 37 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
src/java/org/apache/commons/collections/CursorableLinkedList.java
View File

@ -1,7 +1,7 @@
/* /*
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/CursorableLinkedList.java,v 1.7 2002/06/15 03:52:24 mas Exp $ * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/CursorableLinkedList.java,v 1.8 2002/06/16 03:39:40 mas Exp $
* $Revision: 1.7 $ * $Revision: 1.8 $
* $Date: 2002/06/15 03:52:24 $ * $Date: 2002/06/16 03:39:40 $
* *
* ==================================================================== * ====================================================================
* *
@ -92,7 +92,7 @@ import java.lang.UnsupportedOperationException; // stops a javadoc warning
* *
* @since 1.0 * @since 1.0
* @author Rodney Waldhoff * @author Rodney Waldhoff
* @version $Id: CursorableLinkedList.java,v 1.7 2002/06/15 03:52:24 mas Exp $ * @version $Id: CursorableLinkedList.java,v 1.8 2002/06/16 03:39:40 mas Exp $
* @see java.util.LinkedList * @see java.util.LinkedList
*/ */
public class CursorableLinkedList implements List, Serializable { public class CursorableLinkedList implements List, Serializable {
@ -743,7 +743,8 @@ public class CursorableLinkedList implements List, Serializable {
* list, after the specified <i>before</i> element, and before the * list, after the specified <i>before</i> element, and before the
* specified <i>after</i> element * 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) { protected Listable insertListable(Listable before, Listable after, Object value) {
_modCount++; _modCount++;
@ -765,7 +766,9 @@ public class CursorableLinkedList implements List, Serializable {
} }
/** /**
* 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) { protected void removeListable(Listable elt) {
_modCount++; _modCount++;
@ -786,8 +789,10 @@ public class CursorableLinkedList implements List, Serializable {
} }
/** /**
* Returns the {@link CursorableLinkedList.Listable} at the specified * Returns the
* index. * {@link org.apache.commons.collections.CursorableLinkedList.Listable}
* at the specified index.
*
* @throws IndexOutOfBoundsException if index is less than zero or * @throws IndexOutOfBoundsException if index is less than zero or
* greater than or equal to the size of this list. * greater than or equal to the size of this list.
*/ */
@ -905,7 +910,9 @@ public class CursorableLinkedList implements List, Serializable {
* <tt>_head.next().prev()</tt> and <tt>_head.prev().next()</tt> to be * <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. * non-null, as when I am a sublist for some larger list.
* Use <tt>== _head.next()</tt> and <tt>== _head.prev()</tt> to determine * 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); transient protected Listable _head = new Listable(null,null,null);
@ -1354,7 +1361,7 @@ class CursorableSubList extends CursorableLinkedList implements List {
* list, after the specified <i>before</i> element, and before the * list, after the specified <i>before</i> element, and before the
* specified <i>after</i> element * 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) { protected Listable insertListable(Listable before, Listable after, Object value) {
_modCount++; _modCount++;

15
src/java/org/apache/commons/collections/DefaultMapEntry.java
View File

@ -1,7 +1,7 @@
/* /*
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/DefaultMapEntry.java,v 1.6 2002/06/12 03:59:15 mas Exp $ * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/DefaultMapEntry.java,v 1.7 2002/06/16 03:39:40 mas Exp $
* $Revision: 1.6 $ * $Revision: 1.7 $
* $Date: 2002/06/12 03:59:15 $ * $Date: 2002/06/16 03:39:40 $
* *
* ==================================================================== * ====================================================================
* *
@ -61,9 +61,8 @@
package org.apache.commons.collections; package org.apache.commons.collections;
import java.util.Map; 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 * @since 1.0
* @author <a href="mailto:jstrachan@apache.org">James Strachan</a> * @author <a href="mailto:jstrachan@apache.org">James Strachan</a>
@ -84,7 +83,8 @@ public class DefaultMapEntry implements Map.Entry {
} }
/** /**
* 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) { public boolean equals(Object o) {
if( o == null ) return false; if( o == null ) return false;
@ -101,7 +101,8 @@ public class DefaultMapEntry implements Map.Entry {
/** /**
* Implemented per API documentation of {@link Map.Entry#hashCode()} * Implemented per API documentation of
* {@link java.util.Map.Entry#hashCode()}
**/ **/
public int hashCode() { public int hashCode() {
return ( ( getKey() == null ? 0 : getKey().hashCode() ) ^ return ( ( getKey() == null ? 0 : getKey().hashCode() ) ^

14
src/java/org/apache/commons/collections/LazyCollections.java
View File

@ -1,7 +1,7 @@
/* /*
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/Attic/LazyCollections.java,v 1.2 2002/05/29 03:22:42 arron Exp $ * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/Attic/LazyCollections.java,v 1.3 2002/06/16 03:39:40 mas Exp $
* $Revision: 1.2 $ * $Revision: 1.3 $
* $Date: 2002/05/29 03:22:42 $ * $Date: 2002/06/16 03:39:40 $
* ==================================================================== * ====================================================================
* *
* The Apache Software License, Version 1.1 * The Apache Software License, Version 1.1
@ -76,12 +76,8 @@ import java.lang.reflect.*;
* new class built from an empty constructor, then all you need to provide is * new class built from an empty constructor, then all you need to provide is
* the class definition. * the class definition.
* *
* @see org.apache.commons.collections.LazyList
* @see org.apache.commons.collections.LazyMap
* @see org.apache.commons.collections.LazySortedMap
*
* @author Arron Bates * @author Arron Bates
* @version $Revision: 1.2 $ * @version $Revision: 1.3 $
*/ */
public class LazyCollections { public class LazyCollections {
@ -590,4 +586,4 @@ public class LazyCollections {
return ((SortedMap)super.mapImpl).lastKey(); return ((SortedMap)super.mapImpl).lastKey();
} }
} }
} }

12
src/java/org/apache/commons/collections/PredicateUtils.java
View File

@ -1,7 +1,7 @@
/* /*
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/PredicateUtils.java,v 1.1 2002/05/02 06:17:19 jstrachan Exp $ * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/PredicateUtils.java,v 1.2 2002/06/16 03:39:40 mas Exp $
* $Revision: 1.1 $ * $Revision: 1.2 $
* $Date: 2002/05/02 06:17:19 $ * $Date: 2002/06/16 03:39:40 $
* *
* ==================================================================== * ====================================================================
* *
@ -1116,21 +1116,21 @@ public class PredicateUtils {
} }
/** /**
* @see Map.Entry#getKey() * @see java.util.Map.Entry#getKey()
*/ */
public Object getKey() { public Object getKey() {
return iEntry.getKey(); return iEntry.getKey();
} }
/** /**
* @see Map.Entry#getValue() * @see java.util.Map.Entry#getValue()
*/ */
public Object getValue() { public Object getValue() {
return iEntry.getValue(); return iEntry.getValue();
} }
/** /**
* @see Map.Entry#setValue() * @see java.util.Map.Entry#setValue(Object)
*/ */
public Object setValue(Object object) { public Object setValue(Object object) {
validate(iValuePredicate, object); validate(iValuePredicate, object);

2
src/java/org/apache/commons/collections/comparators/TransformingComparator.java
View File

@ -59,7 +59,7 @@ import java.util.Comparator;
import org.apache.commons.collections.Transformer; 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 * return value from the transform operation will be passed to the decorated
* <CODE>Comparator#compare</CODE> method. * <CODE>Comparator#compare</CODE> method.
* <p> * <p>