diff src/org/tmatesoft/hg/internal/Lifecycle.java @ 241:d3ab16739736

Some javadoc
author Artem Tikhomirov <tikhomirov.artem@gmail.com>
date Thu, 23 Jun 2011 15:16:34 +0200
parents e39cf474ef94
children
line wrap: on
line diff
--- a/src/org/tmatesoft/hg/internal/Lifecycle.java	Thu Jun 23 13:32:23 2011 +0200
+++ b/src/org/tmatesoft/hg/internal/Lifecycle.java	Thu Jun 23 15:16:34 2011 +0200
@@ -23,11 +23,24 @@
  * @author Artem Tikhomirov
  * @author TMate Software Ltd.
  */
+@Experimental(reason="Experimenting whether such approach pays off")
 public interface Lifecycle {
 
+	/**
+	 * @param count approximate number of iterations.
+	 * @param callback callback to communicate with RevlogStream (now to stop iteration only)
+	 * @param token identifier of the process
+	 */
 	public void start(int count, Callback callback, Object token);
+
+	/**
+	 * @param token identifier of the process, identical to the one passed in {@link #start(int, Callback, Object)} of this iteration
+	 */
 	public void finish(Object token);
 
+	/**
+	 * Access to RevlogStream facilities.
+	 */
 	interface Callback {
 		void stop();
 	}