mirror of
https://github.com/Zeckmathederg/glfs.git
synced 2025-01-24 23:32:12 +08:00
libnotify: Tell how to generate API doc with gi-docgen
This commit is contained in:
parent
504e5cea0f
commit
26c597d579
@ -83,7 +83,7 @@
|
||||
|
||||
<bridgehead renderas="sect4">Optional</bridgehead>
|
||||
<para role="optional">
|
||||
<xref linkend="gtk-doc"/> and
|
||||
<xref linkend="gi-docgen"/> and
|
||||
<xref linkend="xmlto"/>
|
||||
</para>
|
||||
|
||||
@ -126,6 +126,17 @@ ninja</userinput></screen>
|
||||
This package does not come with a test suite.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
If you have <xref linkend='gi-docgen'/> installed and wish to build
|
||||
the API documentation for this package, issue:
|
||||
</para>
|
||||
|
||||
<!-- No &libnotify-version; here because we'll mv the doc dir anyway -->
|
||||
<screen remap='doc'><userinput>sed "/docs_dir =/s@\$@ / 'libnotify'@" \
|
||||
-i ../docs/reference/meson.build &&
|
||||
meson configure -Dgtk_doc=true &&
|
||||
ninja</userinput></screen>
|
||||
|
||||
<para>
|
||||
Now, as the <systemitem class="username">root</systemitem> user:
|
||||
</para>
|
||||
@ -140,13 +151,6 @@ mv -v /usr/share/doc/libnotify{,-&libnotify-version;}</userinput></screen>
|
||||
|
||||
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
||||
href="../../xincludes/meson-buildtype-release.xml"/>
|
||||
|
||||
<para>
|
||||
<parameter>-Dgtk_doc=false</parameter>: Remove this parameter if
|
||||
<application>GTK-Doc</application> is installed and you wish to rebuild
|
||||
and install the API documentation.
|
||||
</para>
|
||||
|
||||
</sect2>
|
||||
|
||||
<sect2 role="content">
|
||||
|
Loading…
Reference in New Issue
Block a user