summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorDimitri van Heesch <dimitri@stack.nl>2014-03-15 15:14:58 (GMT)
committerDimitri van Heesch <dimitri@stack.nl>2014-03-15 15:14:58 (GMT)
commitc1e25238950492e7f8a5c996e3d3ad41b9b023b0 (patch)
tree62d8b6469643fd0d4fc30950e85b3990bf51eda1 /doc
parent31a72d0ad15a4185dc123b522039ef3fa8a68b43 (diff)
parent2dec1060623165057628ee678eb3580351922408 (diff)
downloadDoxygen-c1e25238950492e7f8a5c996e3d3ad41b9b023b0.zip
Doxygen-c1e25238950492e7f8a5c996e3d3ad41b9b023b0.tar.gz
Doxygen-c1e25238950492e7f8a5c996e3d3ad41b9b023b0.tar.bz2
Merge branch 'feature/bug_625601' of https://github.com/albert-github/doxygen into albert-github-feature/bug_625601
Diffstat (limited to 'doc')
-rw-r--r--doc/docblocks.doc17
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