Add a hint about the requirement that enum and flags values must be

2006-10-08  Matthias Clasen  <mclasen@redhat.com>

	* gobject/tmpl/enumerations_flags.sgml: Add a hint about
	the requirement that enum and flags values must be static.

diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog
index e15440f..9ed7634 100644 (file)
--- a/docs/reference/ChangeLog
+++ b/docs/reference/ChangeLog
@@ -1,3 +1,8 @@
+2006-10-08  Matthias Clasen  <mclasen@redhat.com>
+
+       * gobject/tmpl/enumerations_flags.sgml: Add a hint about
+       the requirement that enum and flags values must be static.
+
 2006-10-01  Matthias Clasen  <mclasen@redhat.com>
 
        * glib/tmpl/option.sgml: Improve example.  (#367625, Ross Burton) 

diff --git a/docs/reference/gobject/tmpl/enumerations_flags.sgml b/docs/reference/gobject/tmpl/enumerations_flags.sgml
index b93528e..1a896f7 100644 (file)
--- a/docs/reference/gobject/tmpl/enumerations_flags.sgml
+++ b/docs/reference/gobject/tmpl/enumerations_flags.sgml
@@ -232,12 +232,11 @@ than to write one yourself using g_enum_register_static().
 </para>
 
 @name: A nul-terminated string used as the name of the new type.
-@_static_values: 
-@Returns: The new type identifier.
-<!-- # Unused Parameters # -->
 @const_static_values: An array of #GEnumValue structs for the possible
   enumeration values. The array is terminated by a struct with all 
-  members being 0.
+  members being 0. GObject keeps a reference to the data, so it cannot
+  be stack-allocated.
+@Returns: The new type identifier.
 
 
 <!-- ##### FUNCTION g_flags_register_static ##### -->
@@ -251,12 +250,10 @@ than to write one yourself using g_flags_register_static().
 </para>
 
 @name: A nul-terminated string used as the name of the new type.
-@_static_values: 
-@Returns: The new type identifier.
-<!-- # Unused Parameters # -->
 @const_static_values: An array of #GFlagsValue structs for the possible
   flags values. The array is terminated by a struct with all members being 0.
-
+  GObject keeps a reference to the data, so it cannot be stack-allocated.
+@Returns: The new type identifier.
 
 <!-- ##### FUNCTION g_enum_complete_type_info ##### -->
 <para>