lib: define NOTMUCH_DEPRECATED macro, document its use.

[notmuch] / devel / STYLE

diff --git a/devel/STYLE b/devel/STYLE
index 92de42ccc9ba1847234532a88b58840ab5b0151a..24bd5482a4899b185f923302bb4801177dc6b3ea 100644 (file)
--- a/devel/STYLE
+++ b/devel/STYLE
@@ -93,3 +93,13 @@ libnotmuch conventions
 
 * Code which needs to be accessed from both the CLI and from
   libnotmuch should be factored out into libutil (under util/).
+
+* Deprecated functions should be marked with the NOTMUCH_DEPRECATED
+  macro which generates run time warnings with gcc and clang. In order
+  not to confuse doxygen this should go at the beginning of the
+  declaration like:
+
+  NOTMUCH_DEPRECATED(major,minor) notmuch_status_t notmuch_dwim(void *arg);
+
+  The @deprecated doxygen command can be used to generate markup in
+  the API docs.