Apply patches by Stefan Kost to document naming restrictions. (#167614)

2005-03-07  Matthias Clasen  <mclasen@redhat.com>

	* gobject/tmpl/gtype.sgml:
	* gobject/tmpl/param_value_types.sgml:
	* gobject/tmpl/gparamspec.sgml: Apply patches by
	Stefan Kost to document naming restrictions. (#167614)

diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog
index 8d72fdb..34aaade 100644 (file)
--- a/docs/reference/ChangeLog
+++ b/docs/reference/ChangeLog
@@ -1,3 +1,10 @@
+2005-03-07  Matthias Clasen  <mclasen@redhat.com>
+
+       * gobject/tmpl/gtype.sgml:
+       * gobject/tmpl/param_value_types.sgml:
+       * gobject/tmpl/gparamspec.sgml: Apply patches by
+       Stefan Kost to document naming restrictions. (#167614)
+
 2005-02-10  Matthias Clasen  <mclasen@redhat.com>
 
        * glib/tmpl/option.sgml: Fix a typo.  (#166985)

diff --git a/docs/reference/gobject/tmpl/gparamspec.sgml b/docs/reference/gobject/tmpl/gparamspec.sgml
index 84641c8..9e06678 100644 (file)
--- a/docs/reference/gobject/tmpl/gparamspec.sgml
+++ b/docs/reference/gobject/tmpl/gparamspec.sgml
@@ -9,6 +9,11 @@ Metadata for parameter specifications
 #GParamSpec is an object structure that encapsulates the metadata
 required to specify parameters, such as e.g. #GObject properties.
 </para>
+<para>
+Parameter names need to start with a letter (a-z or A-Z). Subsequent
+characters can be letters, numbers or a '-'.
+All other characters are replaced by a '-' during construction.
+</para>
 
 <!-- ##### SECTION See_Also ##### -->
 <para>

diff --git a/docs/reference/gobject/tmpl/gtype.sgml b/docs/reference/gobject/tmpl/gtype.sgml
index 2bcc054..93187d1 100644 (file)
--- a/docs/reference/gobject/tmpl/gtype.sgml
+++ b/docs/reference/gobject/tmpl/gtype.sgml
@@ -32,7 +32,13 @@ types called g_type_register_fundamental() which requires both a #GTypeInfo
 structure and a #GTypeFundamentalInfo structure but it is seldom used
 since most fundamental types are predefined rather than user-defined.
 </para>
-
+<para>
+A final word about type names.
+Such an identifier needs to be at least three characters long. There is no
+upper length limit. The first character needs to be a letter (a-z or A-Z)
+or an underscore '_'. Subsequent characters can be letters, numbers or
+any of '-_+'.
+</para>
 <!-- ##### SECTION See_Also ##### -->
 <para>
 

diff --git a/docs/reference/gobject/tmpl/param_value_types.sgml b/docs/reference/gobject/tmpl/param_value_types.sgml
index d3e28f2..72e6a2b 100644 (file)
--- a/docs/reference/gobject/tmpl/param_value_types.sgml
+++ b/docs/reference/gobject/tmpl/param_value_types.sgml
@@ -13,6 +13,11 @@ Parameter specifications for most value types can be created as
 #GParamSpec derived instances, to implement e.g. #GObject properties which
 operate on #GValue containers.
 </para>
+<para>
+Parameter names need to start with a letter (a-z or A-Z). Subsequent
+characters can be letters, numbers or a '-'.
+All other characters are replaced by a '-' during construction.
+</para>
 
 <!-- ##### SECTION See_Also ##### -->
 <para>