Doxygen - 使用@package的Python模块定义跳过一些文档

时间:2014-06-27 13:41:29

标签: python doxygen

我正在使用Doxygen记录Python模块,并使用@package命令将每组功能组合在一起并记录目录结构。不幸的是,有时候@package并不总能正确地做到这一点。

例如,我在2个不同的目录中有2组不同的模块:

  1. main/foo/ModuleA.py
  2. main/bar/src/ModuleB.py
  3. 出于某种原因,当我将ModuleA.py标记为“@package foo.ModuleA”时,ModuleA的文档100%完整无缺。

    但是当我将ModuleB.py标记为@package bar.src.ModuleB时,文档仅包含ModuleB的基本描述,并跳过文件中的所有其他功能文档。如果我删除“完整包名称”并只使用@package ModuleB,则包含所有文档。但是如果我添加任何额外的命名空间,我只得到基本描述。

    任何人都可以解释为什么会发生这种情况吗?我不清楚Doxygen如何决定使用@package分组哪些文档以及要跳过哪些文档。

0 个答案:

没有答案