如何解决用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
解决方法
doxygen文档中的示例是使用以下配置设置生成的:
PROJECT_NAME = \"Python\"
OUTPUT_DIRECTORY = pyexample
GENERATE_LATEX = NO
GENERATE_MAN = NO
GENERATE_RTF = NO
OPTIMIZE_OUTPUT_JAVA = YES
INPUT = pyexample.py
QUIET = YES
JAVADOC_AUTOBRIEF = YES
SEARCHENGINE = NO
请参阅doxygen源码包的示例目录。
版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。