diff options
author | haslersn <sebastian.hasler@gmx.net> | 2019-07-07 19:10:52 +0200 |
---|---|---|
committer | haslersn <sebastian.hasler@gmx.net> | 2019-07-08 00:39:02 +0200 |
commit | c97d76819fff5458a510780cacaa406b5fac78ae (patch) | |
tree | 4f25efd43eaf6cfb335c7ba0ad6305382f885408 | |
parent | be7bd179a923280e4175598342a90d875755f566 (diff) |
database: remove mentions of Engine from the docs
-rw-r--r-- | include/djinterop/database.hpp | 15 |
1 files changed, 10 insertions, 5 deletions
diff --git a/include/djinterop/database.hpp b/include/djinterop/database.hpp index 3b73ac3..9988c0b 100644 --- a/include/djinterop/database.hpp +++ b/include/djinterop/database.hpp @@ -80,11 +80,14 @@ public: /// Creates a new track associated to a given music file /// - /// The music file is given by its relative path from the Engine library - /// directory. The created track is not contained in any crates. + /// The music file is given by its relative path from the directory passed + /// to the `database` constructor. The created track is not contained in any + /// crates. track create_track(boost::string_view relative_path) const; - /// Returns the path to the Engine library directory of the database + /// Returns the path directory of the database + /// + /// This is the same as the directory passed to the `database` constructor. std::string directory() const; /// Returns true iff the database version is supported by this version of @@ -94,8 +97,10 @@ public: /// Returns the UUID of the database std::string uuid() const; - /// Verifies the schema of an Engine Prime database and throws an exception - /// if there is any kind of inconsistency + /// Verifies the consistence of the internal storage of the database. + /// + /// A `database_inconsistency` (or some exception derived from it) is thrown + /// if any kind of inconsistency is found. void verify() const; /// Returns the schema version of the database |