- 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.

1 files changed, 43 insertions, 0 deletions

diff --git a/doc/typesystem_documentation.rst b/doc/typesystem_documentation.rst
new file mode 100644
index 000000000..d14c47cf4
--- /dev/null
+++ b/doc/typesystem_documentation.rst
@@ -0,0 +1,43 @@
+Manipulating Documentation
+--------------------------
+
+inject-documentation
+^^^^^^^^^^^^^^^^^^^^
+
+    The inject-documentation node inserts the documentation into the generated
+    documentation. This node is a child of the object-type, value-type and
+    modify-function nodes.
+
+    .. code-block:: xml
+
+         <value-type>
+             <inject-documentation mode="append | prepend | replace" format="native | target" >
+                 // the documentation
+             </inject-code>
+         </value-type>
+
+    The **mode** attribute default value is *replace*.
+
+    The **format** attribute specifies when the documentation injection will
+    occur and it accepts the following values:
+
+        * native: Before XML<->Backend transformation occur, so the injected code *must* be a valid XML.
+        * target: Before XML<->Backend transformation occur, so the injected code *must* be a valid backend format.
+
+    At the moment the only supported backend is Sphinx.
+
+modify-documentation
+^^^^^^^^^^^^^^^^^^^^
+
+    The modify-documentation node allows you to change the auto-generated
+    documentation. API Extractor transforms XML's from qdoc3 (the Qt documentation
+    tool) into .rst files to be processed later using Sphinx. So you can modify
+    the XML before the transformation occur.
+
+    .. code-block:: xml
+
+        <modify-documentation xpath="...">
+            <!-- new documentation -->
+        </modify-documentation>
+
+    The **xpath** attribute is the XPath to the node that you want to modify.