incubator-kato-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From spo...@apache.org
Subject svn commit: r800556 - /incubator/kato/trunk/org.apache.kato/kato.api/src/main/java/javax/tools/diagnostics/runtime/java/JavaVariable.java
Date Mon, 03 Aug 2009 20:46:25 GMT
Author: spoole
Date: Mon Aug  3 20:46:25 2009
New Revision: 800556

URL: http://svn.apache.org/viewvc?rev=800556&view=rev
Log:
updated Java Variable javadoc

Modified:
    incubator/kato/trunk/org.apache.kato/kato.api/src/main/java/javax/tools/diagnostics/runtime/java/JavaVariable.java

Modified: incubator/kato/trunk/org.apache.kato/kato.api/src/main/java/javax/tools/diagnostics/runtime/java/JavaVariable.java
URL: http://svn.apache.org/viewvc/incubator/kato/trunk/org.apache.kato/kato.api/src/main/java/javax/tools/diagnostics/runtime/java/JavaVariable.java?rev=800556&r1=800555&r2=800556&view=diff
==============================================================================
--- incubator/kato/trunk/org.apache.kato/kato.api/src/main/java/javax/tools/diagnostics/runtime/java/JavaVariable.java
(original)
+++ incubator/kato/trunk/org.apache.kato/kato.api/src/main/java/javax/tools/diagnostics/runtime/java/JavaVariable.java
Mon Aug  3 20:46:25 2009
@@ -17,45 +17,52 @@
 import javax.tools.diagnostics.image.DataUnavailable;
 
 /**
+ * <p>
  * Representation of a Java Variable  
- * 
- * @experimental This is an experimental addition and may be removed at a later date
+ * <p>
+ * This is an experimental addition and may be removed at a later date
  */
 public interface JavaVariable {
 
 	
 	/**
-	 * The name of the variable if available
+	 * <p>
+	 * The name of the variable.
 	 * 
-	 * @throws DataUnavailable
+	 * @throws DataUnavailable if the information is not available
 	 */
 	String getName() throws DataUnavailable;
 
 	/**
+	 * <p>
 	 *  The local variable's signature in JNI format.
 	 * 
 	 */
 	String getSignature();
 
 	/**
+	 * <p>
 	 *  The start of the local variable's scope within the bytecode.
 	 * 
 	 */
 	int getStart();
 
 	/**
+	 * <p>
 	 *  The number of bytes this variables scope covers over the bytecode.
 	 * 
 	 */
 	int getLength();
 
 	/**
+	 * <p>
 	 *  The local variable slot this variable occupies. Passed to JavaStackFrame.getVariable()
to retrieve the contents.
 	 * 
 	 */
 	int getSlot();
 	
 	/**
+	 * <p>
 	 *  The value of the variable 
 	 * 
 	 */



Mime
View raw message