使用Doxygen的Qt风格文档？

Question

如何使用Doxygen生成Qt风格的文档（Trolltech的C ++ Qt或Riverbank的PyQt文档）？我正在记录Python，我希望能够改进它产生的默认函数简介。

特别是，我希望能够看到返回类型（可以是用户指定的）和函数简介中的参数。

例如：

 Functions:

     int getNumber(self)
     str getString(self)
     tuple getTuple(self, int numberOfElements=2)

 Function Documentation:

     int getNumber(self)

           gets the number of items within a list as specified...

           Definition at line 63 of ....

     etc...

如果在不修改源代码的情况下无法做到这一点，可能还有除Doxygen以外的其他工具以这种方式处理Python文档吗？

Answer 1

那么只需使用Doxygen？ This will get you started：

  

这是一个自动指南   从Python生成文档   源代码使用Doxygen。

显然，由于Python没有强类型，因此指定返回类型和参数的预期类型将由文档编写者决定。无论如何，这只是最好的做法。

Answer 2

如果您在Python方面做了相关的任何文档，我建议Sphinx。这就是python的开发人员用于他们的文档。

Answer 3

This page似乎详细介绍了创建qt风格文档的方法 基本上你有一个名为qhelpgenerator的qt工具可以创建一个.qch文件，由qt助手可以食用。
我以前没用过，但看起来很简单。

Answer 4

您不必在代码中添加doxygen注释。您可以将文档放在其他位置。查看doxygen手册中的this页面。