diff options
| author | Peter Hutterer <peter.hutterer@who-t.net> | 2013-04-02 10:09:06 +1000 |
|---|---|---|
| committer | Kristian Høgsberg <krh@bitplanet.net> | 2013-04-03 14:57:37 -0400 |
| commit | ee569711ee8aa67db6896c945bdf9482d870a0c4 (patch) | |
| tree | 1d20ea15e4d4b6adf107f02af9a24e9816110e75 /doc | |
| parent | dcb402a2c2506105f5ded586d016f9f97b10dc2e (diff) | |
doc: clarify how ClientAPI.xml is built
I found the comment a bit confusing and it's quite hard to read. re-explain
with a simple step-by-step list
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/Wayland/Makefile.am | 9 |
1 files changed, 6 insertions, 3 deletions
diff --git a/doc/Wayland/Makefile.am b/doc/Wayland/Makefile.am index 542d04b..2e4075f 100644 --- a/doc/Wayland/Makefile.am +++ b/doc/Wayland/Makefile.am @@ -36,9 +36,12 @@ en-US/ProtocolInterfaces.xml: $(top_srcdir)/protocol/wayland.xml $(srcdir)/proto $(AM_V_GEN)$(XSLTPROC) $(srcdir)/protocol-interfaces-to-docbook.xsl \ $(top_srcdir)/protocol/wayland.xml > en-US/ProtocolInterfaces.xml -# WaylandClientAPI.xml is generated after combining all xml in one single file -# with the exception of wayland-client_8h.xml that is omitted to not duplicate -# the output methods. +# WaylandClientAPI.xml: +# * we don't want wayland-client_8h.xml to avoid duplicating output methods, +# move it out of the way first. +# * use doxygen's combine.xslt to merge the xml files into one single file +# * move wayland-client_8h.xml back to its original location +# * transform the combined XML file into docbook format en-US/WaylandClientAPI.xml: $(top_builddir)/doc/doxygen/xml/index.xml $(srcdir)/doxygen-to-publican.xsl $(AM_V_GEN)$(MKDIR_P) en-US/images $(AM_V_GEN)mv $(top_builddir)/doc/doxygen/xml/wayland-client_8h.xml \ |