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.

<value-type>
    <inject-documentation mode="append | prepend | replace" format="native | target"
                          file="[file]" snippet="[label]">
        // 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: After XML<->Backend transformation occur, so the injected code must be a valid backend format.

The optional file attribute specifies the file name (see Using Snippets From External Files).

The optional snippet attribute specifies the snippet label (see Using Snippets From External Files).

At the moment the only supported backend is Sphinx.

If the injected documentation contains a Sphinx function directive, no directive will be auto-generated. This can be used to add parameter documentation to added functions.

modify-documentation

The modify-documentation node allows you to change the auto-generated documentation. . This node is a child of the object-type, value-type and modify-function nodes. API Extractor transforms XML’s from qdoc (the Qt documentation tool) into .rst files to be processed later using Sphinx. You can modify the XML before the transformation takes place.

<modify-documentation xpath="...">
    <!-- new documentation -->
</modify-documentation>

The xpath attribute is the XPath to the node that you want to modify.