luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2024-09-21 01:36:15 +02:00
Code Issues Packages Projects Releases Wiki Activity

Bug 535021 – g_param_spec_internal documentation should

Browse Source 
describe purpose of nick and blurb

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

svn path=/trunk/; revision=6940
This commit is contained in:
Matthias Clasen 2008-05-27 14:18:14 +00:00
parent 58e4b46343
commit 8b08deaaf5
2 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/reference/ChangeLog
View File

@ -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

7
docs/reference/gobject/tmpl/gparamspec.sgml
View File

@ -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