[Clirr-devel] CVS: clirr/src/java/net/sf/clirr/event ApiDifference.java,1.9,1.10

[<lk...@us...>]

Update of /cvsroot/clirr/clirr/src/java/net/sf/clirr/event
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv28032

Modified Files:
	ApiDifference.java 
Log Message:
javadoc

Index: ApiDifference.java
===================================================================
RCS file: /cvsroot/clirr/clirr/src/java/net/sf/clirr/event/ApiDifference.java,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- ApiDifference.java	22 May 2004 13:26:03 -0000	1.9
+++ ApiDifference.java	22 Jun 2004 16:52:10 -0000	1.10
@@ -70,6 +70,11 @@
      *
      * @param report a human readable string describing the change that was made.
      * @param severity the severity in terms of binary API compatibility.
+     * @param clazz the fully qualified class name where the change occured
+     * @param method the method signature of the method that changed, <code>null</code>
+     *   if no method was affected.
+     * @param field the field name where the change occured, <code>null</code>
+     *   if no field was affected.
      */
     public ApiDifference(String report, Severity severity, String clazz, String method, String field)
     {
@@ -103,16 +108,28 @@
         return report;
     }
 
+    /**
+     * The fully qualified class name of the class that has changed.
+     * @return fully qualified class name of the class that has changed.
+     */
     public String getAffectedClass()
     {
         return affectedClass;
     }
 
+    /**
+     * Method signature of the method that has changed, if any.
+     * @return method signature or <code>null</code> if no method is affected.
+     */
     public String getAffectedMethod()
     {
         return affectedMethod;
     }
 
+    /**
+     * Field name of the field that has changed, if any.
+     * @return field name or <code>null</code> if no field is affected.
+     */
     public String getAffectedField()
     {
         return affectedField;
@@ -175,6 +192,9 @@
         return true;
     }
 
+    /**
+     * {@inheritDoc}
+     */
     public int hashCode()
     {
         int result;