diff options
Diffstat (limited to 'doc/docblocks.doc')
| -rw-r--r-- | doc/docblocks.doc | 25 |
1 files changed, 17 insertions, 8 deletions
diff --git a/doc/docblocks.doc b/doc/docblocks.doc index 1b96361..6ef6bf0 100644 --- a/doc/docblocks.doc +++ b/doc/docblocks.doc @@ -2,7 +2,7 @@ * * * - * Copyright (C) 1997-2013 by Dimitri van Heesch. + * Copyright (C) 1997-2014 by Dimitri van Heesch. * * Permission to use, copy, modify, and distribute this software and its * documentation under the terms of the GNU General Public License is hereby @@ -460,11 +460,18 @@ settings where overruled. When using doxygen for Fortran code you should set \ref cfg_optimize_for_fortran "OPTIMIZE_FOR_FORTRAN" to \c YES. +The parser tries to guess if the source code is fixed format Fortran or +free format Fortran code. This may not always be correct. If not +one should use \ref cfg_extension_mapping "EXTENSION_MAPPING" to correct this. +By setting `EXTENSION_MAPPING = f=FortranFixed f90=FortranFree` files with +extension \c f90 are interpreted as fixed format Fortran code and files with +extension \c f are interpreted as free format Fortran code. + For Fortran "!>" or "!<" starts a comment and "!!" or "!>" can be used to -continuate a one line comment into a multi-line comment. +continue an one line comment into a multi-line comment. Here is an example of a documented Fortran subroutine: -\verbatim +\code{.f} !> Build the restriction matrix for the aggregation !! method. !! @param aggr information about the aggregates @@ -474,18 +481,20 @@ Here is an example of a documented Fortran subroutine: Type(SpMtx), intent(in) :: A !< our fine level matrix Type(Aggrs), intent(in) :: aggr Type(SpMtx), intent(out) :: Restrict !< Our restriction matrix -\endverbatim + !... + end subroutine +\endcode -As a alternative you can also use comments in fixed format code: +As an alternative you can also use comments in fixed format code: -\verbatim +\code{.f} C> Function comment C> another line of comment function A(i) C> input parameter integer i end function A -\endverbatim +\endcode \subsection tclblocks Comment blocks in Tcl @@ -541,7 +550,7 @@ commands without the leading namespace use p.e.: \verbatim TCL_SUBST = class itcl:class body itcl:body \endverbatim --> -Following is a example using doxygen style comments: +Following is an example using doxygen style comments: \include tclexample.tcl \htmlonly |