【问题标题】:Documenting Python packages with doxygen使用 doxygen 记录 Python 包
【发布时间】:2011-09-14 11:55:20
【问题描述】:

http://www.doxygen.nl/manual/docblocks.html 中的“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

【问题讨论】:

  • 这些类和函数是记录在案的(使用 Doxygen)还是只有包记录在案?
  • 全部记录在案,添加了 doxygen 文档中的示例

标签: python package doxygen


【解决方案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 源码包的示例目录。

【讨论】:

  • 如果有人想要direct link
  • 几乎......我将模块文本复制到一个单独的文件中,然后如上所述设置配置设置。模块、类和类成员 cmets 都很好。模块级函数 func() 被忽略了。有没有办法让这个文档也包含在内?
  • ... 我认为设置 EXTRACT_ALL = YES 也可以获得模块级 func() 文档。
猜你喜欢
  • 2015-11-08
  • 2013-03-22
  • 2017-07-07
  • 1970-01-01
  • 2010-10-07
  • 2010-09-08
  • 2017-08-25
  • 2017-03-14
  • 2013-10-03
相关资源
最近更新 更多