操作文档

inject-documentation

inject-documentation节点将文档插入到生成的文档中。此节点是object-type、value-type和modify-function节点的子节点。

<value-type>
    <inject-documentation mode="append | prepend | replace" format="native | target"
                          file="[file]" snippet="[label]">
        // the documentation
    </inject-code>
</value-type>

mode属性的默认值为replace。

format属性指定文档注入何时发生，并接受以下值

• native：在XML<->Backend转换之前发生，因此注入的代码必须是有效的XML。

• target：在XML<->Backend转换之后发生，因此注入的代码必须是有效的后端格式。

可选的file属性指定文件名（参见从外部文件使用代码片段）。

可选的snippet属性指定代码片段标签（参见从外部文件使用代码片段）。

目前只支持Sphinx作为后端。

如果注入的文档包含Sphinx函数指令，则不会自动生成指令。这可以用来向添加的函数添加参数文档。

modify-documentation

modify-documentation节点允许您更改自动生成的文档。此节点是object-type、value-type和modify-function节点的子节点。API提取器将来自qdoc（Qt文档工具）的XML转换为.rst文件，以便以后使用Sphinx处理。您可以在转换之前修改XML。

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

xpath属性是您想修改的节点的XPath。