2016-02-09 106 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