Add javadoc

src/main/java/net/kemitix/gitdb/GitDB.java

@@ -27,6 +27,11 @@ import org.eclipse.jgit.api.errors.GitAPIException;
 
 import java.nio.file.Path;
 
+/**
+ * Main API for connecting to a Git repo as a database.
+ *
+ * @author Paul Campbell (pcampbell@kemitix.net)
+ */
 public interface GitDB {
 
     /**
@@ -34,6 +39,7 @@ public interface GitDB {
      *
      * @param dbDir the path to initialise the local repo in
      * @return a GitDB instance for the created local gitdb
+     * @throws GitAPIException if there is an error initialising the Git repo
      */
     static GitDB initLocal(final Path dbDir) throws GitAPIException {
         final InitCommand initCommand = Git.init().setGitDir(dbDir.toFile()).setBare(true);

src/main/java/net/kemitix/gitdb/GitDBLocal.java

@@ -24,6 +24,11 @@ package net.kemitix.gitdb;
 import lombok.RequiredArgsConstructor;
 import org.eclipse.jgit.api.Git;
 
+/**
+ * Implementation of GitDB for working with a local Repo.
+ *
+ * @author Paul Campbell (pcampbell@kemitix.net)
+ */
 @RequiredArgsConstructor
 class GitDBLocal implements GitDB {
 

src/main/java/net/kemitix/gitdb/package-info.java

@@ -19,4 +19,8 @@
   OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  */
 
+/**
+ * GitDB - using git as a key/value database.
+ */
+
 package net.kemitix.gitdb;