2.17.1

[platform/upstream/glib.git] / docs / reference / gobject / tmpl / gparamspec.sgml

diff --git a/docs/reference/gobject/tmpl/gparamspec.sgml b/docs/reference/gobject/tmpl/gparamspec.sgml
index 7bad6b8..cebf58e 100644 (file)
--- a/docs/reference/gobject/tmpl/gparamspec.sgml
+++ b/docs/reference/gobject/tmpl/gparamspec.sgml
@@ -149,11 +149,10 @@ can be configured.
                          parameter is guaranteed to remain valid and
                          unmodified for the lifetime of the parameter. 
                          Since 2.8
-@G_PARAM_PRIVATE:        Old name for the %G_PARAM_STATIC_NAME flag. 
-                         Deprecated since 2.8.
-@G_PARAM_STATIC_NICK:    the string used as nick when constructing the 
-                         parameter is guaranteed to remain valid and 
-                         unmodified for the lifetime of the parameter. 
+@G_PARAM_PRIVATE: 
+@G_PARAM_STATIC_NICK:    the string used as nick when constructing the
+                         parameter is guaranteed to remain valid and
+                         unmmodified for the lifetime of the parameter.
                          Since 2.8
 @G_PARAM_STATIC_BLURB:   the string used as blurb when constructing the 
                          parameter is guaranteed to remain valid and 
@@ -412,6 +411,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