python - Python 的 Doxygen : one paragraph to document both file and package

Question

我有一个 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 文档。

Answer 1

对于来到这里的任何人，我已经确定以下是实现和维护它的最简单方法。

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

##
# \package mypackage
# \copydoc mypackage.py
#