python - __init__.py 文件上的 doxygen 窒息

Question

我正在尝试用 Doxygen 记录一个 python 模块 - 然而似乎 __init__.py 文件的存在导致了问题

目前 __init__.py 文件是空的(我试过在里面添加注释，比如

## Nothing here

但没有成功)。模块 namespace 未在 Doxygen 端解析 - 如果以下是我的文件:

## @package stuff
#  @author me
#  Description
#
#  Some more description

## A class that does whatever
class whatever:
    ## A method that does stuff
    def dostuff(self):
        pass

它只会获取“描述”和“更多描述”字符串。即使文件中的任何类不包含 __init__ 方法(认为可能存在命名冲突)，doxygen 也不会获取模块中的任何内容。

我尝试在 Doxyfile 中使用各种“EXCLUDE”指令，但没有任何效果。

有没有人遇到过这个问题？删除 __init__.py 文件后，一切正常 - 然而，这远不是最佳解决方案。

Answer 1

我遇到了完全相同的问题，我发现问题出在包的命名上。给定的名称需要完全限定。否则，您正在为一个新包创建文档，在本例中名称为 stuff，但是您的类将位于一个未记录的包中，除非您将 EXTRACT_ALL 设置为 yes，否则它将被隐藏。

因此假设您的文件名为 stuff.py 并且位于名为 mypackage 的目录中以及 __init__.py 然后 stuff .py 应该看起来像这样:

## @package mypackage.stuff
#  Description
#
#  Some more description
#  @author me

## A class that does whatever
class whatever:
    ## A method that does stuff
    def dostuff(self):
        pass

## A function that does whatever
def whatever:
    pass