Add a hint on the purpose of JGitInternalException to the constructor

In code review we often see uses of JGitInternalException where a high
level GitAPIException would be more appropriate. Hopefully the word
low-level in the constructor comment will lead to fewer such cases.

Change-Id: Id5ec7897535f6c5c5f0bd153fe0ff15c65083474

diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/api/errors/JGitInternalException.java b/org.eclipse.jgit/src/org/eclipse/jgit/api/errors/JGitInternalException.java
index 9042daddcc61c74f3d60e92efe6e9ac06160723c..ca562005ff7c2b353ebc7623865efb813aca13cd 100644 (file)
--- a/org.eclipse.jgit/src/org/eclipse/jgit/api/errors/JGitInternalException.java
+++ b/org.eclipse.jgit/src/org/eclipse/jgit/api/errors/JGitInternalException.java
@@ -60,6 +60,8 @@ public class JGitInternalException extends RuntimeException {
        private static final long serialVersionUID = 1L;
 
        /**
+        * Construct an exception for low-level internal exceptions
+        *
         * @param message
         * @param cause
         */
@@ -68,6 +70,8 @@ public class JGitInternalException extends RuntimeException {
        }
 
        /**
+        * Construct an exception for low-level internal exceptions
+        *
         * @param message
         */
        public JGitInternalException(String message) {