用doxygen记录Python软件包
|
http://www.doxygen.nl/manual/docblocks.html中的“ Python中的特殊文档块”给出了Python使用doxygen的示例。
在doxygen生成的相应HTML文档中(Web中的示例输出),如果单击某个包名称,则会显示与该包相关的所有描述,类和函数。
如果我从doxygen文档中获取相同的示例脚本,则使用\“ doxygen -g config \”创建配置文件,并使用\“ doxygen config \”生成html,那么输出将有所不同。如果单击程序包名称,则仅显示程序包描述,而不显示类和函数。
为了在包文档中包含类和函数,我需要在配置文件或某些xml方案中进行哪些更改。
编辑1:上面网页中的示例:
## @package pyexample
# Documentation for this module.
#
# More details.
## Documentation for a function.
#
# More details.
def func():
pass
## Documentation for a class.
#
# More details.
class PyClass:
## The constructor.
def __init__(self):
self._memVar = 0;
## Documentation for a method.
# @param self The object pointer.
def PyMethod(self):
pass
## A class variable.
classVar = 0;
## @var _memVar
# a member variable
编辑2:
使用Win XP和doxygen-1.7.4-setup.exe
没有找到相关结果
已邀请:
1 个回复
荒劫娇噬
请参阅doxygen源码包的示例目录。