glib r6940 - in trunk/docs/reference: . gobject/tmpl

[matthiasc svn gnome org]

Author: matthiasc
Date: Tue May 27 14:18:14 2008
New Revision: 6940
URL: http://svn.gnome.org/viewvc/glib?rev=6940&view=rev

Log:
        Bug 535021 â g_param_spec_internal documentation should
        describe purpose of nick and blurb

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


Modified:
   trunk/docs/reference/ChangeLog
   trunk/docs/reference/gobject/tmpl/gparamspec.sgml

Modified: trunk/docs/reference/gobject/tmpl/gparamspec.sgml
==============================================================================
--- trunk/docs/reference/gobject/tmpl/gparamspec.sgml	(original)
+++ trunk/docs/reference/gobject/tmpl/gparamspec.sgml	Tue May 27 14:18:14 2008
@@ -408,6 +408,13 @@
 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