docs: code example for enumeration types
authorSébastien Wilmet <swilmet@gnome.org>
Thu, 18 Sep 2014 15:16:59 +0000 (17:16 +0200)
committerSébastien Wilmet <swilmet@gnome.org>
Sun, 8 Feb 2015 15:06:17 +0000 (16:06 +0100)
I had to read the GTK+ code recently to have an example.

https://bugzilla.gnome.org/show_bug.cgi?id=736914

gobject/genums.c

index d6dc559..a4f22c9 100644 (file)
  * GObject ships with a utility called [glib-mkenums][glib-mkenums],
  * that can construct suitable type registration functions from C enumeration
  * definitions.
+ *
+ * Example of how to get a string representation of an enum value:
+ * |[<!-- language="C" -->
+ * GEnumClass *enum_class;
+ * GEnumValue *enum_value;
+ *
+ * enum_class = g_type_class_ref (MAMAN_TYPE_MY_ENUM);
+ * enum_value = g_enum_get_value (enum_class, MAMAN_MY_ENUM_FOO);
+ *
+ * g_print ("Name: %s\n", enum_value->value_name);
+ *
+ * g_type_class_unref (enum_class);
+ * ]|
  */