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" > // 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.
At the moment the only supported backend is Sphinx.
The modify-documentation node allows you to change the auto-generated documentation. 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.
© 2021 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.