diff options
Diffstat (limited to 'doc/typesystem_manipulating_objects.rst')
| -rw-r--r-- | doc/typesystem_manipulating_objects.rst | 15 |
1 files changed, 12 insertions, 3 deletions
diff --git a/doc/typesystem_manipulating_objects.rst b/doc/typesystem_manipulating_objects.rst index 84a5c1ad7..4c8121135 100644 --- a/doc/typesystem_manipulating_objects.rst +++ b/doc/typesystem_manipulating_objects.rst @@ -15,7 +15,7 @@ inject-code <value-type> <inject-code class="native | target | target-declaration" - position="beginning | end"> + position="beginning | end" since="..."> // the code </inject-code> </value-type> @@ -33,6 +33,8 @@ inject-code is inserted at the beginning of the function. If it is set to *end*, the code is inserted at the end of the function. + The ``since`` attribute specify the API version where this code was injected. + modify-field ^^^^^^^^^^^^ @@ -66,6 +68,7 @@ modify-function <object-type> <modify-function signature="..." + since="..." remove="all | c++" access="public | private | protected" rename="..." /> @@ -74,6 +77,8 @@ modify-function The ``signature`` attribute is a normalized C++ signature, excluding return values but including potential const declarations. + The ``since`` attribute specify the API version when this function was modified. + The ``remove``, ``access`` and ``rename`` attributes are *optional* attributes for added convenience; they serve the same purpose as the deprecated tags :ref:`remove`, :ref:`access` and :ref:`rename`. @@ -93,11 +98,13 @@ add-function .. code-block:: xml <object-type> - <add-function signature="..." return-type="..." access="public | protected" static="yes | no" /> + <add-function signature="..." return-type="..." access="public | protected" static="yes | no" since="..."/> </object-type> The ``return-type`` attribute defaults to *void*, the ``access`` to *public* and the ``static`` one to *no*. + The ``since`` attribute specify the API version when this function was added. + .. _conversion-rule-on-types: conversion-rule @@ -113,8 +120,10 @@ conversion-rule .. code-block:: xml <value-type name="Foo"> - <convertion-rule file="my_converter_implementation.h" /> + <convertion-rule file="my_converter_implementation.h" since="..."/> </value-type> + The ``since`` attribute specify the API version when this conversion rule became valid. + .. note:: You can also use the conversion-rule node to specify :ref:`how the conversion of a single function argument should be done in a function <conversion-rule>`. |