aboutsummaryrefslogtreecommitdiffstats
path: root/doc/doxygen
diff options
context:
space:
mode:
authorBill Spitzak <spitzak@gmail.com>2014-12-16 19:23:03 -0800
committerPekka Paalanen <pekka.paalanen@collabora.co.uk>2014-12-18 15:13:39 +0200
commit6e3ad249adbf527e70d89fdb7dd25e289929f1a2 (patch)
treecb0f3a2bf985a4def39c60e5e2f848cdf2f6b4fc /doc/doxygen
parentdoc: fix for parallel make (diff)
downloadwayland-6e3ad249adbf527e70d89fdb7dd25e289929f1a2.tar
wayland-6e3ad249adbf527e70d89fdb7dd25e289929f1a2.tar.gz
wayland-6e3ad249adbf527e70d89fdb7dd25e289929f1a2.tar.bz2
wayland-6e3ad249adbf527e70d89fdb7dd25e289929f1a2.tar.lz
wayland-6e3ad249adbf527e70d89fdb7dd25e289929f1a2.tar.xz
wayland-6e3ad249adbf527e70d89fdb7dd25e289929f1a2.tar.zst
wayland-6e3ad249adbf527e70d89fdb7dd25e289929f1a2.zip
doc: Make it easier to add a new doxygen page
The repetitive parts of generating the server and client documentation are merged, so it is easier to add another doxygen chapter: add a new line to $publican_sources in publican/Makefile.am, and a list of C source files to doxygen/Makefile.am. Reviewed-by: Bryce Harrington <bryce@osg.samsung.com>
Diffstat (limited to 'doc/doxygen')
-rw-r--r--doc/doxygen/Makefile.am23
1 files changed, 8 insertions, 15 deletions
diff --git a/doc/doxygen/Makefile.am b/doc/doxygen/Makefile.am
index 8d563f4..8c4618a 100644
--- a/doc/doxygen/Makefile.am
+++ b/doc/doxygen/Makefile.am
@@ -1,24 +1,24 @@
-noinst_DATA = xml/client/index.xml xml/server/index.xml
+noinst_DATA = xml/Client/index.xml xml/Server/index.xml
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 = \
+scanned_src_files_Client = \
$(scanned_src_files_shared) \
$(top_srcdir)/src/wayland-client.c \
$(top_srcdir)/src/wayland-client.h
-scanned_src_files_server = \
+scanned_src_files_Server = \
$(scanned_src_files_shared) \
$(top_srcdir)/src/wayland-server.c \
$(top_srcdir)/src/wayland-server.h \
$(top_srcdir)/src/wayland-shm.c
scanned_src_files_man = \
- $(scanned_src_files_server) \
+ $(scanned_src_files_Server) \
$(top_srcdir)/src/wayland-client.c \
$(top_srcdir)/src/wayland-client.h
@@ -28,20 +28,13 @@ scanned_src_files_man = \
dist_man3_MANS = $(shell test -d man && find man/man3 -name "wl_*.3" -printf "man/man3/%P\n")
# Listing various directories that might need to be created.
-alldirs := xml/client xml/server man/man3
+alldirs := xml/Client xml/Server man/man3
-xml/client/index.xml: $(scanned_src_files_client) wayland.doxygen | xml/client
+xml/%/index.xml: $(scanned_src_files_%) wayland.doxygen | xml/%
$(AM_V_GEN)(cat wayland.doxygen; \
echo "GENERATE_XML=YES"; \
- echo "XML_OUTPUT=xml/client"; \
- echo "INPUT= $(scanned_src_files_client)"; \
- ) | $(DOXYGEN) -
-
-xml/server/index.xml: $(scanned_src_files_server) wayland.doxygen | xml/server
- $(AM_V_GEN)(cat wayland.doxygen; \
- echo "GENERATE_XML=YES"; \
- echo "XML_OUTPUT=xml/server"; \
- echo "INPUT= $(scanned_src_files_server)"; \
+ echo "XML_OUTPUT=xml/$*"; \
+ echo "INPUT= $(scanned_src_files_$*)"; \
) | $(DOXYGEN) -
man/man3/wl_display.3: $(scanned_src_files_man) wayland.doxygen | man/man3