diff options
author | Friedemann Kleint <Friedemann.Kleint@qt.io> | 2024-01-29 20:21:31 +0100 |
---|---|---|
committer | Qt Cherry-pick Bot <cherrypick_bot@qt-project.org> | 2024-01-30 14:11:54 +0000 |
commit | 663948a5c0b64155892e865cb476b0105a4413f7 (patch) | |
tree | 7c743bdfca726a59affe8ed4d76cee1729602f60 | |
parent | ce29b3372e75fccc24ca16651266569a674f1604 (diff) |
shiboken6: Document missing namespace attributes
Amends 91cb27a2a7180e9c05b806d870b266fa31bef041
Pick-to: 6.2
Change-Id: Id68305dbe40727e85c7d483e5692d0329bee2f02
Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io>
(cherry picked from commit 7088823da7c04a433b140f070f18dba0d744f95f)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
-rw-r--r-- | sources/shiboken6/doc/typesystem_specifying_types.rst | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/sources/shiboken6/doc/typesystem_specifying_types.rst b/sources/shiboken6/doc/typesystem_specifying_types.rst index 7152c70af..406d51650 100644 --- a/sources/shiboken6/doc/typesystem_specifying_types.rst +++ b/sources/shiboken6/doc/typesystem_specifying_types.rst @@ -205,6 +205,8 @@ child nodes. generate-using="yes | no" package="..." since="..." + extends = "..." + files = "..." revision="..." /> </typesystem> @@ -235,6 +237,16 @@ The *optional* **since** value is used to specify the API version of this type. The **revision** attribute can be used to specify a revision for each type, easing the production of ABI compatible bindings. +The *optional* **extends** attribute specifies the module name where the given +namespace first occurs in case of a namespace spanning several modules. For +example, in Qt, the namespace ``Qt`` first occurs in the ``QtCore`` module and +is further populated in the ``QtGui`` module. ``QtGui.Qt`` will then be +generated extending ``QtCore.Qt`` if **extends** is specified. + +The *optional* **file** attribute specifies a regular expression matching the +include files whose contents are to be associated with the current module in +case of a namespace spanning several modules. + .. _enum-type: enum-type |