Documentation doxygenfortran文档中的注释继承
我正在尝试使用Doxygen为fortran模型编写文档。某些变量在特定模块中定义,然后使用Documentation doxygenfortran文档中的注释继承,documentation,fortran,doxygen,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_subr
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_模块
使用my_second_模块文档的html页面中添加param
描述符注释,仅:param
和my_first_模块
的函数my_first_子例程
中param
的实际用法将自动创建到定义param
的源代码的链接
如果希望显式链接到变量
param
的文档,可以在my\u first\u子例程
的文档中添加类似于@的内容,请参见my\u second\u module::param
。这将创建到变量文档的实际链接。使用my_second_模块,仅:param
和函数my_first_子例程
中param
的的实际使用将自动创建到定义param
的源代码的链接
如果希望显式链接到变量param
的文档,可以在my\u first\u子例程
的文档中添加类似于@的内容,请参见my\u second\u module::param
。这将创建到变量文档的实际链接。它不会“自动创建到源代码的链接”,我不知道是否需要更改DOXY文件中的某些标志,但现在,除非我明确注释param
,否则它甚至不会显示在my_first_module
文档部分。奇怪的是调用图显示正确。可能需要定义一些标志!但是我不是doxygen的专家,所以我不能jelp muchIt不“自动创建到源代码的链接”,我不知道是否需要更改doxygen文件中的一些标志,但是现在,除非我明确注释param
,否则它甚至不会显示在my_first_模块
文档部分。奇怪的是调用图显示正确。可能需要定义一些标志!但我不是强氧剂专家,所以我不能做太多