[gobject-introspection/ebassi/property-annotation: 15/19] docs: Clarify scope of property-related annotations
- From: Emmanuele Bassi <ebassi src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gobject-introspection/ebassi/property-annotation: 15/19] docs: Clarify scope of property-related annotations
- Date: Wed, 28 Jul 2021 15:32:02 +0000 (UTC)
commit e617c04cd26808674a1d14acbce5b8f60a65f649
Author: Emmanuele Bassi <ebassi gnome org>
Date: Mon Jul 26 17:27:39 2021 +0100
docs: Clarify scope of property-related annotations
The `set-property` and `get-property` identifier annotations only apply
to methods.
The `setter` and `getter` identifier annotations only apply to
properties.
docs/website/annotations/giannotations.rst | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
---
diff --git a/docs/website/annotations/giannotations.rst b/docs/website/annotations/giannotations.rst
index 00c10db2..b37262fc 100644
--- a/docs/website/annotations/giannotations.rst
+++ b/docs/website/annotations/giannotations.rst
@@ -98,28 +98,28 @@ Support for GObject objects
- :commit:`v0.6.3 <fdbe3cc3>`
:bzbug:`557383`
* - ``(set-property NAME)``
- - identifier
+ - identifier (only applies to methods)
- 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
+ - identifier (only applies to methods)
- 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
+ - identifier (only applies to properties)
- 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
+ - identifier (only applies to properties)
- 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
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]