[gobject-introspection/ebassi/property-annotation: 11/19] docs: Clarify the meaning of accessor functions
- From: Emmanuele Bassi <ebassi src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gobject-introspection/ebassi/property-annotation: 11/19] docs: Clarify the meaning of accessor functions
- Date: Wed, 28 Jul 2021 15:32:02 +0000 (UTC)
commit 56e02111b932a0b6fbc5e21a2e34390c8986a402
Author: Emmanuele Bassi <ebassi gnome org>
Date: Thu Jun 17 14:33:52 2021 +0100
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().
docs/website/annotations/giannotations.rst | 20 ++++++++++++++++----
1 file 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`
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]