2016-02-09 196 views
1

我正在尝试使用Doxygen为Fortran模型编写文档。某些变量在特定模块中定义,然后在使用use语句的许多其他不同模块中使用。这就是我可能有一个F90与第一模块Doxygen fortran文档中的注释继承

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 

我的问题是,我可以产生一个强力霉素文档,让我评论的变量param我已经定义了它,并且由调用函数或子例程继承。

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

回答

0

use my_second_module, only : paramparammy_first_module模块的function my_first_subroutine实际使用将自动创建链接到定义param的源代码。

如果要显式链接到变量param的文档,可以在文档my_first_subroutine中添加诸如@see my_second_module::param之类的内容。这将创建一个到你的变量文档的实际链接。

+0

它不会“自动创建链接到源代码”,我不知道是否需要更改Doxyfile中的某些标志,但现在除非我明确注释'param',否则它甚至不会显示在'my_first_module '文件部分。而奇怪的是,调用图显示正确。 – Manfredo

+0

您可能需要定义一些标志!但我不是doxygen的专家,所以我不能很好地说 – innoSPG