我有一个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
来显示在此处,但是随后的Class List和Package List没有详细的文档。有没有一种简便的方法可以让Doxygen在两个地方都放置详细的文档?
这个问题也适用于C++中的
\file
和\class
文档。 最佳答案
对于任何登陆这里的人,我都将以下内容视为实现和维护此问题的最简单方法。
##
# \file
# \author me
# \brief A one-liner
# \details Lots and lots of lines of usage information
#
##
# \package mypackage
# \copydoc mypackage.py
#