summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorHugo Parente Lima <hugo.lima@openbossa.org>2010-04-22 16:15:18 -0300
committerHugo Parente Lima <hugo.pl@gmail.com>2012-03-09 19:10:00 -0300
commit20e999b731191a1e427ab7e1183f2b37790678c7 (patch)
tree455b7a77ad3ba6cd18de48c8c60941b37eb17603 /doc
parent38367298e39ee0710a86fda4aae294fb88981356 (diff)
Added documentation for function tag.
Diffstat (limited to 'doc')
-rw-r--r--doc/typesystem_specifying_types.rst19
1 files changed, 17 insertions, 2 deletions
diff --git a/doc/typesystem_specifying_types.rst b/doc/typesystem_specifying_types.rst
index 21392c68..cd65c4b5 100644
--- a/doc/typesystem_specifying_types.rst
+++ b/doc/typesystem_specifying_types.rst
@@ -60,8 +60,7 @@ rejection
*optional* **function-name** or **field-name** attributes to reject a particular
function or field. Note that the **field-name** and **function-name** cannot
be specified at the same time. To remove all occurrences of a given field or
- function, set the class attribute to \*. You can use an empty class field
- to denote a global function.
+ function, set the class attribute to \*.
.. _primitive-type:
@@ -254,4 +253,20 @@ container-type
container. It can be: *list*, *string-list*, *linked-list*, *vector*, *stack*,
*queue*, *set*, *map*, *multi-map*, *hash*, *multi-hash* or *pair*.
+.. _function:
+function
+^^^^^^^^
+
+ The function node indicates that the given C++ global function is mapped onto
+ the target language.
+
+ .. code-block:: xml
+
+ <typesystem>
+ <function signature="..." />
+ </typesystem>
+
+ 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.