Hello,
This is a follow-up patch to the import trimming where I've eliminated
all the javadoc warnings flagged by eclipse.
Keith
ChangeLog
2006-03-09 Keith Seitz <[EMAIL PROTECTED]>
* gnu/classpath/jdwp/event/EventManager.java: Update javadoc.
* gnu/classpath/jdwp/event/ThreadStartEvent.java
(ThreadStartEvent): Likewise.
* gnu/classpath/jdwp/event/VmDeathEvent.java (VmDeathEvent): Likewise.
* gnu/classpath/jdwp/event/filters/ConditionalFilter.java
(ConditionalFilter): Likewise.
* gnu/classpath/jdwp/event/filters/ExceptionOnlyFilter.java
(ExceptionOnlyFilter): Likewise.
* gnu/classpath/jdwp/event/filters/FieldOnlyFilter.java
(FieldOnlyFilter): Likewise.
* gnu/classpath/jdwp/event/filters/StepFilter.java (getDepth): Likewise.
(getSize): Likewise.
(StepFilter): Likewise.
* gnu/classpath/jdwp/id/JdwpId.java: Likewise (for _tag).
* gnu/classpath/jdwp/transport/JdwpPacket.java
(JdwpPacket): Likewise.
(fromBytes): Likewise.
* gnu/classpath/jdwp/transport/JdwpReplyPacket.java
(JdwpReplyPacket): Likewise.
* gnu/classpath/jdwp/util/Value.java (getUntaggedObj): Likewise.
* vm/reference/gnu/classpath/jdwp/VMIdManager.java
(getReferenceType): Likewise.
(newObjectId): Likewise.
* vm/reference/gnu/classpath/jdwp/VMMethod.java (readId): Likewise.
* vm/reference/gnu/classpath/jdwp/VMVirtualMachine.java
(getFrames): Fix typo in parameter name and update javadoc.
(getClassMethod): Update javadoc.
Index: gnu/classpath/jdwp/event/EventManager.java
===================================================================
RCS file: /sources/classpath/classpath/gnu/classpath/jdwp/event/EventManager.java,v
retrieving revision 1.3
diff -u -r1.3 EventManager.java
--- gnu/classpath/jdwp/event/EventManager.java 16 Dec 2005 23:15:54 -0000 1.3
+++ gnu/classpath/jdwp/event/EventManager.java 9 Mar 2006 23:14:36 -0000
@@ -56,7 +56,7 @@
* 2) Filter event notifications from the VM
*
* If an event request arrives from the debugger, the back-end will
- * call [EMAIL PROTECTED] #reqestEvent}, which will first check for a valid event.
+ * call [EMAIL PROTECTED] #requestEvent}, which will first check for a valid event.
* If it is valid, <code>EventManager</code> will record the request
* internally and register the event with the virtual machine, which may
* choose to handle the request itself (as is likely the case with
Index: gnu/classpath/jdwp/event/ThreadStartEvent.java
===================================================================
RCS file: /sources/classpath/classpath/gnu/classpath/jdwp/event/ThreadStartEvent.java,v
retrieving revision 1.1
diff -u -r1.1 ThreadStartEvent.java
--- gnu/classpath/jdwp/event/ThreadStartEvent.java 30 Aug 2005 00:51:10 -0000 1.1
+++ gnu/classpath/jdwp/event/ThreadStartEvent.java 9 Mar 2006 23:14:37 -0000
@@ -49,7 +49,7 @@
/**
* "Notification of a new running thread in the target VM. The new
- * thread can be the result of a call to [EMAIL PROTECTED] java.lang.Thread.start} or
+ * thread can be the result of a call to [EMAIL PROTECTED] java.lang.Thread#start} or
* the result of attaching a new thread to the VM though JNI. The
* notification is generated by the new thread some time before its
* execution starts. Because of this timing, it is possible to receive
@@ -70,9 +70,9 @@
private Thread _thread;
/**
- * Constructs a new <code>ThreadStartEvent</code>
+ * Constructs a new ThreadStartEvent object
*
- * @param tid the thread ID in which event occurred
+ * @param thread the thread ID in which event occurred
*/
public ThreadStartEvent (Thread thread) {
super (JdwpConstants.EventKind.THREAD_END);
Index: gnu/classpath/jdwp/event/VmDeathEvent.java
===================================================================
RCS file: /sources/classpath/classpath/gnu/classpath/jdwp/event/VmDeathEvent.java,v
retrieving revision 1.1
diff -u -r1.1 VmDeathEvent.java
--- gnu/classpath/jdwp/event/VmDeathEvent.java 9 Sep 2005 22:08:19 -0000 1.1
+++ gnu/classpath/jdwp/event/VmDeathEvent.java 9 Mar 2006 23:14:37 -0000
@@ -53,9 +53,7 @@
extends Event
{
/**
- * Constructs a <code>VmDeathEvent</code> object
- *
- * @param thread the initial thread
+ * Constructs a new VmDeathEvent object
*/
public VmDeathEvent ()
{
Index: gnu/classpath/jdwp/event/filters/ConditionalFilter.java
===================================================================
RCS file: /sources/classpath/classpath/gnu/classpath/jdwp/event/filters/ConditionalFilter.java,v
retrieving revision 1.1
diff -u -r1.1 ConditionalFilter.java
--- gnu/classpath/jdwp/event/filters/ConditionalFilter.java 26 Aug 2005 21:52:28 -0000 1.1
+++ gnu/classpath/jdwp/event/filters/ConditionalFilter.java 9 Mar 2006 23:14:37 -0000
@@ -61,7 +61,7 @@
* <p><b>NOTE:</b> This filter is marked "for the future",
* i.e, there is no way to actually use this yet.
*
- * @param cond the conditional expression
+ * @param conditional the conditional expression
* @throws NotImplementedException if used
*/
public ConditionalFilter (Object conditional)
Index: gnu/classpath/jdwp/event/filters/ExceptionOnlyFilter.java
===================================================================
RCS file: /sources/classpath/classpath/gnu/classpath/jdwp/event/filters/ExceptionOnlyFilter.java,v
retrieving revision 1.1
diff -u -r1.1 ExceptionOnlyFilter.java
--- gnu/classpath/jdwp/event/filters/ExceptionOnlyFilter.java 26 Aug 2005 21:52:28 -0000 1.1
+++ gnu/classpath/jdwp/event/filters/ExceptionOnlyFilter.java 9 Mar 2006 23:14:37 -0000
@@ -59,11 +59,11 @@
private boolean _uncaught;
/**
- * Constructs a new <code>ExceptionOnlyFilter</code>
+ * Constructs a new ExceptionOnlyFilter
*
- * @param refid
- * @param caught
- * @param uncaught
+ * @param refId ID of the exception to report
+ * @param caught Report caught exceptions
+ * @param uncaught Report uncaught exceptions
* @throws InvalidClassException if refid is invalid
*/
public ExceptionOnlyFilter (ReferenceTypeId refId, boolean caught,
Index: gnu/classpath/jdwp/event/filters/FieldOnlyFilter.java
===================================================================
RCS file: /sources/classpath/classpath/gnu/classpath/jdwp/event/filters/FieldOnlyFilter.java,v
retrieving revision 1.1
diff -u -r1.1 FieldOnlyFilter.java
--- gnu/classpath/jdwp/event/filters/FieldOnlyFilter.java 26 Aug 2005 21:52:28 -0000 1.1
+++ gnu/classpath/jdwp/event/filters/FieldOnlyFilter.java 9 Mar 2006 23:14:37 -0000
@@ -64,7 +64,7 @@
* @param refId class for field
* @param fid field
* @throws InvalidClassException if class is invalid
- * @throws InvalidFieldExcpetion if field is invalid
+ * @throws InvalidFieldException if field is invalid
*/
public FieldOnlyFilter (ReferenceTypeId refId, /*Field*/ReferenceTypeId fid)
throws InvalidClassException, InvalidFieldException
Index: gnu/classpath/jdwp/event/filters/StepFilter.java
===================================================================
RCS file: /sources/classpath/classpath/gnu/classpath/jdwp/event/filters/StepFilter.java,v
retrieving revision 1.2
diff -u -r1.2 StepFilter.java
--- gnu/classpath/jdwp/event/filters/StepFilter.java 22 Sep 2005 19:13:57 -0000 1.2
+++ gnu/classpath/jdwp/event/filters/StepFilter.java 9 Mar 2006 23:14:37 -0000
@@ -44,9 +44,9 @@
import gnu.classpath.jdwp.id.ThreadId;
/**
- * An event filter which restricts reported step events to those which
+ * "An event filter which restricts reported step events to those which
* satisfy depth and size constraints. This modifier can only be used with
- * step event kinds.
+ * step event kinds."
*
* @author Keith Seitz ([EMAIL PROTECTED])
*/
@@ -58,9 +58,11 @@
private int _depth;
/**
- * Constructs a new <code>StepFilter</code> with the given count.
+ * Constructs a new StepFilter
*
- * @param count the number of times the event will be ignored
+ * @param tid ID of the thread in which to step
+ * @param size size of each step
+ * @param depth relative call stack limit
* @throws InvalidThreadException if thread is invalid
*/
public StepFilter (ThreadId tid, int size, int depth)
@@ -88,7 +90,7 @@
* Returns the size of each step (insn, line)
*
* @return the step size
- * @see JdwpConstants.StepSize
+ * @see gnu.classpath.jdwp.JdwpConstants.StepSize
*/
public int getSize ()
{
@@ -99,7 +101,7 @@
* Returns the relative call stack limit (into, over, out)
*
* @return how to step
- * @see JdwpConstants.StepDepth
+ * @see gnu.classpath.jdwp.JdwpConstants.StepDepth
*/
public int getDepth ()
{
Index: gnu/classpath/jdwp/id/JdwpId.java
===================================================================
RCS file: /sources/classpath/classpath/gnu/classpath/jdwp/id/JdwpId.java,v
retrieving revision 1.5
diff -u -r1.5 JdwpId.java
--- gnu/classpath/jdwp/id/JdwpId.java 17 Feb 2006 14:49:06 -0000 1.5
+++ gnu/classpath/jdwp/id/JdwpId.java 9 Mar 2006 23:14:37 -0000
@@ -63,7 +63,7 @@
/**
* Tag of ID's type (see [EMAIL PROTECTED] gnu.classpath.jdwp.JdwpConstants.Tag})
* for object-like IDs or the type tag (see [EMAIL PROTECTED]
- * gnu.classpath.JdwpConstants.TypeTag}) for reference type IDs.
+ * gnu.classpath.jdwp.JdwpConstants.TypeTag}) for reference type IDs.
*/
private byte _tag;
Index: gnu/classpath/jdwp/transport/JdwpPacket.java
===================================================================
RCS file: /sources/classpath/classpath/gnu/classpath/jdwp/transport/JdwpPacket.java,v
retrieving revision 1.3
diff -u -r1.3 JdwpPacket.java
--- gnu/classpath/jdwp/transport/JdwpPacket.java 2 Jul 2005 20:32:10 -0000 1.3
+++ gnu/classpath/jdwp/transport/JdwpPacket.java 9 Mar 2006 23:14:37 -0000
@@ -55,7 +55,7 @@
* This class deal with everything except the command- and reply-specific
* data, which get handled in [EMAIL PROTECTED]
* gnu.classpath.jdwp.transport.JdwpCommandPacket} and [EMAIL PROTECTED]
- * gnu.classpath.jdwp.transprot.JdwpReplyPacket}.
+ * gnu.classpath.jdwp.transport.JdwpReplyPacket}.
*
* @author Keith Seitz <[EMAIL PROTECTED]>
*/
@@ -183,7 +183,6 @@
* <code>null</code>.
*
* @param bytes packet data from the wire
- * @param index index into <code>bytes</code> to start processing
* @return number of bytes in <code>bytes</code> processed
*/
public static JdwpPacket fromBytes (byte[] bytes)
Index: gnu/classpath/jdwp/transport/JdwpReplyPacket.java
===================================================================
RCS file: /sources/classpath/classpath/gnu/classpath/jdwp/transport/JdwpReplyPacket.java,v
retrieving revision 1.4
diff -u -r1.4 JdwpReplyPacket.java
--- gnu/classpath/jdwp/transport/JdwpReplyPacket.java 4 Jul 2005 16:03:23 -0000 1.4
+++ gnu/classpath/jdwp/transport/JdwpReplyPacket.java 9 Mar 2006 23:14:38 -0000
@@ -45,7 +45,7 @@
/**
* A class represents a JDWP reply packet.
* This class adds an error code to the packet header information
- * in [EMAIL PROTECTED] gnu.classpath.transport.JdwpPacket} and adds additional
+ * in [EMAIL PROTECTED] gnu.classpath.jdwp.transport.JdwpPacket} and adds additional
* reply packet-specific processing.
*
* @author Keith Seitz <[EMAIL PROTECTED]>
Index: gnu/classpath/jdwp/util/Value.java
===================================================================
RCS file: /sources/classpath/classpath/gnu/classpath/jdwp/util/Value.java,v
retrieving revision 1.3
diff -u -r1.3 Value.java
--- gnu/classpath/jdwp/util/Value.java 25 Aug 2005 22:27:25 -0000 1.3
+++ gnu/classpath/jdwp/util/Value.java 9 Mar 2006 23:14:38 -0000
@@ -203,12 +203,12 @@
}
/**
- * Reads the an object of the given Class from the untagged value contained
+ * Reads an object of the given Class from the untagged value contained
* in the ByteBuffer.
*
- * @param bb contains the Object
+ * @param bb contains the Object
* @param type corresponds to the TAG of value to be read
- * @return
+ * @return the resultant object
* @throws JdwpException
* @throws IOException
*/
Index: vm/reference/gnu/classpath/jdwp/VMIdManager.java
===================================================================
RCS file: /sources/classpath/classpath/vm/reference/gnu/classpath/jdwp/VMIdManager.java,v
retrieving revision 1.6
diff -u -r1.6 VMIdManager.java
--- vm/reference/gnu/classpath/jdwp/VMIdManager.java 9 Mar 2006 19:49:59 -0000 1.6
+++ vm/reference/gnu/classpath/jdwp/VMIdManager.java 9 Mar 2006 23:14:49 -0000
@@ -109,7 +109,7 @@
/**
* Returns a new id for the given object
*
- * @param object the object for which an id is desired
+ * @param obj SoftReference of the object for which an id is desired
* @returns a suitable object id
*/
public static ObjectId newObjectId (SoftReference obj)
@@ -169,7 +169,7 @@
/**
* Returns a new reference type id for the given class
*
- * @param clazz the <code>Class</code> for which an id is desired
+ * @param ref SoftReference to the desired type
* @returns a suitable reference type id or null when the
* reference is cleared.
*/
Index: vm/reference/gnu/classpath/jdwp/VMMethod.java
===================================================================
RCS file: /sources/classpath/classpath/vm/reference/gnu/classpath/jdwp/VMMethod.java,v
retrieving revision 1.2
diff -u -r1.2 VMMethod.java
--- vm/reference/gnu/classpath/jdwp/VMMethod.java 9 Mar 2006 19:49:59 -0000 1.2
+++ vm/reference/gnu/classpath/jdwp/VMMethod.java 9 Mar 2006 23:14:49 -0000
@@ -166,7 +166,7 @@
* Returns a VMMethod from the ID in the byte buffer
*
* @param klass the method's declaring class
- * @param a ByteBuffer containing the method's ID
+ * @param bb a ByteBuffer containing the method's ID
* @throws JdwpException for any errors creating the method
* @throws IOException for any errors reading from the buffer
*/
Index: vm/reference/gnu/classpath/jdwp/VMVirtualMachine.java
===================================================================
RCS file: /sources/classpath/classpath/vm/reference/gnu/classpath/jdwp/VMVirtualMachine.java,v
retrieving revision 1.4
diff -u -r1.4 VMVirtualMachine.java
--- vm/reference/gnu/classpath/jdwp/VMVirtualMachine.java 9 Mar 2006 19:49:59 -0000 1.4
+++ vm/reference/gnu/classpath/jdwp/VMVirtualMachine.java 9 Mar 2006 23:14:49 -0000
@@ -42,6 +42,7 @@
package gnu.classpath.jdwp;
import gnu.classpath.jdwp.event.EventRequest;
+import gnu.classpath.jdwp.exception.InvalidMethodException;
import gnu.classpath.jdwp.exception.JdwpException;
import gnu.classpath.jdwp.util.LineTable;
import gnu.classpath.jdwp.util.MethodResult;
@@ -196,8 +197,8 @@
* A factory method for getting valid virtual machine methods
* which may be passed to/from the debugger.
*
- * @param rid the ID of the type in which the method is defined
- * @param methodId the ID of the desired method
+ * @param klass the class in which the method is defined
+ * @param id the ID of the desired method
* @return the desired internal representation of the method
* @throws InvalidMethodException if the method is not defined
* in the class
@@ -214,7 +215,7 @@
* @param length number of frames to return (-1 for all frames)
* @return a list of frames
*/
- public static native ArrayList getFrames (Thread thread, int strart,
+ public static native ArrayList getFrames (Thread thread, int start,
int length)
throws JdwpException;
