[Javaprofiler-commits] CVS: jpi/net/sourceforge/javaprofiler/jpi CPUStat.java,1.3,1.4

[Michal P. <mic...@us...>]

Update of /cvsroot/javaprofiler/jpi/net/sourceforge/javaprofiler/jpi
In directory usw-pr-cvs1:/tmp/cvs-serv24404/net/sourceforge/javaprofiler/jpi

Modified Files:
	CPUStat.java 
Log Message:

Javadoc.


Index: CPUStat.java
===================================================================
RCS file: /cvsroot/javaprofiler/jpi/net/sourceforge/javaprofiler/jpi/CPUStat.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -C2 -r1.3 -r1.4
*** CPUStat.java	2 Jul 2002 20:17:13 -0000	1.3
--- CPUStat.java	10 Sep 2002 11:02:07 -0000	1.4
***************
*** 21,29 ****
  package net.sourceforge.javaprofiler.jpi;
  
  public interface CPUStat {
      long getCPUHitsCount();
-     long getCPUPureTime();
      
      void addCPUStatListener( CPUStatListener listener);
      void removeCPUStatListener( CPUStatListener listener);
  }
--- 21,50 ----
  package net.sourceforge.javaprofiler.jpi;
  
+ /**
+  * Interface representing object that contains CPU related information. It is often inherited
+  * by other interfaces.
+  */
+ 
  public interface CPUStat {
+     
+     /**
+      * Returns the number of hits. For thorough explanation of the word "hit" please refer
+      * to the document named "JPI Tutorial".
+      */
      long getCPUHitsCount();
      
+     /**
+      * Returns the time (in miliseconds) spent executing the referenced object.
+      */
+     long getCPUPureTime();
+ 
+     /**
+      * Adds an event listener.
+      */
      void addCPUStatListener( CPUStatListener listener);
+     
+     /**
+      * Removes the specified event listener.
+      */
      void removeCPUStatListener( CPUStatListener listener);
  }
***************
*** 31,36 ****
  /*
   * $Log$
   * Revision 1.3  2002/07/02 20:17:13  stolis
   * License added.
   *
!  */
\ No newline at end of file
--- 52,61 ----
  /*
   * $Log$
+  * Revision 1.4  2002/09/10 11:02:07  michalpise
+  *
+  * Javadoc.
+  *
   * Revision 1.3  2002/07/02 20:17:13  stolis
   * License added.
   *
!  */