[glib/ebassi/gdbus-codegen-rst: 5/7] docs: Add --generate-rst to the gdbus-codegen docs




commit 1437be80496bee3d65a2836149560d74dc9766d7
Author: Emmanuele Bassi <ebassi gnome org>
Date:   Fri Jan 21 15:27:58 2022 +0000

    docs: Add --generate-rst to the gdbus-codegen docs

 docs/reference/gio/gdbus-codegen.xml | 32 ++++++++++++++++++++++++++++++--
 1 file changed, 30 insertions(+), 2 deletions(-)
---
diff --git a/docs/reference/gio/gdbus-codegen.xml b/docs/reference/gio/gdbus-codegen.xml
index 960b5ffa0..5860fed97 100644
--- a/docs/reference/gio/gdbus-codegen.xml
+++ b/docs/reference/gio/gdbus-codegen.xml
@@ -35,6 +35,7 @@
     <arg><option>--c-generate-autocleanup</option> none|objects|all</arg>
     <arg><option>--output-directory</option> <replaceable>OUTDIR</replaceable></arg>
     <arg><option>--generate-docbook</option> <replaceable>OUTFILES</replaceable></arg>
+    <arg><option>--generate-rst</option> <replaceable>OUTFILES</replaceable></arg>
     <arg><option>--pragma-once</option></arg>
     <arg><option>--xml-files</option> <replaceable>FILE</replaceable></arg>
     <arg><option>--header</option></arg>
@@ -168,6 +169,16 @@
   </para>
 </refsect1>
 
+<refsect1>
+  <title>Generating reStructuredText documentation</title>
+  <para>
+    Each generated reStructuredText file (see the
+    <option>--generate-rst</option> option for details) is a plain text
+    <ulink url="https://docutils.sourceforge.io/rst.html";>reStructuredText</ulink>
+    document describing the D-Bus interface.
+  </para>
+</refsect1>
+
 <refsect1>
   <title>Options</title>
   <para>
@@ -212,8 +223,25 @@
       <listitem>
         <para>
           Generate Docbook Documentation for each D-Bus interface and
-          put it in <filename>OUTFILES-NAME.xml</filename> where
-          <literal>NAME</literal> is a place-holder for the interface
+          put it in 
<filename><replaceable>OUTFILES</replaceable>-<replaceable>NAME</replaceable>.xml</filename>
+          where <literal>NAME</literal> is a place-holder for the interface
+          name, e.g. <literal>net.Corp.FooBar</literal> and so on.
+        </para>
+        <para>
+          Pass <option>--output-directory</option> to specify the directory
+          to put the output files in. By default the current directory
+          will be used.
+        </para>
+      </listitem>
+    </varlistentry>
+
+    <varlistentry>
+      <term><option>--generate-rst</option> <replaceable>OUTFILES</replaceable></term>
+      <listitem>
+        <para>
+          Generate reStructuredText Documentation for each D-Bus interface and
+          put it in 
<filename><replaceable>OUTFILES</replaceable>-<replaceanle>NAME</replaceanle>.rst</filename>
+          where <literal>NAME</literal> is a place-holder for the interface
           name, e.g. <literal>net.Corp.FooBar</literal> and so on.
         </para>
         <para>


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]