[PATCH wayland] doc: link between client and server doc and to the wayland book

Bryce Harrington bryce at osg.samsung.com
Mon Mar 7 19:56:50 UTC 2016


On Tue, Mar 01, 2016 at 09:28:49AM +1000, Peter Hutterer wrote:
> And insert "client" or "server" into the PROJECT_NAME to know which one we
> have.
> 
> Signed-off-by: Peter Hutterer <peter.hutterer at who-t.net>

Reviewed-by: Bryce Harrington <bryce at osg.samsung.com>

This and the other doxygen patch are pushed:
To ssh://git.freedesktop.org/git/wayland/wayland
   f8f3e54..973a70d  master -> master

> ---
>  doc/doxygen/Makefile.am  | 1 +
>  doc/doxygen/mainpage.dox | 9 +++++++++
>  2 files changed, 10 insertions(+)
> 
> diff --git a/doc/doxygen/Makefile.am b/doc/doxygen/Makefile.am
> index e80c401..c377353 100644
> --- a/doc/doxygen/Makefile.am
> +++ b/doc/doxygen/Makefile.am
> @@ -68,6 +68,7 @@ xml/%/index.xml: $(top_srcdir)/src/scanner.c $(scanned_src_files_%) wayland.doxy
>  
>  html/%/index.html: $(scanned_src_files_%) wayland.doxygen $(diagrams) $(diagram_maps) | html/%
>  	$(AM_V_GEN)(cat wayland.doxygen; \
> +          echo "PROJECT_NAME=\"Wayland $* API\""; \
>            echo "GENERATE_HTML=YES"; \
>            echo "HTML_OUTPUT=html/$*"; \
>            echo "INPUT= $(scanned_src_files_$*) $(extra_doxygen_$*)"; \
> diff --git a/doc/doxygen/mainpage.dox b/doc/doxygen/mainpage.dox
> index 8f9bf03..ca1da53 100644
> --- a/doc/doxygen/mainpage.dox
> +++ b/doc/doxygen/mainpage.dox
> @@ -2,6 +2,15 @@
>   * @mainpage
>   * Wayland protocol API documentation.
>   *
> + * This documentation is available for the Server- and the Client-side APIs.
> + *
> + * - <a href="../Server/index.html">Server-side API</a>
> + * - <a href="../Client/index.html">Client-side API</a>
> + *
> + * Further documentation about the architecture and principles of Wayland is
> + * available in the
> + * <a href="https://wayland.freedesktop.org/docs/html">Wayland Book</a>
> + *
>   * @section ifaces Interfaces
>   * For the list of available interfaces, please see the
>   * <a href="modules.html">modules</a> list.
> -- 
> 2.5.0


More information about the wayland-devel mailing list