path: root/doc
diff options
authorMarcelo Lira <marcelo.lira@openbossa.org>2011-02-04 17:12:41 -0300
committerHugo Parente Lima <hugo.pl@gmail.com>2012-03-09 19:10:14 -0300
commit7ee3543fd19e49fffaf6f3213cc553ebb3ee636e (patch)
tree35d067052f993ef4df4def43f8a3045617cf17a1 /doc
parent517993907bb165daafda75c9c5165985ea454794 (diff)
Global functions can now be renamed.
This is accomplished via the "rename" attribute on the "function" tag. An unit test was added and the documentation updated. Reviewed by Hugo Parente <hugo.lima@openbossa.org> Reviewed by Luciano Wolf <luciano.wolf@openbossa.org>
Diffstat (limited to 'doc')
1 files changed, 4 insertions, 2 deletions
diff --git a/doc/typesystem_specifying_types.rst b/doc/typesystem_specifying_types.rst
index 2d9ad3a9..e0d2d3c7 100644
--- a/doc/typesystem_specifying_types.rst
+++ b/doc/typesystem_specifying_types.rst
@@ -304,11 +304,13 @@ function
.. code-block:: xml
- <function signature="..." since="..."/>
+ <function signature="..." rename="..." since="..."/>
This tag has some limitations, it doesn't support function modifications, besides you
can't add a function overload using :ref:`add-function` tag to an existent function.
These limitation will be addressed in future versions of ApiExtractor.
- The *optional* **since** value is used to specify the API version of this function.
+ The function tag has two *optional* attributes: **since**, whose value is used to specify
+ the API version of this function, and **rename**, to modify the function name.