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 warnings from @param statements starting with formulas (Origin: bugzilla #622018) #3812

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

Comments

Projects
None yet
1 participant
@doxygen
Owner

doxygen commented Jul 2, 2018

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

Original attachment names and IDs:

On 2010-06-18 16:41:43 +0000, Rhys Ulerich wrote:

Created attachment 164023
Source, Doxyfile, and doxygen output showing problem

I'm seeing odd warnings like

/g/g10/ulerich1/tmp/foo.F90:1: Warning: argument 'form' of command @param is not found in the argument list of (null)problem_bc(REAL(KIND=dp), dimension(neqn,-padsize:n+padsize), intent(out) u, REAL(KIND=dp), dimension(0:n), intent(in) x, REAL(KIND=dp), intent(in) t, INTEGER, intent(in) n, INTEGER, intent(in) padsize)(null)

/g/g10/ulerich1/tmp/foo.F90:1: Warning: argument '2' of command @param is not found in the argument list of (null)problem_bc(REAL(KIND=dp), dimension(neqn,-padsize:n+padsize), intent(out) u, REAL(KIND=dp), dimension(0:n), intent(in) x, REAL(KIND=dp), intent(in) t, INTEGER, intent(in) n, INTEGER, intent(in) padsize)(null)

from what I understand to be well-formed input

!> Enforce the problem's boundary conditions on a padded domain.
!! Given valid data \f$ \vec{u}\left(x_i, t\right) \f$ for
!! \f$ i\in\left{0,\ldots,n\right} \f$, modify storage locations
!! u(-padsize:0) and u(n,n+padsize) so that
!! the problem's boundary conditions are enforced.
!!
!! @param u \f$u\f$
!! @param x \f$x\f$
!! @param t \f$t\f$
!! @param n Grid size. Note that array size differs from \c n.
!! @param padsize Amount of padding added to the domain 0:n.
SUBROUTINE problem_bc(u, x, t, n, padsize)

INTEGER, PARAMETER :: neqn = 3
INTEGER, PARAMETER :: dp = KIND(1.d0)

INTEGER, INTENT(IN) :: n, padsize
REAL(KIND = dp), INTENT(IN) :: x(0:n), t
REAL(KIND = dp), INTENT(OUT) :: u(neqn,-padsize:n+padsize)

u(:, -padsize:0) = SIN(2pit) ! Sinusoidal left boundary
u(:, n+1:n+padsize) = -u(:, n-padsize:n-1) ! Reflective right boundary

END SUBROUTINE problem_bc

The problem may be that the parameter descriptions begin with formulas instead of other text. Commentless Doxyfile, input source, and sample output attached in a tarball.

On 2010-06-22 19:58:36 +0000, Dimitri van Heesch wrote:

Confirmed. Should be fixed in the next subversion update.

On 2010-06-25 11:49:02 +0000, Dimitri van Heesch wrote:

This bug was previously marked ASSIGNED, which means it should be fixed in
doxygen version 1.7.1. 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 2010-10-09 08:19:18 +0000, Dimitri van Heesch wrote:

This bug was previously marked ASSIGNED, which means it should be fixed in
doxygen version 1.7.2. 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.

@doxygen doxygen closed this Jul 2, 2018

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