Difference between revisions of "Doxygen"

From LIBISIS
Jump to navigation Jump to search
 
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
Doxygen now supports FORTRAN 90 it uses !> and !< for special comments and !> or !! for special comment continuation. For example  
+
[http://www.doxygen.org/ Doxygen] now supports FORTRAN 90 using !> and !< for special comments and !> or !! for special comment continuation. For example  
 
<pre>
 
<pre>
 
   !> This is documentation of the  
 
   !> This is documentation of the  
 
   !! subroutine test.
 
   !! subroutine test.
   !! @param A first argument
+
   !! @param B doc for second argument
 
   !! @todo Handle special case
 
   !! @todo Handle special case
 
   subroutine test(A,B,C)
 
   subroutine test(A,B,C)
 
     implicit none
 
     implicit none
     Type(mytype), intent(in) :: A !< more doc     
+
     Type(mytype), intent(in) :: A !< doc for first arg    
 
     Type(other), intent(in) :: B
 
     Type(other), intent(in) :: B
     Type(another), intent(out) :: C !< yet more
+
     Type(another), intent(out) :: C !< doc for thrid arg
 
</pre>
 
</pre>
 +
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 ]

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