使用doxygen记录Python包

Question

使用doxygen记录Python包

10

"Python中的特殊文档块"在http://www.doxygen.nl/manual/docblocks.html中提供了一个使用doxygen与Python的示例。

在由doxygen生成的相应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

- bitman

这些类和函数是否已经有 Doxygen 文档注释，还是只有整个包有文档注释？ - Codie CodeMonkey

所有内容都已记录，附加了来自Doxygen文档的示例。 - bitman

1个回答

网页内容由stack overflow 提供, 点击上面的

可以查看英文原文，
原文链接

- doxygen · Accepted Answer

在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源代码包的示例目录。