Tweaks for doxygen docs

Doxyfile.in

@@ -733,7 +733,7 @@ WARN_LOGFILE           =
 # spaces.
 # Note: If this tag is empty the current directory is searched.
 
-INPUT = @SRCDIR@/ftimings/
+INPUT = @top_srcdir@/ftimings/ftimings.F90 ftimings/ftimings.h
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
@@ -1779,18 +1779,6 @@ GENERATE_XML           = NO
 
 XML_OUTPUT             = xml
 
-# The XML_SCHEMA tag can be used to specify a XML schema, which can be used by a
-# validating XML parser to check the syntax of the XML files.
-# This tag requires that the tag GENERATE_XML is set to YES.
-
-XML_SCHEMA             =
-
-# The XML_DTD tag can be used to specify a XML DTD, which can be used by a
-# validating XML parser to check the syntax of the XML files.
-# This tag requires that the tag GENERATE_XML is set to YES.
-
-XML_DTD                =
-
 # If the XML_PROGRAMLISTING tag is set to YES doxygen will dump the program
 # listings (including syntax highlighting and cross-referencing information) to
 # the XML output. Note that enabling this will significantly increase the size

ftimings/ftimings.F90

@@ -35,13 +35,21 @@ module ftimings
 
   private
 
+  ! do not clutter public namespace with value_t
+  private :: &
+    value_t, &
+    null_value, &
+    value_add, &
+    value_minus, &
+    value_inverse
+
   ! this is mainly needed for Doxygen, they are
   ! by implicitly reachable as type-bound procedures
   ! of timer_t, however Doxygen does not document them
   ! if they are not also public
   public timer_start, timer_stop, &
          timer_free, &
-         timer_print, &
+         timer_print, timer_print_node, &
          timer_enable, timer_disable, timer_is_enabled, &
          timer_in_entries, timer_in_entries_node, &
          timer_get, timer_get_node, &
@@ -52,7 +60,9 @@ module ftimings
          timer_measure_allocated_memory, &
          timer_measure_virtual_memory,   &
          timer_measure_max_allocated_memory,   &
-         timer_measure_memory_bandwidth
+         timer_measure_memory_bandwidth, &
+         timer_register_error_handler, &
+         node_get_child
 
   character(len=name_length), private, parameter :: own = "(own)"
   character(len=name_length), private, parameter :: below = "(below threshold)"
@@ -154,11 +164,10 @@ module ftimings
       procedure, private, pass :: error => timer_error
   end type
 
-  ! Private type node_t, representing a graph node
-  !
+  !> Opaque type node_t, representing a graph node
+  !>
   !c> struct ftimer_node_struct;
   !c> typedef struct ftimer_node_struct ftimer_node_t;
-  !
   type, public :: node_t
     character(len=name_length), private :: name = ""                    ! Descriptive name, used when printing the timings
     integer, private                    :: count = 0                    ! Number of node_stop calls
@@ -338,7 +347,7 @@ module ftimings
   !> Call with enabled = .true. to also record amount of newly allocated memory.
   !> By default, memory usage is not recored. Call with .false. to deactivate again.
   !>
-  !> This opens /proc/self/statm, parses it, and closes it agagain and is thus
+  !> This opens /proc/self/statm, parses it, and closes it again and is thus
   !> quite costly, use when appropriate.
   !>
   subroutine timer_measure_allocated_memory(self, enabled)
@@ -352,7 +361,7 @@ module ftimings
   !> Call with enabled = .true. to also record amount of newly created virtual memory.
   !> By default, memory usage is not recored. Call with .false. to deactivate again.
   !>
-  !> This opens /proc/self/statm, parses it, and closes it agagain and is thus
+  !> This opens /proc/self/statm, parses it, and closes it again and is thus
   !> quite costly, use when appropriate.
   !>
   subroutine timer_measure_virtual_memory(self, enabled)
@@ -367,7 +376,7 @@ module ftimings
   !> resident memory
   !> By default, memory usage is not recored. Call with .false. to deactivate again.
   !>
-  !> This opens /proc/self/status, parses it, and closes it agagain and is thus
+  !> This opens /proc/self/status, parses it, and closes it again and is thus
   !> quite costly, use when appropriate.
   !>
   subroutine timer_measure_max_allocated_memory(self, enabled)
@@ -915,7 +924,7 @@ module ftimings
   !> \param namei               The name of all sub-entries below this
   !>                            node which should be summed together
   !>
-  !> For example timer%in_entries("foo", "bar", "parallel") returns
+  !> For example, timer\%in_entries("foo", "bar", "parallel") returns
   !> the sum of all entries named "parallel" below the foo->bar node
   !>
   function timer_in_entries(self, name1, name2, name3, name4, name5, name6) result(s)
@@ -1323,6 +1332,12 @@ module ftimings
     eq = trim(str1) .eq. str2(1:min(len(trim(str2)), name_length))
   end function
 
+  !> Returns a particular child-node
+  !>
+  !> \param     name    The name of the child to look for
+  !>
+  !> \returns the child node, or NULL() if no node with the given name can be found
+  !>
   function node_get_child(self, name) result(child)
     class(node_t), intent(in) :: self
     character(len=*), intent(in) :: name

ftimings/ftimings_value.F90

@@ -19,6 +19,7 @@
 #include "config-f90.h"
 #endif
 
+!> \private
 module ftimings_value
   use ftimings_type
   implicit none