From 4d1132a945429ce56a58c79215c9bc277282bd66 Mon Sep 17 00:00:00 2001 From: Aleksander Morgado Date: Thu, 14 May 2020 16:02:32 +0200 Subject: [PATCH] docs,glib-mkenums: setup lists for enum/value trigraph extensions Signed-off-by: Aleksander Morgado --- 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 /*< and end with the trigraph sequence >*/. -Per enum definition, the options skip and flags 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 underscore_name -option can be used to specify the word separation used in the *_get_type() + + +The following options can be specified per enum definition: + + +skip + +Indicates this enum definition should be skipped. + + + +flags + +Indicates this enum should be treated as a flags definition. + + + +underscore_name + +Specifies the word separation used in the *_get_type() function. For instance, /*< underscore_name=gnome_vfs_uri_hide_options >*/. - - -Per value definition, the options skip and nick are supported. -The former causes the value to be skipped, and the latter can be used to -specify the otherwise auto-generated nickname. -Examples: - + + + + +The following options can be specified per value definition: + + +skip + +Indicates the value should be skipped. + + + +nick + +Specifies the otherwise auto-generated nickname. + + + + +Examples: typedef enum /*< skip >*/ {