aboutsummaryrefslogtreecommitdiffstats
path: root/src/filedb.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/filedb.h')
-rw-r--r--src/filedb.h15
1 files changed, 12 insertions, 3 deletions
diff --git a/src/filedb.h b/src/filedb.h
index d575e50..85d6c26 100644
--- a/src/filedb.h
+++ b/src/filedb.h
@@ -14,11 +14,20 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-
#pragma once
+/******************************************************************************/
+/******************************************************************************/
+/* IMPLEMENTATION OF DATABASE WITH FILE BACKEND */
+/******************************************************************************/
+/******************************************************************************/
-
-/** is the database empty */
+/**
+ * Create the object handling the file database
+ * @param filedb pointer to the handling object to return
+ * @param directory the directory of the database
+ * @param basename the basename of the database
+ * @return 0 in case of success with *filedb fulfilled or negative -errno error
+ */
int
filedb_create(
anydb_t **filedb,