使用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：

这是用于自动生成 文档导向关的使用的Doxygen的Python 源代码。

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

Answer 2

如果你在做关于Python的任何相关文档，我推荐Sphinx。这是Python的开发人员用于他们的文档。

Answer 3

This page似乎详细介绍了创建qt样式文档的方法。
基本上有一个工具，你可以用qt调用qhelpgenerator创建一个.qch文件，可以由qt助手使用。
我以前没有用过它，但看起来相当简单。

Answer 4

您不必在代码中放置doxygen注释。你可以把文档放在其他地方。在doxygen手册中查看this页面。