用doxygen文档记录Python包

10 投票
1 回答
16307 浏览
提问于 2025-04-16 19:31

http://www.doxygen.nl/manual/docblocks.html 这个网站上,有一段关于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。

1 个回答

8

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

撰写回答