diff options
| author | Friedemann Kleint <Friedemann.Kleint@qt.io> | 2019-06-05 12:00:45 +0200 |
|---|---|---|
| committer | Friedemann Kleint <Friedemann.Kleint@qt.io> | 2019-06-05 17:08:00 +0200 |
| commit | 4a1d5f1d6cc6325c8e26512f408966821b41c480 (patch) | |
| tree | c5451d0d3786ff21f89dfa2b8c464d467d8f2533 /sources/shiboken2/doc | |
| parent | 1eb777f3846685b366207827a9c01a874cda91c8 (diff) | |
shiboken: Enable specifying names for a parameters of added functions
Introduce a way to specify a name for a parameter using '@'
delimiters.
Fixes: PYSIDE-1017
Change-Id: I3ae505c104a64413ca2bad628d9f9d3e04bb5b88
Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org>
Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
Diffstat (limited to 'sources/shiboken2/doc')
| -rw-r--r-- | sources/shiboken2/doc/typesystem_manipulating_objects.rst | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/sources/shiboken2/doc/typesystem_manipulating_objects.rst b/sources/shiboken2/doc/typesystem_manipulating_objects.rst index 12b866ad7..c04a4fa27 100644 --- a/sources/shiboken2/doc/typesystem_manipulating_objects.rst +++ b/sources/shiboken2/doc/typesystem_manipulating_objects.rst @@ -157,6 +157,13 @@ add-function The ``since`` attribute specify the API version when this function was added. + Within the signature, names for the function parameters can be specified by + enclosing them within the delimiter *@*: + + .. code-block:: c++ + + void foo(int @parameter1@,float) + .. _conversion-rule-on-types: conversion-rule |