Doxygen fortran文档中的注释继承

时间:2016-02-09 21:06:20

标签: documentation fortran doxygen

我正在尝试使用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进行注释,并由调用函数或子例程继承。

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

1 个答案:

答案 0 :(得分:0)

use my_second_module, only : param模块的paramfunction my_first_subroutinemy_first_module的实际使用情况将自动创建指向param的源代码的链接。

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