From d39af20fdfc5fef6abc1e6e8e08a7ed9f1e35c64 Mon Sep 17 00:00:00 2001
From: Paul Campbell <pcampbell@kemitix.net>
Date: Sat, 2 Jun 2018 11:11:15 +0100
Subject: [PATCH] GitDB: add javadoc

---
 src/main/java/net/kemitix/gitdb/GitDB.java | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/src/main/java/net/kemitix/gitdb/GitDB.java b/src/main/java/net/kemitix/gitdb/GitDB.java
index 9a4bbb1..2f25f0c 100644
--- a/src/main/java/net/kemitix/gitdb/GitDB.java
+++ b/src/main/java/net/kemitix/gitdb/GitDB.java
@@ -48,6 +48,13 @@ public interface GitDB {
         );
     }
 
+    /**
+     * Open an existing local gitdb.
+     *
+     * @param dbDir the path to open as a local repo
+     * @return a GitDB instance for the local gitdb
+     * @throws IOException if there {@code dbDir} is a file, the directory does not exist or is not a repo
+     */
     static GitDBLocal openLocal(final Path dbDir) throws IOException {
         try {
             final Git git = Git.open(dbDir.toFile());