Difference between revisions of "Doxygen"

From LIBISIS
Jump to navigation Jump to search
 
Line 11: Line 11:
 
     Type(another), intent(out) :: C !< doc for thrid arg
 
     Type(another), intent(out) :: C !< doc for thrid arg
 
</pre>
 
</pre>
Examples of projects documented using this system are [http://www.dougdevel.org/doug/docs/ DOUG] and
+
The current LIBISIS doxygen documentation is at [http://download.libisis.org/doxygen/html/ http://download.libisis.org/doxygen/html/]
 +
 
 +
Examples of other projects documented using this system are [http://www.dougdevel.org/doug/docs/ DOUG] and
 
[http://titus.phy.qub.ac.uk/Programs/TDTB_UJ/ TDTB+UJ ]
 
[http://titus.phy.qub.ac.uk/Programs/TDTB_UJ/ TDTB+UJ ]

Latest revision as of 09:18, 27 March 2008

Doxygen now supports FORTRAN 90 using !> and !< for special comments and !> or !! for special comment continuation. For example

  !> This is documentation of the 
  !! subroutine test.
  !! @param B doc for second argument
  !! @todo Handle special case
  subroutine test(A,B,C)
    implicit none
    Type(mytype), intent(in) :: A !< doc for first arg    
    Type(other), intent(in) :: B
    Type(another), intent(out) :: C !< doc for thrid arg

The current LIBISIS doxygen documentation is at http://download.libisis.org/doxygen/html/

Examples of other projects documented using this system are DOUG and TDTB+UJ