Commit 5c1ff4fb authored by Lorenz Huedepohl's avatar Lorenz Huedepohl
Browse files

A bit more text in the main doc page

parent af3b1740
......@@ -21,10 +21,42 @@
!> \mainpage Ftimings
!>
!> An almost pure-fortran attempt to play with tree structures, which evolved
!> into the timing library used e.g. by the VERTEX supernova code.
!> ftimings, a simple Fortran library for time measurement and profiling
!>
!> Initially an almost pure Fortran finger excercise to play with tree structures,
!> using the (at the time) new object oriented Features of Fortran 2008. It
!> evolved into a timing library used by a couple of codes that run here at MPCDF.
!>
!> All you need to know is contained in module ftimings' timer_t derived type
!> public methods (\ref ftimings::timer_t).
!>
!> A minimal example:
!>
!> type(timer_t) :: timer
!>
!> call timer%enable()
!>
!> call timer%start("section")
!> [...]
!> call timer%start("subsection")
!> [...]
!> call timer%stop("subsection")
!> [...]
!> call timer%stop("section")
!>
!> call timer%print()
!>
!> call timer%free()
!>
!> Most of the public methods are documented with Doxygen-style tags in
!> ftimings/ftimings.F90. However, current Doxygen seems to be very poor at
!> creating documentation for Fortran codes, thus the resulting files seem to miss
!> most of the important methods, as they are wrongly considered to be private.
!>
!> Look at the documentation comments in the source code itself for the moment.
!>
!> Questions and feedback are welcome, contact loh {at} mpcdf.mpg.de
!>
!> All you need to know is contained in the \ref ftimings::timer_t derived type.
module ftimings
use ftimings_type
use ftimings_value
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment