Doxygen for Python:一个段落记录文件和包

时间:2015-08-14 19:10:49

标签: python c++ documentation doxygen

我有一个Python模块,它是一个包含多种语言(C ++,Matlab,Python等)的大型项目的一部分,所以我们使用Doxygen来记录它。我在顶部写了一个文档字符串,格式如下。

##
# \package mypackage
# \author me
# \brief A one-liner
# \details Lots and lots of lines of usage information
#

这会正确显示生成的文档的“类列表”和“包列表”中的所有内容。但是,当我点击文件列表中的mypackage.py时,我什么都没得到。我可以通过用\package替换上面的\file来显示它,但是类列表和包列表没有详细的文档。

有没有一种简单的方法可以让Doxygen在两个地方放置详细的文档?

此问题适用于C ++中的\file\class文档。

1 个答案:

答案 0 :(得分:0)

对于任何降落在这里的人,我已经确定以下是实施和维护这一点的最简单方法。

\