mirrors/wayland
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/wayland/wayland.git synced 2026-04-02 07:15:53 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

doc: link between client and server doc and to the wayland book

Browse source 
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>
This commit is contained in:
Peter Hutterer 2016-03-01 09:28:49 +10:00 • committed by Bryce Harrington
parent 2b5310a367
commit 973a70dbb5
2 changed files with 10 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

1
doc/doxygen/Makefile.am
View file

@ -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/% html/%/index.html: $(scanned_src_files_%) wayland.doxygen $(diagrams) $(diagram_maps) | html/%
$(AM_V_GEN)(cat wayland.doxygen; \ $(AM_V_GEN)(cat wayland.doxygen; \
echo "PROJECT_NAME=\"Wayland $* API\""; \
echo "GENERATE_HTML=YES"; \ echo "GENERATE_HTML=YES"; \
echo "HTML_OUTPUT=html/$*"; \ echo "HTML_OUTPUT=html/$*"; \
echo "INPUT= $(scanned_src_files_$*) $(extra_doxygen_$*)"; \ echo "INPUT= $(scanned_src_files_$*) $(extra_doxygen_$*)"; \

9
doc/doxygen/mainpage.dox
View file

@ -2,6 +2,15 @@
* @mainpage * @mainpage
* Wayland protocol API documentation. * 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 * @section ifaces Interfaces
* For the list of available interfaces, please see the * For the list of available interfaces, please see the
* <a href="modules.html">modules</a> list. * <a href="modules.html">modules</a> list.