summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorhaslersn <sebastian.hasler@gmx.net>2019-07-04 01:51:31 +0200
committerhaslersn <sebastian.hasler@gmx.net>2019-07-08 00:39:02 +0200
commitfac6d683b4281bf83bf6b1fe8a06ca9eea46f3f0 (patch)
tree5e29a843c40b1971631dff72cba86acfb9152b68
parent0d8d4de2d35703754b9a5637d2c280679235a2c5 (diff)
el::{load, make}_database: Fix documentation
-rw-r--r--include/djinterop/enginelibrary.hpp6
1 files changed, 4 insertions, 2 deletions
diff --git a/include/djinterop/enginelibrary.hpp b/include/djinterop/enginelibrary.hpp
index f2dd3ff..0549560 100644
--- a/include/djinterop/enginelibrary.hpp
+++ b/include/djinterop/enginelibrary.hpp
@@ -17,10 +17,12 @@ static constexpr semantic_version version_1_6_0{1, 6, 0};
static constexpr semantic_version version_1_7_1{1, 7, 1};
static constexpr semantic_version version_latest = version_1_7_1;
+/// Loads a database from a given directory.
database load_database(std::string directory);
-/// Creates a new, empty database in a given directory and using a specified
-/// schema version
+/// Loads a database from a given directory. If it doesn't exist, creates a new,
+/// empty database in that directory. When a new database is created, then
+/// the schema version given as default_version is used.
database make_database(
std::string directory,
const semantic_version& default_version = version_latest);