Add doxygen documentation for print_marbl_log()

Failed a TravisCI test due to missing documentation
mnlevy1981 · Sep 19, 2019 · cb72bdc · cb72bdc
1 parent b4e5e3f
commit cb72bdc
Showing 1 changed file with 3 additions and 2 deletions.
diff --git a/src/tracer/MARBL_tracers.F90 b/src/tracer/MARBL_tracers.F90
@@ -423,8 +423,9 @@ subroutine MARBL_tracers_end(CS)
   endif
 end subroutine MARBL_tracers_end
 
-!*****************************************************************************
-
+!> This subroutine writes the contents of the MARBL log to stdout.
+!! TODO: some log messages come from a specific grid point, and this routine
+!!       needs to include the location in the preamble
 subroutine print_marbl_log(log_to_print)
 
   use marbl_logging, only : marbl_status_log_entry_type