Mercurial > jhg

diff src/org/tmatesoft/hg/core/HgBadArgumentException.java @ 295:981f9f50bb6c

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Issue 11: Error log facility. SessionContext to share common facilities
author Artem Tikhomirov <tikhomirov.artem@gmail.com>
date Fri, 16 Sep 2011 05:35:32 +0200
parents cd3371670f0b
children 31a89587eb04
line wrap: on
line diff
--- a/src/org/tmatesoft/hg/core/HgBadArgumentException.java	Wed Sep 14 04:41:57 2011 +0200
+++ b/src/org/tmatesoft/hg/core/HgBadArgumentException.java	Fri Sep 16 05:35:32 2011 +0200
@@ -17,7 +17,14 @@
 package org.tmatesoft.hg.core;
 
 /**
- *
+ * Thrown when client supplied an argument that turned out to be incorrect.
+ * E.g. an {@link java.net.URL URL} of remote server  or {@link java.io.File File} destination for a new repository
+ * might be otherwise valid, but unsuitable for the purpose of the operation.
+ *  
+ * Not a replacement for {@link IllegalArgumentException} or {@link NullPointerException}.
+ * 
+ * TODO review usage to match description
+ * 
  * @author Artem Tikhomirov
  * @author TMate Software Ltd.
  */