From 973a70dbb5a1d2865ec63a268e939585da5a951f Mon Sep 17 00:00:00 2001 From: Peter Hutterer Date: Tue, 1 Mar 2016 09:28:49 +1000 Subject: [PATCH] doc: link between client and server doc and to the wayland book And insert "client" or "server" into the PROJECT_NAME to know which one we have. Signed-off-by: Peter Hutterer Reviewed-by: Bryce Harrington --- 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. + * + * - Server-side API + * - Client-side API + * + * Further documentation about the architecture and principles of Wayland is + * available in the + * Wayland Book + * * @section ifaces Interfaces * For the list of available interfaces, please see the * modules list.