ruby: Add list of classes to main documentation
authorAli Polatel <polatel@gmail.com>
Fri, 29 Jul 2011 05:53:02 +0000 (08:53 +0300)
committerAli Polatel <polatel@gmail.com>
Fri, 29 Jul 2011 05:53:02 +0000 (08:53 +0300)
bindings/ruby/init.c

index aa09c8dbc37e4781b0939deb55fb5c22402ae36a..0a3945151b213a8f58e9a6e1bd411ba5c97de4e2 100644 (file)
@@ -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
  *
  * 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
  * than notmuch_message_freeze.
  */
 
-#define RDOC_HATE 1
 
 void
 Init_notmuch(void)