[glib/fix-gnulib-msvc-isnan: 5/37] docs, glib-mkenums: setup lists for enum/value trigraph extensions
- From: Chun-wei Fan <fanchunwei src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [glib/fix-gnulib-msvc-isnan: 5/37] docs, glib-mkenums: setup lists for enum/value trigraph extensions
- Date: Tue, 9 Jun 2020 10:21:34 +0000 (UTC)
commit 87adc7e712c54408be82d6961833cd6436774dc1
Author: Aleksander Morgado <aleksander aleksander es>
Date: Thu May 14 16:02:32 2020 +0200
docs,glib-mkenums: setup lists for enum/value trigraph extensions
Signed-off-by: Aleksander Morgado <aleksander aleksander es>
docs/reference/gobject/glib-mkenums.xml | 53 +++++++++++++++++++++++++--------
1 file changed, 41 insertions(+), 12 deletions(-)
---
diff --git a/docs/reference/gobject/glib-mkenums.xml b/docs/reference/gobject/glib-mkenums.xml
index 9dac8217d..e1683860a 100644
--- a/docs/reference/gobject/glib-mkenums.xml
+++ b/docs/reference/gobject/glib-mkenums.xml
@@ -172,19 +172,48 @@ in your templates, to improve the reproducibility of the build. (Since: 2.22)
Some C comments are treated specially in the parsed enum definitions,
such comments start out with the trigraph sequence <literal>/*<</literal>
and end with the trigraph sequence <literal>>*/</literal>.
-Per enum definition, the options <literal>skip</literal> and <literal>flags</literal> can be specified, to
-indicate this enum definition to be skipped, or for it to be treated as
-a flags definition, or to specify the common prefix to be stripped from
-all values to generate value nicknames, respectively. The <literal>underscore_name</literal>
-option can be used to specify the word separation used in the <function>*_get_type()</function>
-function. For instance, <literal>/*< underscore_name=gnome_vfs_uri_hide_options >*/</literal>.
-</para>
-<para>
-Per value definition, the options <literal>skip</literal> and <literal>nick</literal> are supported.
-The former causes the value to be skipped, and the latter can be used to
-specify the otherwise auto-generated nickname.
-Examples:
</para>
+
+<para>The following options can be specified per enum definition:</para>
+<variablelist>
+<varlistentry>
+<term><literal>skip</literal></term>
+<listitem><para>
+Indicates this enum definition should be skipped.
+</para></listitem>
+</varlistentry>
+<varlistentry>
+<term><literal>flags</literal></term>
+<listitem><para>
+Indicates this enum should be treated as a flags definition.
+</para></listitem>
+</varlistentry>
+<varlistentry>
+<term><literal>underscore_name</literal></term>
+<listitem><para>
+Specifies the word separation used in the <function>*_get_type()</function>
+function. For instance, <literal>/*< underscore_name=gnome_vfs_uri_hide_options >*/</literal>.
+</para></listitem>
+</varlistentry>
+</variablelist>
+
+<para>The following options can be specified per value definition:</para>
+<variablelist>
+<varlistentry>
+<term><literal>skip</literal></term>
+<listitem><para>
+Indicates the value should be skipped.
+</para></listitem>
+</varlistentry>
+<varlistentry>
+<term><literal>nick</literal></term>
+<listitem><para>
+Specifies the otherwise auto-generated nickname.
+</para></listitem>
+</varlistentry>
+</variablelist>
+
+<para>Examples:</para>
<informalexample><programlisting>
typedef enum /*< skip >*/
{
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]