incubator-kato-commits mailing list archives

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

URL: http://svn.apache.org/viewvc?rev=800546&view=rev
Log:
updated JavaMember  javadoc

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

Modified: incubator/kato/trunk/org.apache.kato/kato.api/src/main/java/javax/tools/diagnostics/runtime/java/JavaMember.java
URL: http://svn.apache.org/viewvc/incubator/kato/trunk/org.apache.kato/kato.api/src/main/java/javax/tools/diagnostics/runtime/java/JavaMember.java?rev=800546&r1=800545&r2=800546&view=diff
==============================================================================
--- incubator/kato/trunk/org.apache.kato/kato.api/src/main/java/javax/tools/diagnostics/runtime/java/JavaMember.java
(original)
+++ incubator/kato/trunk/org.apache.kato/kato.api/src/main/java/javax/tools/diagnostics/runtime/java/JavaMember.java
Mon Aug  3 20:32:54 2009
@@ -17,6 +17,7 @@
 import javax.tools.diagnostics.image.DataUnavailable;
 
 /**
+ * <p>
  * Abstract interface which both JavaField and JavaMethod inherit from.
  * It defines APIs which are common to both types of members.
  * It is modelled on java.lang.reflect.Member
@@ -24,36 +25,40 @@
 public interface JavaMember {
 
 	/**
+	 * <p>
 	 * Get the set of modifiers for this field or method - a set of bits
 	 * The values for the constants representing the modifiers can be obtained from {@link java.lang.reflect.Modifier}.
 
 	 * @return the modifiers for this field or method. 
-	 * @throws CorruptDataException 
+	 * @throws CorruptDataException if the underlying data is in an unexpected state  
      *
      */
     int getModifiers()  throws CorruptDataException;
 
     /**
+     * <p>
      * Get the class which declares this field or method
      * 
      * @return the JavaClass which declared this field or method
-     * @throws CorruptDataException 
-     * @throws DataUnavailable 
+     * @throws CorruptDataException if the underlying data is in an unexpected state  
+     * @throws DataUnavailable if there is no declaring class available
      */
     JavaClass getDeclaringClass() throws CorruptDataException, DataUnavailable;
     
     /**
+     * <p>
      * Get the name of the field or method
      * @return the name of the field or method
-     * @throws CorruptDataException 
+     * @throws CorruptDataException if the underlying data is in an unexpected state  
      */
     String getName()  throws CorruptDataException;
     
     /**
+     * <p>
      * Get the signature of the field or method
      * @return the signature of the field or method.
      * e.g. "(Ljava/lang/String;)V"
-     * @throws CorruptDataException 
+     * @throws CorruptDataException if the underlying data is in an unexpected state  
      */
     String getSignature()  throws CorruptDataException;
     



Mime
View raw message