CODEWITHSUNDEEP
doxygendoxywizard
len
len

Reputation: 807

Doxygen documentation of Fortran77 code (no line breaks, parameters not documented)

I want to write a comment before a Fortran77 routine (main or another subroutine), where the Doxygen (version 1.9.0) comment lines should appear in the Doxygen HTML documentation as in the source code (here four lines, with line breaks). The documentation of the parameter TOTAL should also be displayed.

Can you reproduce that? What is the exact way to use Doxygen for this example?

Example (test.f):

!> header of doxygen documentation
!! first line of doxygen documentation
!! third line of doxygen documentation
!! @param AVRAGE information about the average
      PROGRAM CH0502
C> THIS PROGRAM READS IN THREE NUMBERS AND SUMS
C> AND AVERAGES THEM.
C
      IMPLICIT LOGICAL (A-Z)
      REAL NUMBR1,NUMBR2,NUMBR3,AVRAGE,TOTAL 
C
      INTEGER N
        N = 3
        TOTAL = 0.0
        PRINT *,'TYPE IN THREE NUMBERS'
        PRINT *,'SEPARATED BY SPACES OR COMMAS'
        READ *,NUMBR1,NUMBR2,NUMBR3
        TOTAL= NUMBR1+NUMBR2+NUMBR3 !> @param TOTAL is the total
        AVRAGE=TOTAL/N 
        PRINT *,'TOTAL OF NUMBERS IS', 
        PRINT *,'AVERAGE OF THE NUMBERS IS',AVRAGE
      END

doxygen -x Doxyfile gives as output:

# Difference with default Doxyfile 1.9.0 (71777ff3973331bd9453870593a762e184ba9f78)
PROJECT_NAME           = "Fortran project"
OUTPUT_DIRECTORY       = C:\Users\me\Desktop\doxygen_fortran_documentation
OPTIMIZE_FOR_FORTRAN   = YES
EXTRACT_ALL            = YES
INPUT                  = C:\Users\me\Desktop\doxygen_fortran
RECURSIVE              = YES
GENERATE_TREEVIEW      = YES
GENERATE_LATEX         = NO
CLASS_DIAGRAMS         = NO

The documentation result looks different as expected.

enter image description here

Upvotes: 0

Views: 119

Answers (1)

albert
albert

Reputation: 9012

As a comment cannot include images or layouted text I have to revert to an answer (well it partly is).

When I understand it correctly you would like to have something like:

enter image description here

  • is this correct?

This can be accomplished in a number of ways.

  • by means of adding \n at the end of each line
  • by means of adding <br> at the end of each line

So the source code will look like:

!> header of doxygen documentation\n
!! first line of doxygen documentation\n
!! third line of doxygen documentation\n
!! @param AVRAGE information about the average
      PROGRAM CH0502

Upvotes: 1

Related Questions