aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorFriedemann Kleint <[email protected]>2025-04-25 10:33:38 +0200
committerFriedemann Kleint <[email protected]>2025-04-28 11:56:05 +0200
commite55bad3c11de793828fb1bdb503d1631c153a488 (patch)
tree30179b13e7a4ab509f40ee7612b572fe014bdd0a
parent64a0e8bad7e2c3d74b216aff0c57983280efcede (diff)
shiboken6: Rephrase documentation of the default-superclass attributeHEADdev
Mention that it needs to be a direct base class. Pick-to: 6.9 6.8 Task-number: PYSIDE-3069 Task-number: PYSIDE-86 Task-number: PYSIDE-1887 Change-Id: I7e153bd839ba600d98993d24cfcc40feb0299849 Reviewed-by: Christian Tismer <[email protected]>
-rw-r--r--sources/shiboken6/doc/typesystem_specifying_types.rst9
1 files changed, 6 insertions, 3 deletions
diff --git a/sources/shiboken6/doc/typesystem_specifying_types.rst b/sources/shiboken6/doc/typesystem_specifying_types.rst
index a8d9b96bc..c03d203b9 100644
--- a/sources/shiboken6/doc/typesystem_specifying_types.rst
+++ b/sources/shiboken6/doc/typesystem_specifying_types.rst
@@ -501,12 +501,15 @@ contain :ref:`add-function`, :ref:`add-pymethoddef`,
doc-file = "..." />
</typesystem>
-The **name** attribute is the fully qualified C++ class name. If there is no
-C++ base class, the default-superclass attribute can be used to specify a
-superclass for the given type, in the generated target language API. The
+The **name** attribute is the fully qualified C++ class name. The
**copyable** and **hash-function** attributes are the same as described for
:ref:`value-type`.
+The *optional* **default-superclass** attribute can be used to specify a
+superclass for the given type in the generated target language API.
+This can be useful if the C++ base class is not exposed. The specified
+super class needs to be a direct base class of the class in question.
+
The *optional* **force-abstract** attribute forces the class to be
abstract, disabling its instantiation. The generator will normally detect
this automatically unless the class inherits from an abstract base class