diff options
| author | Peter Hutterer <peter.hutterer@who-t.net> | 2016-03-01 09:28:49 +1000 |
|---|---|---|
| committer | Bryce Harrington <bryce@osg.samsung.com> | 2016-03-07 11:55:48 -0800 |
| commit | 973a70dbb5a1d2865ec63a268e939585da5a951f (patch) | |
| tree | eb66a4242d1094e63f2043a63ca2eacb58862668 | |
| parent | 2b5310a367a81a6132207c398d188edc9e34c15f (diff) | |
| download | wayland-973a70dbb5a1d2865ec63a268e939585da5a951f.tar.gz | |
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 <peter.hutterer@who-t.net>
Reviewed-by: Bryce Harrington <bryce@osg.samsung.com>
| -rw-r--r-- | doc/doxygen/Makefile.am | 1 | ||||
| -rw-r--r-- | doc/doxygen/mainpage.dox | 9 |
2 files changed, 10 insertions, 0 deletions
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. |