about summary refs log tree commit homepage
path: root/ext
diff options
context:
space:
mode:
authorEric Wong <normalperson@yhbt.net>2010-12-01 09:58:22 +0000
committerEric Wong <normalperson@yhbt.net>2010-12-01 09:58:22 +0000
commit5557518c81f1a70f825bfc6e4a6671dc6e12b6e4 (patch)
tree67b3393e5557d39fbd4579fb2af5af03c9063c66 /ext
parent58938c980f38a4581b4a0e8a780fffe7ac95bc93 (diff)
downloadruby-tdb-5557518c81f1a70f825bfc6e4a6671dc6e12b6e4.tar.gz
Diffstat (limited to 'ext')
-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>
+ */