changeset 402:1fcc7f7b6d65

FIXMEs/javadoc
author Artem Tikhomirov <tikhomirov.artem@gmail.com>
date Mon, 27 Feb 2012 19:38:44 +0100
parents a57a21aa4190
children 2747b0723867
files src/org/tmatesoft/hg/core/HgLogCommand.java
diffstat 1 files changed, 10 insertions(+), 4 deletions(-) [+]
line wrap: on
line diff
--- a/src/org/tmatesoft/hg/core/HgLogCommand.java	Mon Feb 27 19:16:01 2012 +0100
+++ b/src/org/tmatesoft/hg/core/HgLogCommand.java	Mon Feb 27 19:38:44 2012 +0100
@@ -198,10 +198,12 @@
 	}
 
 	/**
+	 * Iterate over range of changesets configured in the command.
 	 * 
 	 * @param handler callback to process changesets.
 	 * @throws HgCallbackTargetException to re-throw exception from the handler
-	 * @throws HgException FIXME EXCEPTIONS
+	 * @throws HgInvalidControlFileException if access to revlog index/data entry failed
+	 * @throws HgException in case of some other library issue 
 	 * @throws CancelledException if execution of the command was cancelled
 	 * @throws IllegalArgumentException when inspector argument is null
 	 * @throws ConcurrentModificationException if this log command instance is already running
@@ -260,11 +262,15 @@
 	}
 	
 	/**
-	 * TODO documentation 
-	 * @param handler
+	 * Tree-wise iteration of a file history, with handy access to parent-child relations between changesets. 
+	 *  
+	 * @param handler callback to process changesets.
 	 * @throws HgCallbackTargetException to re-throw exception from the handler
-	 * @throws HgException FIXME EXCEPTIONS
+	 * @throws HgInvalidControlFileException if access to revlog index/data entry failed
+	 * @throws HgException in case of some other library issue 
 	 * @throws CancelledException if execution of the command was cancelled
+	 * @throws IllegalArgumentException if command is not satisfied with its arguments 
+	 * @throws ConcurrentModificationException if this log command instance is already running
 	 */
 	public void execute(HgChangesetTreeHandler handler) throws HgCallbackTargetException, HgException, CancelledException {
 		if (handler == null) {