Changeset 26c597d

Timestamp:

03/03/2023 04:45:01 AM (14 months ago)

Author:

Xi Ruoyao <xry111@…>

Branches:

12.0, 12.1, kea, ken/TL2024, ken/tuningfonts, lazarus, lxqt, plabs/newcss, python3.11, qt5new, rahul/power-profiles-daemon, renodr/vulkan-addition, trunk, xry111/llvm18, xry111/xf86-video-removal

Children:

17217e43

Parents:

504e5ce

Message:

libnotify: Tell how to generate API doc with gi-docgen

File:

• x/lib/libnotify.xml (modified) (3 diffs)

x/lib/libnotify.xml

@@ -84 +84 @@
     <bridgehead renderas="sect4">Optional</bridgehead>
     <para role="optional">
-      <xref linkend="gtk-doc"/> and
+      <xref linkend="gi-docgen"/> and
       <xref linkend="xmlto"/>
     </para>
@@ -128 +128 @@
 
     <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   &amp;&amp;
+meson configure -Dgtk_doc=true         &amp;&amp;
+ninja</userinput></screen>
+
+    <para>
       Now, as the <systemitem class="username">root</systemitem> user:
     </para>
@@ -141 +152 @@
     <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>