python - 使用 doxygen 记录 Python 包

Question

http://www.doxygen.nl/manual/docblocks.html 中的“Python 中的特殊文档 block ”给出了 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

Answer 1

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目录