From: Ali Polatel <polatel@gmail.com>
Date: Fri, 29 Jul 2011 06:16:12 +0000 (+0300)
Subject: ruby: Document remaining undocumented constants
X-Git-Tag: 0.8_rc0~27
X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=commitdiff_plain;h=666ef9f5f668467fc659b3016ac7f3cad00e2a9d

ruby: Document remaining undocumented constants
---

diff --git a/bindings/ruby/init.c b/bindings/ruby/init.c
index c423ac8e..884909e7 100644
--- a/bindings/ruby/init.c
+++ b/bindings/ruby/init.c
@@ -65,10 +65,35 @@ Init_notmuch(void)
      * Open the database in read write mode
      */
     rb_define_const(mod, "MODE_READ_WRITE", INT2FIX(NOTMUCH_DATABASE_MODE_READ_WRITE));
+    /*
+     * Document-const: Notmuch::SORT_OLDEST_FIRST
+     *
+     * Sort query results by oldest first
+     */
     rb_define_const(mod, "SORT_OLDEST_FIRST", INT2FIX(NOTMUCH_SORT_OLDEST_FIRST));
+    /*
+     * Document-const: Notmuch::SORT_NEWEST_FIRST
+     *
+     * Sort query results by newest first
+     */
     rb_define_const(mod, "SORT_NEWEST_FIRST", INT2FIX(NOTMUCH_SORT_NEWEST_FIRST));
+    /*
+     * Document-const: Notmuch::SORT_MESSAGE_ID
+     *
+     * Sort query results by message id
+     */
     rb_define_const(mod, "SORT_MESSAGE_ID", INT2FIX(NOTMUCH_SORT_MESSAGE_ID));
+    /*
+     * Document-const: Notmuch::SORT_UNSORTED
+     *
+     * Do not sort query results
+     */
     rb_define_const(mod, "SORT_UNSORTED", INT2FIX(NOTMUCH_SORT_UNSORTED));
+    /*
+     * Document-const: Notmuch::MESSAGE_FLAG_MATCH
+     *
+     * Message flag "match"
+     */
     rb_define_const(mod, "MESSAGE_FLAG_MATCH", INT2FIX(NOTMUCH_MESSAGE_FLAG_MATCH));
     /*
      * Document-const: Notmuch::TAG_MAX