Doxygen recognize parameters with linebreak

604 Views Asked by At

I'm trying to document my Fortran 77+90 extensions files. 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. It just says:

subroutine example ( )

Of course I can add the parameters using @param, but they don’t show up in the initial description.

Is there a hidden option/command in doxygen to get my desired output? 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. 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

1

There are 1 best solutions below

3
On

To elaborate on albert's comment, you can document your subroutine for example like this:

  !> 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.