Bug 535021 – g_param_spec_internal documentation should

        describe purpose of nick and blurb

        * gobject/tmpl/gparamspec.sgml: Explain nicks and blurbs
        some more.

svn path=/trunk/; revision=6940

diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog
index 911ff070f76fd868c4f3d1b496234982b2935ec1..39bdc7226beeb70d139374420d7669788d6a258a 100644 (file)
--- a/docs/reference/ChangeLog
+++ b/docs/reference/ChangeLog
@@ -1,3 +1,11 @@
+2008-05-27  Matthias Clasen  <mclasen@redhat.com>
+       
+       Bug 535021 – g_param_spec_internal documentation should 
+       describe purpose of nick and blurb
+
+       * gobject/tmpl/gparamspec.sgml: Explain nicks and blurbs
+       some more.
+
 2008-05-26  Matthias Clasen  <mclasen@redhat.com>
 
        * glib/glib-docs.sgml: Add 2.18 index

diff --git a/docs/reference/gobject/tmpl/gparamspec.sgml b/docs/reference/gobject/tmpl/gparamspec.sgml
index ed8a830828e5cbdf713a5a699c2d642c5a78034e..bff319dbca2b3d2eb3c865b783fe727c45c679f0 100644 (file)
--- a/docs/reference/gobject/tmpl/gparamspec.sgml
+++ b/docs/reference/gobject/tmpl/gparamspec.sgml
@@ -408,6 +408,13 @@ When creating and looking up a #GParamSpec, either separator can be used,
 but they cannot be mixed. Using '-' is considerably more efficient and in 
 fact required when using property names as detail strings for signals.
 </para>
+<para>
+Beyond the name, #GParamSpec<!-- -->s have two more descriptive strings 
+associated with them, the @nick, which should be suitable for use as 
+a label for the property in a property editor, and the @blurb, which should
+be a somewhat longer description, suitable for e.g. a tooltip. The @nick
+and @blurb should ideally be localized.
+</para>
 
 @param_type: the #GType for the property; must be derived from #G_TYPE_PARAM
 @name: the canonical name of the property