blob: d14c47cf46eec05465e381baf3a1d4fd1e77fbac (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
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.
|