Doxygen fortran 文档中的注释继承

Question

我正在尝试使用 Doxygen 为 fortran 模型编写文档。一些变量在特定模块中定义，然后使用use 语句在许多其他不同的模块中使用。那就是我可能有第一个模块的f90

module my_first_module

contains

subroutine my_first_subroutine (foo, bar)

use my_second_module     , only : param


... DO STUFF ...

end subroutine my_first_subroutine
end module my_first_module

然后是带有第二个模块的第二个 f90

module my_second_module

real(kind=8), parameter :: param = 1.

end module my_second_module

我的问题是我可以生成一个 Doxy 文档，允许我在我定义它的地方注释变量 param，并且它由调用函数或子例程继承。

目标是在包含my_first_module 文档的html 页面中添加param 描述符注释。

Answer 1

my_first_module 模块的function my_first_subroutine 中的use my_second_module, only : param 和param 的实际使用会自动创建一个指向定义param 的源代码的链接。

如果您想要一个指向变量param 的文档的显式链接，您可以在my_first_subroutine 的文档中添加类似@see my_second_module::param 的内容。这将创建一个指向变量文档的实际链接。