[PATCH wayland] doc: Remove display of WL_PRINTF attribute

Peter Hutterer peter.hutterer at who-t.net
Wed Nov 23 00:39:21 UTC 2016


On Tue, Nov 22, 2016 at 08:13:43AM -0800, Yong Bakos wrote:
> From: Yong Bakos <ybakos at humanoriented.com>
> 
> 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 at humanoriented.com>

Reviewed-by: Peter Hutterer <peter.hutterer at who-t.net>

Cheers,
   Peter

> ---
>  doc/doxygen/wayland.doxygen.in | 3 ++-
>  1 file changed, 2 insertions(+), 1 deletion(-)
> 
> diff --git a/doc/doxygen/wayland.doxygen.in b/doc/doxygen/wayland.doxygen.in
> index 9d7fa0c..3913a13 100644
> --- a/doc/doxygen/wayland.doxygen.in
> +++ b/doc/doxygen/wayland.doxygen.in
> @@ -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
> -- 
> 2.7.2
> 
> _______________________________________________
> wayland-devel mailing list
> wayland-devel at lists.freedesktop.org
> https://lists.freedesktop.org/mailman/listinfo/wayland-devel
> 


More information about the wayland-devel mailing list