如何使doxygen忽略Python脚本的第一行?

时间:2013-04-11 15:27:23

标签: python doxygen

我在Python脚本的开头有一个文档字符串,Doxygen完全解析。但是,如果我在文件的开头添加#!/usr/bin/env python(使脚本可执行),Doxygen就无法识别整个文档字符串。

那么,我怎么能让Doxygen忽略这第一行?

工作文档字符串的示例:

"""@package HelloWorld
This is a docstring and it's recognized by doxygen."""

非工作文档字符串的示例:

#!/usr/bin/env python
"""@package HelloWorld
This is a docstring and it's not recognized by doxygen because of the first line."""

谢谢!

1 个答案:

答案 0 :(得分:1)

好的,我发现了:我需要先使用解析器。我试过doxypy并且效果很好。您只需在doxy_conf文件中进行以下更改:

FILTER_SOURCE_FILES = YES
INPUT_FILTER = "python path/to/doxypy.py"