Question

<{3}}中的“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

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

使用doxygen记录Python包

1 个答案: