使用Doxygen生成python脚本的文档

时间:2016-07-18 19:24:59

标签: python doxygen

我正在尝试为我的项目中包含的一些Python脚本创建一些文档(其余的是Fortran / C)。我设法包含文件的简要说明和详细描述,但是脚本中定义的所有变量都列在文档中。

如何避免列出它们? Doxyfile中的哪个变量控制包含文件的所有变量?

1 个答案:

答案 0 :(得分:2)

使用python-Doxygen时遇到了类似的问题。对我有用的是将变量括在\ cond和\ endcond之间。

例如,

## \cond
some_var = "abc"
## \endcond

它们不会出现在您的文档中:))