Release-1.7.1

1 files changed, 32 insertions, 0 deletions

diff --git a/doc/docblocks.doc b/doc/docblocks.doc
index ebbe879..aa9e873 100644
--- a/doc/docblocks.doc
+++ b/doc/docblocks.doc
@@ -448,4 +448,36 @@ config file. This will also affect a number of other settings. When they
 were not already set correctly doxygen will produce a warning telling which
 settings where overruled.
 
+\section fortranblocks Special documentation blocks in Fortran
+
+When using doxygen for Fortran code you should
+set \ref cfg_optimize_for_fortran "OPTIMIZE_FOR_FORTRAN" to \c YES.
+
+For fortran "!>" or "!<" starts a comment and "!!" or "!>" can be used to 
+continuate a one line comment into a multi-line comment.
+
+Here is an example of a documented Fortran subroutine:
+\verbatim
+  !> Build the restriction matrix for the aggregation 
+  !! method.
+  !! @param aggr information about the aggregates
+  !! @todo Handle special case
+  subroutine IntRestBuild(A,aggr,Restrict,A_ghost)
+    implicit none
+    Type(SpMtx), intent(in) :: A !< our fine level matrix
+    Type(Aggrs), intent(in) :: aggr
+    Type(SpMtx), intent(out) :: Restrict !< Our restriction matrix
+\endverbatim
+
+As a alternative you can also use comments in fixed format code:
+
+\verbatim
+C> Function comment
+C> another line of comment
+      function A(i)
+C> input parameter
+        integer i
+      end function A
+\endverbatim
+
 */