diff options
author | albert-github <albert.tests@gmail.com> | 2014-03-09 17:57:12 (GMT) |
---|---|---|
committer | albert-github <albert.tests@gmail.com> | 2014-03-09 17:57:12 (GMT) |
commit | 2dec1060623165057628ee678eb3580351922408 (patch) | |
tree | 24f78a22f5220010d75f86a6f6702996b7d1fb0a /doc/docblocks.doc | |
parent | 8eeaae0b06fd320745f22efe176e0f19d6c8e2a6 (diff) | |
download | Doxygen-2dec1060623165057628ee678eb3580351922408.zip Doxygen-2dec1060623165057628ee678eb3580351922408.tar.gz Doxygen-2dec1060623165057628ee678eb3580351922408.tar.bz2 |
Bug 625601 - FORTRAN: recognition free versus fixed formatted code
The recognition of the type (free or fixed) of Fortran code is not reliable possible. A well known possibility as used with compilers as well is to specify the type of code by means of the extension.
With EXTENSION_MAPPING it is possible to select the type of Fortran code, when not explicitly set doxygen tries to guess the type of Fortran code.
Diffstat (limited to 'doc/docblocks.doc')
-rw-r--r-- | doc/docblocks.doc | 17 |
1 files changed, 13 insertions, 4 deletions
diff --git a/doc/docblocks.doc b/doc/docblocks.doc index 6a96588..2cfff9a 100644 --- a/doc/docblocks.doc +++ b/doc/docblocks.doc @@ -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 wheter the source code is fixed format Fortran or +free format Fortran code. This is not always correct, in the later case +one should use \ref cfg_extension_mapping "EXTENSION_MAPPING" to correct this. +By setteing `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 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 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 |