New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fortran using @param when describing argument at the argument (Origin: bugzilla #653963) #4327

Closed
doxygen opened this Issue Jul 2, 2018 · 0 comments

Comments

Projects
None yet
1 participant
@doxygen
Owner

doxygen commented Jul 2, 2018

status VERIFIED severity normal in component general for ---
Reported in version unspecified on platform Other
Assigned to: Dimitri van Heesch

Original attachment names and IDs:

On 2011-07-04 19:01:19 +0000, albert wrote:

Created attachment 191244
Problem with argument description

In case we use @param to describe an argument at the place the argument is declared we get an empty line plus a line where the parameter is described.

There are 2 styles of documenting arguments:
before the routine (argument p1)
at the argument (other arguments)
if we mix these 2 possibilities we get to lists with parameters

see attached example

On 2011-07-17 13:30:41 +0000, albert wrote:

Created attachment 192128
patch for jhandling different types of param definition documentation in Fortran

In this patch I've made the documentation for argument more uniform.
At the following places argument documentation can occur:

  • before the subroutine (!> @param ...)
  • just before the declaration of the variable (!> ...)
  • as inline comment with the variable (!< ...)

The documentation of the last 2 occurrences can now be like it always has been:
!> description
or
!< description
but now this description will be prepended by @param [intent] variable-name
the [intent] will only be done in case it is specified with the declaration of the variable. In case there is already a @param or \param the description is left unchanged.
The description before the subroutine is also left unchanged.

On 2011-08-01 11:13:08 +0000, Dimitri van Heesch wrote:

Confirmed. Should be fixed in the next subversion update.

On 2011-08-14 14:04:59 +0000, Dimitri van Heesch wrote:

This bug was previously marked ASSIGNED, which means it should be fixed in
doxygen version 1.7.5. Please verify if this is indeed the case. Reopen the
bug if you think it is not fixed and please include any additional information
that you think can be relevant.

On 2011-10-30 19:20:12 +0000, albert wrote:

Parameter documentation is now uniform (and together)

@doxygen doxygen closed this Jul 19, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment