about summary refs log tree commit homepage
path: root/ext/tdb/tdb.c
diff options
context:
space:
mode:
Diffstat (limited to 'ext/tdb/tdb.c')
-rw-r--r--ext/tdb/tdb.c11
1 files changed, 11 insertions, 0 deletions
diff --git a/ext/tdb/tdb.c b/ext/tdb/tdb.c
index cfe7970..0ad7d5f 100644
--- a/ext/tdb/tdb.c
+++ b/ext/tdb/tdb.c
@@ -677,3 +677,14 @@ void Init_tdb_ext(void)
         tdb_CONST(INCOMPATIBLE_HASH);
 #endif
 }
+
+/*
+ * Document-class: TDB
+ *
+ * <code>
+ *   tdb = TDB.new("/path/to/file", flags => IO::RDWR|IO::CREAT)
+ *   tdb.store("HELLO", "world")
+ *   tdb.fetch("HELLO")  -> "world"
+ *   tdb.delete("HELLO") -> "world"
+ * </code>
+ */