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: generate server documentation from XML too

Browse source 
Same as WaylandClientAPI.xml we now also generate WaylandServerAPI.xml for
publication. Most of this hunk is just adding a client/ or server/ into the
xml path to keep the two separate.

The change in wayland.doxygen now causes a standard doxygen call to not
generate anything - what is generated is specified through the options
passed by make.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
This commit is contained in:
Peter Hutterer 2013-04-04 11:28:58 +10:00 • committed by Kristian Høgsberg
parent 5e014c81cc
commit b1d7131c36
5 changed files with 50 additions and 22 deletions
Download patch file Download diff file Expand all files Collapse all files

19
doc/doxygen/Makefile.am
View file

@ -1,5 +1,5 @@
noinst_DATA = xml/index.xml
noinst_DATA = xml/client/index.xml xml/server/index.xml
dist_noinst_DATA = wayland.doxygen.in
scanned_src_files_client = \
@ -61,12 +61,23 @@ server_MANPAGES = \
man3_MANS= $(client_MANPAGES) $(server_MANPAGES)
xml/index.xml: $(scanned_src_files_client) wayland.doxygen
doxygen wayland.doxygen
xml/client/index.xml: $(scanned_src_files_client) wayland.doxygen
$(AM_V_GEN)$(MKDIR_P) xml/client
(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
$(AM_V_GEN)$(MKDIR_P) xml/server
(cat wayland.doxygen; \
echo "GENERATE_XML=YES"; \
echo "XML_OUTPUT=xml/server"; \
echo "INPUT= $(scanned_src_files_server)"; \
) | doxygen -
doxygen.man: $(scanned_src_files_client) $(scanned_src_files_server)
(cat wayland.doxygen; \
echo "GENERATE_XML=NO"; \
echo "GENERATE_MAN=YES"; \
echo "MAN_OUTPUT=man"; \
echo "JAVADOC_AUTOBRIEF=NO"; \

5
doc/doxygen/wayland.doxygen.in
View file

@ -642,8 +642,7 @@ WARN_LOGFILE =
# directories like "/usr/src/myproject". Separate the files or directories
# with spaces.
INPUT = @top_srcdir@/src/wayland-client.c \
@top_srcdir@/src/wayland-client.h
INPUT =
# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
@ -1364,7 +1363,7 @@ MAN_LINKS = YES
# generate an XML file that captures the structure of
# the code including all documentation.
GENERATE_XML = YES
GENERATE_XML = NO
# The XML_OUTPUT tag is used to specify where the XML pages will be put.
# If a relative path is entered the value of OUTPUT_DIRECTORY will be