diff options
author | Emmanuele Bassi <ebassi@gnome.org> | 2021-06-17 14:33:52 +0100 |
---|---|---|
committer | Emmanuele Bassi <ebassi@gnome.org> | 2021-08-05 17:47:29 +0100 |
commit | de2f64c43b5a2d6b252c3cf716466041492e5dc6 (patch) | |
tree | 956a4171d9396222af60313d5171e1a8b5849a3d /docs | |
parent | a2067865807b26be8667574a564e942409121256 (diff) | |
download | gobject-introspection-de2f64c43b5a2d6b252c3cf716466041492e5dc6.tar.gz |
docs: Clarify the meaning of accessor functions
Public accessor functions are the functions typically called through
g_object_set_property() and g_object_get_property().
Diffstat (limited to 'docs')
-rw-r--r-- | docs/website/annotations/giannotations.rst | 20 |
1 files changed, 16 insertions, 4 deletions
diff --git a/docs/website/annotations/giannotations.rst b/docs/website/annotations/giannotations.rst index 10582739..00c10db2 100644 --- a/docs/website/annotations/giannotations.rst +++ b/docs/website/annotations/giannotations.rst @@ -99,19 +99,31 @@ Support for GObject objects :bzbug:`557383` * - ``(set-property NAME)`` - identifier - - This function is a setter method for the given GObject property. + - This function is the setter method for the given GObject property. + A setter function is defined as being the public function that is + called by the ``GObjectClass.set_property`` implementation in a + class. - :issue:`13` * - ``(get-property NAME)`` - identifier - - This function is a getter method for the given GObject property. + - This function is the getter method for the given GObject property. + A getter function is defined as being the public function that is + called by the ``GObjectClass.get_property`` implementation in a + class. - :issue:`13` * - ``(setter SYMBOL)`` - identifier - - This GObject property is accessed by the given setter function + - This GObject property is accessed by the given setter function. + A setter function is defined as being the public function that is + called by the ``GObjectClass.set_property`` implementation in a + class. - :issue:`13` * - ``(getter SYMBOL)`` - identifier - - This GObject property is accessed by the given getter function + - This GObject property is accessed by the given getter function. + A getter function is defined as being the public function that is + called by the ``GObjectClass.get_property`` implementation in a + class. - :issue:`13` |