aboutsummaryrefslogtreecommitdiffhomepage
path: root/bindings/ruby
diff options
context:
space:
mode:
authorGravatar Ali Polatel <polatel@gmail.com>2011-07-29 08:53:02 +0300
committerGravatar Ali Polatel <polatel@gmail.com>2011-07-29 08:53:02 +0300
commit00dfa0a17ddcbc3eb32900f2161fef1897d2f246 (patch)
tree95f9f5a32c9bffe48aaac69d71019823d60a8f84 /bindings/ruby
parent1c71d943cb89032f444143dc988d2957766089f0 (diff)
ruby: Add list of classes to main documentation
Diffstat (limited to 'bindings/ruby')
-rw-r--r--bindings/ruby/init.c17
1 files changed, 15 insertions, 2 deletions
diff --git a/bindings/ruby/init.c b/bindings/ruby/init.c
index aa09c8db..0a394515 100644
--- a/bindings/ruby/init.c
+++ b/bindings/ruby/init.c
@@ -1,6 +1,6 @@
/* The Ruby interface to the notmuch mail library
*
- * Copyright © 2010 Ali Polatel
+ * Copyright © 2010, 2011 Ali Polatel
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
@@ -27,6 +27,20 @@
*
* Ruby extension to the <tt>notmuch</tt> mail library.
*
+ * == Classes
+ *
+ * Following are the classes that are most likely to be of interest to
+ * the user:
+ *
+ * - Notmuch::Database
+ * - Notmuch::Filenames
+ * - Notmuch::Query
+ * - Notmuch::Threads
+ * - Notmuch::Messages
+ * - Notmuch::Thread
+ * - Notmuch::Message
+ * - Notmuch::Tags
+ *
* == Constants
*
* - Notmuch::MODE_READ_ONLY
@@ -159,7 +173,6 @@
* than notmuch_message_freeze.
*/
-#define RDOC_HATE 1
void
Init_notmuch(void)