使用doxygen记录Python包

2024-06-17 06:23:38 发布

您现在位置:Python中文网/ 问答频道 /正文

http://www.doxygen.nl/manual/docblocks.html中的“Python中的特殊文档块”给出了一个使用Python的doxygen的示例。

在doxygen(web中的示例输出)生成的相应HTML文档中,如果单击一个包名,则显示与该包相关的所有描述、类和函数。

如果我使用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


Tags: 函数文档selfconfig编辑示例fordef
1条回答
网友
1楼 · 发布于 2024-06-17 06:23:38

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源包的examples目录。

相关问题 更多 >