[PATCH wayland] doc: Remove wayland-util.c from file list

Peter Hutterer peter.hutterer at who-t.net
Sun Nov 27 09:48:29 UTC 2016


On Fri, Nov 25, 2016 at 10:48:36AM -0800, Yong Bakos wrote:
> From: Yong Bakos <ybakos at humanoriented.com>
> 
> Documentation generation via doxygen includes wayland-util.c in its file
> list. Although functions are documented in wayland-util.h, doxygen is
> not automatically using the same documentation for functions in
> wayland-util.c. In addition, everything listed in the doxygen page for
> wayland-util.c is documented in the page for wayland-util.h and the
> pages for corresponding structures. As such, the doxygen page for
> wayland-util.c has no value, and is redundant.
> 
> Remove the doxygen page for wayland-util.c.
> 
> Signed-off-by: Yong Bakos <ybakos at humanoriented.com>

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

Cheers,
   Peter

> ---
>  doc/doxygen/Makefile.am | 1 -
>  1 file changed, 1 deletion(-)
> 
> diff --git a/doc/doxygen/Makefile.am b/doc/doxygen/Makefile.am
> index c377353..276a395 100644
> --- a/doc/doxygen/Makefile.am
> +++ b/doc/doxygen/Makefile.am
> @@ -9,7 +9,6 @@ noinst_DATA = \
>  dist_noinst_DATA = wayland.doxygen.in
>  
>  scanned_src_files_shared = 				\
> -	$(top_srcdir)/src/wayland-util.c	\
>  	$(top_srcdir)/src/wayland-util.h
>  
>  scanned_src_files_Client = 				\
> -- 
> 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