[英]Doxygen recognize parameters with linebreak
I'm trying to document my Fortran 77+90 extensions files.我正在尝试记录我的 Fortran 77+90 扩展文件。 In general, everything works fine, except for one thing.
一般来说,一切正常,除了一件事。 Some of my subroutines have a little longer parameter list.
我的一些子程序有更长的参数列表。 Because of that, they are written with linebreak to add inline comments, as you can see below:
因此,它们用换行符编写以添加内联注释,如下所示:
subroutine example (
& a, ! fist parameter
& b, ! second parameter
& c, ! third parameter
& ...
& z) ! 26th parameter
<doing some stuff here...>
end
However, when I run doxygen, it doesn't recognize these parameter, which results in an empty parameter list inside my html document.但是,当我运行 doxygen 时,它无法识别这些参数,从而导致我的 html 文档中的参数列表为空。 It just says:
它只是说:
subroutine example ( )
子程序示例 ( )
Of course I can add the parameters using @param, but they don't show up in the initial description.当然我可以使用@param 添加参数,但它们不会出现在初始描述中。
Is there a hidden option/command in doxygen to get my desired output? doxygen 中是否有隐藏的选项/命令来获得我想要的输出? I want something like this in my documentation:
我想在我的文档中有这样的东西:
subroutine example ( integer a
double precision b
....
integer z )
This can be created when i put all my parameters inline like this:当我像这样将所有参数内联时,可以创建它:
subroutine example (a,b,c,...,z)
<doing some stuff here...>
end
Unfortunately, the requested fixed format of Fortran doesn't let me use this.不幸的是,请求的 Fortran 固定格式不允许我使用它。 Can someone help me with that?
有人可以帮我吗?
EDIT: This is what happens with linebreaks in the subroutine parameterlist!编辑:这就是子程序参数列表中的换行符发生的情况! http://www.pic-upload.de/view-28502940/pic.png.html
http://www.pic-upload.de/view-28502940/pic.png.html
To elaborate on albert's comment, you can document your subroutine for example like this:要详细说明 albert 的评论,您可以记录您的子程序,例如:
!> Get a globally defined function.
subroutine aot_fun_global(L, fun, key)
type(flu_state) :: L !< Handle for the Lua script.
!> Returned handle, providing access to the function.
type(aot_fun_type), intent(out) :: fun
!> Name of the function to look up in the global scope of the Lua script.
character(len=*), intent(in) :: key
And the doxygen html for it.以及它的doxygen html 。
声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.