diff options
| author | Hugo Parente Lima <hugo.pl@gmail.com> | 2011-07-05 19:22:51 -0300 |
|---|---|---|
| committer | Hugo Parente Lima <hugo.pl@gmail.com> | 2012-03-09 19:10:17 -0300 |
| commit | 9aabb6c3a5505da1e44be2dbec366f51fb2249ba (patch) | |
| tree | 4c0d5e45ed686f004068fdb9070580521d7f4db6 | |
| parent | 2cc6e2afa7b9845ccfc62b9dce72b498034e8de9 (diff) | |
Added docs for typesystem new attributes.
| -rw-r--r-- | doc/typesystem_specifying_types.rst | 32 |
1 files changed, 27 insertions, 5 deletions
diff --git a/doc/typesystem_specifying_types.rst b/doc/typesystem_specifying_types.rst index e0d2d3c76..cadddfe99 100644 --- a/doc/typesystem_specifying_types.rst +++ b/doc/typesystem_specifying_types.rst @@ -116,7 +116,9 @@ namespace-type <typesystem> <namespace-type name="..." generate="yes | no" - package="..." /> + package="..." + since="..." + revision="..." /> </typesystem> The **name** attribute is the name of the namespace, e.g., "Qt". @@ -128,6 +130,9 @@ namespace-type The *optional* **since** value is used to specify the API version of this type. + The **revision** attribute can be used to specify a revision for each type, easing the + production of ABI compatible bindings. + enum-type ^^^^^^^^^ @@ -142,10 +147,12 @@ enum-type identified-by-value="..." since="..." flags="yes | no" + flags-revision="..." lower-bound="..." upper-bound="..." force-integer="yes | no" - extensible="yes | no" /> + extensible="yes | no" + revision="..." /> </typesystem> The **name** attribute is the fully qualified C++ name of the enum @@ -167,6 +174,11 @@ enum-type Notice that the **enum-type** tag can either have **name** or **identified-by-value** but not both. + The **revision** attribute can be used to specify a revision for each type, easing the + production of ABI compatible bindings. + + The **flags-revision** attribute has the same purposes of **revision** attribute but + is used for the QFlag related to this enum. reject-enum-value @@ -199,7 +211,8 @@ value-type <value-type name="..." since="..." copyable="yes | no" hash-function="..." - stream="yes | no" /> + stream="yes | no" + revision="..." /> </typesystem> The **name** attribute is the fully qualified C++ class name, such as @@ -213,6 +226,8 @@ value-type The *optional* **since** value is used to specify the API version of this type. + The **revision** attribute can be used to specify a revision for each type, easing the + production of ABI compatible bindings. .. _object-type: @@ -230,7 +245,8 @@ object-type since="..." copyable="yes | no" hash-function="..." - stream="yes | no" /> + stream="yes | no" + revision="..." /> </typesystem> The **name** attribute is the fully qualified C++ class name. If there is no @@ -245,6 +261,8 @@ object-type The *optional* **since** value is used to specify the API version of this type. + The **revision** attribute can be used to specify a revision for each type, easing the + production of ABI compatible bindings. interface-type ^^^^^^^^^^^^^^ @@ -259,7 +277,8 @@ interface-type <interface-type name="..." since="..." package ="..." - default-superclass ="..." /> + default-superclass ="..." + revision="..." /> </typesystem> The **name** attribute is the fully qualified C++ class name. The *optional* @@ -270,6 +289,9 @@ interface-type The *optional* **since** value is used to specify the API version of this interface. + The **revision** attribute can be used to specify a revision for each type, easing the + production of ABI compatible bindings. + .. _container-type: container-type |