diff options
| author | Simon McVittie <smcv@collabora.com> | 2018-04-23 11:22:41 +0100 |
|---|---|---|
| committer | Simon McVittie <smcv@collabora.com> | 2018-04-23 17:46:01 +0100 |
| commit | dbeeaf3ad8018d477bb52b64711922f4e6311c69 (patch) | |
| tree | e8bcf34c936cfc8bd611437e51c2146400a0a9c1 | |
| parent | 6adba11fdfce6ae45da4d28c194548d950cd4c7a (diff) | |
| download | dbus-dbeeaf3ad8018d477bb52b64711922f4e6311c69.tar.gz | |
doxygen_to_devhelp: Produce Devhelp index format v2
The old version-1 format is deprecated and now produces warnings.
Bug: https://bugs.freedesktop.org/show_bug.cgi?id=106186
Reviewed-by: Philip Withnall <withnall@endlessm.com>
[smcv: Add the .devhelp2 file to .gitignore as suggested]
Signed-off-by: Simon McVittie <smcv@collabora.com>
(cherry picked from commit fa922639207de16d459983144ddad28b7abe60c2)
| -rw-r--r-- | doc/.gitignore | 1 | ||||
| -rw-r--r-- | doc/Makefile.am | 4 | ||||
| -rw-r--r-- | doc/doxygen_to_devhelp.xsl | 7 |
3 files changed, 9 insertions, 3 deletions
diff --git a/doc/.gitignore b/doc/.gitignore index 7e024f99..6bc82863 100644 --- a/doc/.gitignore +++ b/doc/.gitignore @@ -10,6 +10,7 @@ Makefile.in *.o api dbus.devhelp +/dbus.devhelp2 dbus-specification.html dbus-test-plan.html dbus-tutorial.html diff --git a/doc/Makefile.am b/doc/Makefile.am index cf2b667f..b10409c5 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -98,9 +98,9 @@ doxygen.stamp: $(wildcard $(top_srcdir)/dbus/*.[ch]) @touch $@ if DBUS_HAVE_XSLTPROC -html_DATA += dbus.devhelp +html_DATA += dbus.devhelp2 -dbus.devhelp: $(srcdir)/doxygen_to_devhelp.xsl doxygen.stamp +dbus.devhelp2: $(srcdir)/doxygen_to_devhelp.xsl doxygen.stamp $(XSLTPROC) -o $@ $< api/xml/index.xml endif diff --git a/doc/doxygen_to_devhelp.xsl b/doc/doxygen_to_devhelp.xsl index 6f6a79bd..fd33bcee 100644 --- a/doc/doxygen_to_devhelp.xsl +++ b/doc/doxygen_to_devhelp.xsl @@ -11,6 +11,11 @@ <book title="D-Bus: A system for interprocess communication" name="dbus" link="{$prefix}/api/index.html" + xmlns="http://www.devhelp.net/book" + version="2" + online="https://dbus.freedesktop.org/doc/" + author="D-Bus contributors" + language="c" > <chapters> <sub name="Tutorial" link="{$prefix}dbus-tutorial.html"/> @@ -33,7 +38,7 @@ <xsl:param name="link"><xsl:value-of select="$before"/>.html#<xsl:value-of select="$after"/></xsl:param> <xsl:if test="starts-with($name,'dbus') or starts-with($name, 'DBus')"> <xsl:if test="starts-with($refid,'group__') and contains($refid, '_1')"> - <function name="{$name}" link="{$prefix}api/{$link}"/> + <keyword xmlns="http://www.devhelp.net/book" type="function" name="{$name}" link="{$prefix}api/{$link}"/> </xsl:if> </xsl:if> </xsl:template> |