如何使用Doxygen生成Qt样式的文档(Trolltech的C Qt或Riverbank的PyQt docs)?我正在编写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文档吗?
解决方法:
那只用Doxygen吗? This will get you started:
This is a guide for automatically
generating documentation off of Python
source code using Doxygen.
显然,由于Python不是强类型化的,因此,文档编写者将自行决定指定返回类型和参数的预期类型.无论如何,这只是最佳做法.