lib: fix the todo comment placement on NOTMUCH_STATUS_XAPIAN_EXCEPTION
authorJani Nikula <jani@nikula.org>
Sat, 17 Dec 2016 11:05:40 +0000 (13:05 +0200)
committerDavid Bremner <david@tethera.net>
Sat, 7 Jan 2017 12:30:08 +0000 (08:30 -0400)
The todo comment got separated from the status it's related to at
commit 3f32fd8a1c06 ("Add missing comment for
NOTMUCH_STATUS_READONLY_DATABASE."). Later, commit b65ca8e0ba5e ("lib:
modify notmuch.h for automatic document generation") moved it, but to
the wrong place. Fix the location.

lib/notmuch.h

index 18678c0a766c535f6ea2b1bafb94f7e72e9ab4fb..59cd0f564fc15056b0be981a6a15146b1204cb2d 100644 (file)
@@ -126,15 +126,15 @@ typedef enum _notmuch_status {
     NOTMUCH_STATUS_READ_ONLY_DATABASE,
     /**
      * A Xapian exception occurred.
+     *
+     * @todo We don't really want to expose this lame XAPIAN_EXCEPTION
+     * value. Instead we should map to things like DATABASE_LOCKED or
+     * whatever.
      */
     NOTMUCH_STATUS_XAPIAN_EXCEPTION,
     /**
      * An error occurred trying to read or write to a file (this could
      * be file not found, permission denied, etc.)
-     *
-     * @todo We don't really want to expose this lame XAPIAN_EXCEPTION
-     * value. Instead we should map to things like DATABASE_LOCKED or
-     * whatever.
      */
     NOTMUCH_STATUS_FILE_ERROR,
     /**