File: attributes.rst

package info (click to toggle)
gi-docgen 2026.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 13,120 kB
  • sloc: python: 8,829; javascript: 658; makefile: 21
file content (42 lines) | stat: -rw-r--r-- 1,262 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
.. SPDX-FileCopyrightText: 2021 GNOME Foundation
..
.. SPDX-License-Identifier: Apache-2.0 OR GPL-3.0-or-later

Introspection attributes
========================

GI-DocGen consumes the following attributes found in the introspection data when
generating the API reference for that data.

Properties
----------

The following attributes apply to properties.

``org.gtk.Property.get`` = ``s``
  Defines the getter method for a given property. The value of the attribute is
  the C symbol of the function.

``org.gtk.Property.set`` = ``s``
  Defines the setter method for a given property. The value of the attribute is
  the C symbol of the function.

``org.gtk.Property.default`` = ``s``
  Defines the default value for a given property.

Methods
-------

The following attributes apply to methods of a classed type or interface.

``org.gtk.Method.set_property`` = ``s``
  Defines the property set by the function. The property name must be in
  the same type as the method

``org.gtk.Method.get_property`` = ``s``
  Defines the property retrieved by the function. The property name must
  be in the same type as the method

``org.gtk.Method.signal`` = ``s``
  Defines the signal emitted by the function. The signal name must be
  in the same type as the method