Fortran: Anhang D: Doxygen

<<< zur Fortran-Startseite
<< Anhang D: Quellcodedokumentation	Weblinks >>
< Natural Docs	Doxygen >

Ein einfaches Beispiel

Fortran 90/95-Code (free source form)

!> \file testprogramm.f90
!! \brief Datei fuer geometrische Berechnungen

!> Modul: circle
!> \author Intruder
!> \date 28.10.2007

module circle
  implicit none


  real, parameter :: pi = 3.14  !< PI


  contains
    !> Berechnet Kreisflaeche
    !> \param r ... Radius
    !> \return Kreisflaeche
    real function area( r )
      implicit none 

      real, intent( in ) :: r
    
      area = r ** 2 * pi
    end function area
end module circle


!> Hauptprogramm
program main
  use circle
  implicit none
  
  real            :: r, a
  
  read( *, * ) r
  a = area( r )
  write( *, * ) "Flaeche = ", a
end program main

Erstellen einer Konfigurationsdatei:

doxygen -g Doxyfile

Anschließend sollte man die Doxyfile bearbeiten und nach seinen eigenen Wünschen anpassen (Projektname, Outputordner etc.). Wichtig ist, dass das Flag OPTIMIZE_FOR_FORTRAN auf YES gesetzt wird.

Erstellen der Dokumentation (standardmäßig im HTML- und LaTeX-Format, optional auch XML, RTF und man-pages):

doxygen Doxyfile

Screenshot (HTML-Variante):

Weblinks

doxygen-Homepage

<<< zur Fortran-Startseite
<< Anhang D: Quellcodedokumentation	Weblinks >>
< Natural Docs	Doxygen >