luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-02-26 12:12:10 +01:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source
This commit is contained in:
Emmanuele Bassi 2022-01-21 15:27:58 +00:00
parent e2fe3aa0e7
commit 1437be8049
1 changed files with 30 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
docs/reference/gio/gdbus-codegen.xml
View File

@ -35,6 +35,7 @@
<arg><option>--c-generate-autocleanup</option> none|objects|all</arg> <arg><option>--c-generate-autocleanup</option> none|objects|all</arg>
<arg><option>--output-directory</option> <replaceable>OUTDIR</replaceable></arg> <arg><option>--output-directory</option> <replaceable>OUTDIR</replaceable></arg>
<arg><option>--generate-docbook</option> <replaceable>OUTFILES</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>--pragma-once</option></arg>
<arg><option>--xml-files</option> <replaceable>FILE</replaceable></arg> <arg><option>--xml-files</option> <replaceable>FILE</replaceable></arg>
<arg><option>--header</option></arg> <arg><option>--header</option></arg>
@ -168,6 +169,16 @@
</para> </para>
</refsect1> </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> <refsect1>
<title>Options</title> <title>Options</title>
<para> <para>
@ -212,8 +223,25 @@
<listitem> <listitem>
<para> <para>
Generate Docbook Documentation for each D-Bus interface and Generate Docbook Documentation for each D-Bus interface and
put it in <filename>OUTFILES-NAME.xml</filename> where put it in <filename><replaceable>OUTFILES</replaceable>-<replaceable>NAME</replaceable>.xml</filename>
<literal>NAME</literal> is a place-holder for the interface 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. name, e.g. <literal>net.Corp.FooBar</literal> and so on.
</para> </para>
<para> <para>