doc: Remove display of WL_PRINTF attribute
authorYong Bakos <ybakos@humanoriented.com>
Tue, 22 Nov 2016 16:13:43 +0000 (08:13 -0800)
committerDaniel Stone <daniels@collabora.com>
Wed, 23 Nov 2016 10:11:49 +0000 (10:11 +0000)
Doxygen truncates a WL_PRINTF function attribute, and there does not
seem to be any workaround[1]. When using the attribute like this:

typedef void (*wl_log_func_t)(const char *, va_list) WL_PRINTF(1, 0);

Doxygen generates something that looks like this:

typedef void (*wl_log_func_t)(const char *, va_list) WL_PRINTF(1,

Configure doxygen to consider WL_PRINTF(x,y) as predefined, so it does
not display the attribute at all in the generated documentation.

[1] https://bugzilla.gnome.org/show_bug.cgi?id=774741

Signed-off-by: Yong Bakos <ybakos@humanoriented.com>
Reviewed-by: Peter Hutterer <peter.hutterer@who-t.net>
doc/doxygen/wayland.doxygen.in

index 9d7fa0c..3913a13 100644 (file)
@@ -8,7 +8,8 @@ QUIET                  = YES
 HTML_TIMESTAMP         = YES
 GENERATE_LATEX         = NO
 MAN_LINKS              = YES
-PREDEFINED             = WL_EXPORT=
+PREDEFINED             = WL_EXPORT=              \
+                         WL_PRINTF(x,y)=
 MACRO_EXPANSION        = YES
 EXPAND_ONLY_PREDEF     = YES
 DOT_MULTI_TARGETS      = YES