使用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文档吗？

- Dan

Answer 1

那么只需要使用Doxygen吗？这将为您提供入门指南：

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

显然，由于Python没有强类型，因此指定返回类型和参数的预期类型将由您作为文档编写者来完成。这只是最佳实践。

- Shane C. Mason

---

如果可能的话，请替换死链 - Peter

Answer 2

如果你在Python文档方面有任何需求，我推荐使用Sphinx。这是Python开发者用于文档编写的工具。

- bruxisma

---

同意。这很好，但Python并不是我们唯一使用的语言，我们希望在文档中保持一致性。 - Dan

Answer 3

这个页面似乎详细介绍了创建Qt风格文档的方法。
基本上，你可以使用Qt自带的qhelpgenerator工具创建一个.qch文件，然后在Qt助手中打开。
我以前没有用过它，但看起来相当简单。

- shoosh

Answer 4

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

- Dusty Campbell