From: Matthias Clasen Date: Tue, 27 May 2008 14:18:14 +0000 (+0000) Subject: Bug 535021 – g_param_spec_internal documentation should X-Git-Url: http://git.openbox.org/?a=commitdiff_plain;h=8b08deaaf5fbc270b534bf3a7b4e5f14280deb60;p=dana%2Fcg-glib.git 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 911ff070..39bdc722 100644 --- a/docs/reference/ChangeLog +++ b/docs/reference/ChangeLog @@ -1,3 +1,11 @@ +2008-05-27 Matthias Clasen + + 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 * 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 ed8a8308..bff319db 100644 --- 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. + +Beyond the name, #GParamSpecs 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. + @param_type: the #GType for the property; must be derived from #G_TYPE_PARAM @name: the canonical name of the property