luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-10-31 16:32:18 +01:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'gobject_fix_links_to_param_name_rules' into 'main'

Browse Source 
gobject: fix broken links to parameters and signals naming rules

See merge request GNOME/glib!4083
This commit is contained in:
Philip Withnall
2024-05-21 22:32:21 +00:00
parent 317739c8e2 d6e0cf9884
commit dc24e78286
3 changed files with 8 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
gobject/gobject.c
View File

@@ -1020,7 +1020,7 @@ g_object_do_class_init (GObjectClass *class)
* ]|
*
* It is important to note that you must use
* [canonical parameter names][canonical-parameter-names] as
* [canonical parameter names][class@GObject.ParamSpec#parameter-names] as
* detail strings for the notify signal.
*/
gobject_signals[NOTIFY] =

10
gobject/gparam.c
View File

@@ -389,8 +389,8 @@ is_canonical (const gchar *key)
* dynamically-generated properties which need to be validated at run-time
* before actually trying to create them.
*
* See [canonical parameter names][canonical-parameter-names] for details of
* the rules for valid names.
* See [canonical parameter names][class@GObject.ParamSpec#parameter-names]
* for details of the rules for valid names.
*
* Returns: %TRUE if @name is a valid property name, %FALSE otherwise.
* Since: 2.66
@@ -429,9 +429,9 @@ g_param_spec_is_valid_name (const gchar *name)
*
* Creates a new #GParamSpec instance.
*
* See [canonical parameter names][canonical-parameter-names] for details of
* the rules for @name. Names which violate these rules lead to undefined
* behaviour.
* See [canonical parameter names][class@GObject.ParamSpec#parameter-names]
* for details of the rules for @name. Names which violate these rules lead
* to undefined behaviour.
*
* Beyond the name, #GParamSpecs have two more descriptive strings, the
* @nick and @blurb, which may be used as a localized label and description.

5
gobject/gsignal.c
View File

@@ -283,9 +283,8 @@ is_canonical (const gchar *key)
* Validate a signal name. This can be useful for dynamically-generated signals
* which need to be validated at run-time before actually trying to create them.
*
* See [canonical parameter names][canonical-parameter-names] for details of
* the rules for valid names. The rules for signal names are the same as those
* for property names.
* See [func@GObject.signal_new] for details of the rules for valid names.
* The rules for signal names are the same as those for property names.
*
* Returns: %TRUE if @name is a valid signal name, %FALSE otherwise.
* Since: 2.66