diff options
| author | Friedemann Kleint <Friedemann.Kleint@qt.io> | 2025-01-16 13:44:36 +0100 |
|---|---|---|
| committer | Friedemann Kleint <Friedemann.Kleint@qt.io> | 2025-01-20 17:33:14 +0100 |
| commit | 20d84ed06a2ab988267b35d33cfe6627eb84d80b (patch) | |
| tree | 03ba1ec56e2be5650e35a302714f86a693e69107 /sources/pyside6/PySide6 | |
| parent | 13dc50731724502f2f3c1fe0c8ead3081fa94c24 (diff) | |
shiboken6/documentation: Add emphasis for doc injection
Add a custom admonition for modified functions
to highlight Python-specific aspects.
Pick-to: 6.8
Task-number: PYSIDE-1106
Change-Id: I3fd32151b0786b6225970a7a05df56953d999fb1
Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
Diffstat (limited to 'sources/pyside6/PySide6')
3 files changed, 4 insertions, 4 deletions
diff --git a/sources/pyside6/PySide6/QtCore/typesystem_core_common.xml b/sources/pyside6/PySide6/QtCore/typesystem_core_common.xml index 2374055e2..cbcbbf8f6 100644 --- a/sources/pyside6/PySide6/QtCore/typesystem_core_common.xml +++ b/sources/pyside6/PySide6/QtCore/typesystem_core_common.xml @@ -784,7 +784,7 @@ <object-type name="QResource"> <enum-type name="Compression"/> <modify-function signature="data()const"> - <inject-documentation format="target"> + <inject-documentation format="target" emphasis="language-note"> Returns a read only buffer object pointing to the segment of data that this resource represents. If the resource is compressed the data returns is compressed and qUncompress() must be used to access the data. If the resource is a directory None is returned. </inject-documentation> <modify-argument index="return"> diff --git a/sources/pyside6/PySide6/QtDBus/typesystem_dbus.xml b/sources/pyside6/PySide6/QtDBus/typesystem_dbus.xml index f70a7ca44..c8d7221c4 100644 --- a/sources/pyside6/PySide6/QtDBus/typesystem_dbus.xml +++ b/sources/pyside6/PySide6/QtDBus/typesystem_dbus.xml @@ -86,7 +86,7 @@ <enum-type name="ErrorType"/> </value-type> <object-type name="QDBusInterface" qt-metaobject="no"> - <inject-documentation format="target" mode="append"> + <inject-documentation format="target" mode="append" emphasis="language-note"> DBus signals can be captured with string-based connections (see :ref:`signals-and-slots-strings`). </inject-documentation> diff --git a/sources/pyside6/PySide6/QtSerialBus/typesystem_serialbus.xml b/sources/pyside6/PySide6/QtSerialBus/typesystem_serialbus.xml index 186141ff2..6cf562c52 100644 --- a/sources/pyside6/PySide6/QtSerialBus/typesystem_serialbus.xml +++ b/sources/pyside6/PySide6/QtSerialBus/typesystem_serialbus.xml @@ -44,7 +44,7 @@ </modify-argument> <inject-code class="target" position="beginning" file="../glue/qtserialbus.cpp" snippet="qcanbus-available-devices-plugin"/> - <inject-documentation format="target" mode="append"> + <inject-documentation format="target" mode="append" emphasis="language-note"> The function returns a tuple of (device_list, error_string). </inject-documentation> </modify-function> @@ -60,7 +60,7 @@ </modify-argument> <inject-code class="target" position="beginning" file="../glue/qtserialbus.cpp" snippet="qcanbus-createdevice"/> - <inject-documentation format="target" mode="append"> + <inject-documentation format="target" mode="append" emphasis="language-note"> The function returns a tuple of (device, error_string). </inject-documentation> </modify-function> |