diff options
author | Hugo Lima <hugo.lima@openbossa.org> | 2009-10-17 13:41:44 -0300 |
---|---|---|
committer | Hugo Lima <hugo.lima@openbossa.org> | 2009-10-17 13:41:44 -0300 |
commit | 51168e70b530c6920411680d5e6dde7aeaba164c (patch) | |
tree | 96d90b12ee2115030d7d86724e703ad612b595e3 /doc/typesystem_modify_function.rst | |
parent | 705b3f37e76b59d020d24b76600a8b21d319326d (diff) |
- Typesystem documentation broken in smaller parts, so it's more redable now (IMO).
- Added cross referencing for nodes cited along the documentation.
- Added documentation for the new and not implemented yet, add-function tag.
Diffstat (limited to 'doc/typesystem_modify_function.rst')
-rw-r--r-- | doc/typesystem_modify_function.rst | 78 |
1 files changed, 78 insertions, 0 deletions
diff --git a/doc/typesystem_modify_function.rst b/doc/typesystem_modify_function.rst new file mode 100644 index 000000000..071cea4f5 --- /dev/null +++ b/doc/typesystem_modify_function.rst @@ -0,0 +1,78 @@ +.. _modifying-functions: + +Modifying Functions +------------------- + +.. _modify-argument: + +modify-argument +^^^^^^^^^^^^^^^ + + The modify-argument node specifies which of the given function's arguments the + modification affects, and is a child of the modify-function node. Use the + remove-argument, replace-default-expression, remove-default-expression, + replace-type, reference-count and define-ownership nodes to specify the details + of the modification. + + .. code-block:: xml + + <modify-function> + <modify-argument index="return | this | 1 ..." > + // modifications + </modify-argument> + </modify-function> + + Set the ``index`` attribute to "1" for the first argument, "2" for the second + one and so on. Alternatively, set it to "return" or "this" if you want to + modify the function's return value or the object the function is called upon, + respectively. + +.. _remove: + +remove +^^^^^^ + + The remove node removes the given method from the generated target language + API, and it is a child of the modify-function node. + + .. code-block:: xml + + <modify-function> + <remove class="all" /> + </modify-function> + + .. warning:: This tag is deprecated, use the ``remove`` attribute from :ref:`modify-function` tag instead. + +.. _access: + +access +^^^^^^ + + The access node changes the access privileges of the given function in the + generated target language API, and it is a child of the modify-function node. + + .. code-block:: xml + + <modify-function> + <access modifier="public | protected | private"/> + </modify-function> + + .. warning:: This tag is deprecated, use the ``access`` attribute from :ref:`modify-function` tag instead. + +.. _rename: + +rename +^^^^^^ + + The rename node changes the name of the given function in the generated target + language API, and it is a child of the modify-function node. + + .. code-block:: xml + + <modify-function> + <rename to="..." /> + </modify-function> + + The ``to`` attribute is the new name of the function. + + .. warning:: This tag is deprecated, use the ``rename`` attribute from :ref:`modify-function` tag instead. |