Using Doxygen on Fortran code


 
Thread Tools Search this Thread
Top Forums Programming Using Doxygen on Fortran code
# 1  
Old 07-13-2012
Using Doxygen on Fortran code

I am using doxygen for documenting my fortran code.

I want to write some notes after the header in different parts of the subroutine. Any idea what the tags should be as anything I write after the header is not displayed

Code:
  !-------------------------------------------------------------------------------------------------
  ! DESCRIPTION:
  !> Computes either a forward or inverse Radon transform in the frequency domain. For the
  !> forward Radon transform we solve the linear system of equations \f$ L.m = d \f$ by computing
  !> \f$ (L^{H}.L).m = L^{H}.d \f$ and minimizing \f$ (L^{H}.L).m - L^{H}.d \f$ for \f$ m \f$.
  !> The conjugate gradient algorithm is used to solve for \f$ m \f$ and since the matrix
  !> \f$ L^{H}.L \f$ turns out to be hermitian, fast computational methods for structured matrices
  !> can be used.
  !>
  !> @brief
  !> The forward Radon transform is computed using the conjugate gradient algorithm applied to
  !> a hermitian matrix.
  !>
  !> @param[in] l_forward  validates computation of a forward Radon transform
  !-------------------------------------------------------------------------------------------------

  subroutine rt2dsfpcg_main( l_forward )
  implicit none
  include 'radontest.cbk'

! ARGUMENTS

  logical, intent(in) :: l_forward

! LOCAL VARIABLES

  real,    dimension(:), allocatable :: x  ! receiver offsets
  real,    dimension(:), allocatable :: p  ! Radon parameters

Login or Register to Ask a Question

Previous Thread | Next Thread

6 More Discussions You Might Find Interesting

1. UNIX for Dummies Questions & Answers

Doxygen \cond not working

Am writing some documentation of some software in a .dox file and wand to include some comments that will not show in the webpage. I am using \cond but I am not getting any output after calling \endcond. /// \section cuboids_sec Cuboids /// /// \cond /// /// \endcond /// /// -... (0 Replies)
Discussion started by: kristinu
0 Replies

2. Programming

Strange characters in FORTRAN code output

Hi guys, After compiling a .f90 code and executing it, i get strange characters in the output file like : ^@^@^@^@^@^@^@^@^@^@^@^@^@^@^@^@^@^@^@^@^@^@^@^@^@^@^@^@^@^@ Are these windows characters? how can i get rid of this? Much appreciated. Paul (1 Reply)
Discussion started by: Paul Moghadam
1 Replies

3. Programming

Removing goto statements in FORTRAN code

I have the code below and I want to remove the "go to" statements. Any idea how I can do it? if (iorder == 0) then tmincurrent = 1.0e11 if(ireverse == 0 .or. istop /= 1) then do i = 1, 6 if ((side(i) /= sidelimit(i)) .and. (tminside(i) < tmincurrent)) then ... (1 Reply)
Discussion started by: kristinu
1 Replies

4. Programming

Help with make this Fortran code more efficient (in HPC manner)

Hi there, I had run into some fortran code to modify. Obviously, it was written without thinking of high performance computing and not parallelized... Now I would like to make the code "on track" and parallel. After a whole afternoon thinking, I still cannot find where to start. Can any one... (3 Replies)
Discussion started by: P_E_M_Lee
3 Replies

5. Programming

Error running FORTRAN code

Hi, I am new to this forum and do not know whether this is the appropriate place to post this question. Anyway am trying my luck. I have a fortran program swanhcat.ftn, which is part of a wave modelling system. There is also a file hcat.nml which is required to run this program. The program's... (9 Replies)
Discussion started by: sandhyakg
9 Replies

6. Programming

Making FORTRAN code more efficient

Hi, I have a very large, very old FORTRAN code that I work with. The code is quite messy and I was wondering if I can speed up execution time by finding subroutines that code execution spends the most time in. Is there any kind of software I can use to see where the code spends most of the... (1 Reply)
Discussion started by: rks171
1 Replies
Login or Register to Ask a Question