Changeset 1682 for palm/trunk/SOURCE/progress_bar.f90

Timestamp:

Oct 7, 2015 11:56:08 PM (9 years ago)

Author:

knoop

Message:

Code annotations made doxygen readable

File:

• palm/trunk/SOURCE/progress_bar.f90 (modified) (7 diffs)

palm/trunk/SOURCE/progress_bar.f90

@@ -1 @@
- MODULE progress_bar
-
+!> @file progress_bar.f90
 !--------------------------------------------------------------------------------!
 ! This file is part of PALM.
@@ -20 +19 @@
 ! Current revisions:
 ! -----------------
-! 
+! Code annotations made doxygen readable 
 ! 
 ! Former revisions:
@@ -31 +30 @@
 ! Description:
 ! ------------
-! This routine prints either a progress bar on the standard output in case of
-! interactive runs, or it prints the progress in a separate file called
-! PROGRESS.
-!------------------------------------------------------------------------------!
+!> This routine prints either a progress bar on the standard output in case of
+!> interactive runs, or it prints the progress in a separate file called
+!> PROGRESS.
+!------------------------------------------------------------------------------!
+ MODULE progress_bar
+ 
 
     USE control_parameters,                                                    &
@@ -50 +51 @@
     PUBLIC   batch_job, finish_progress_bar, output_progress_bar
 
-    CHARACTER(LEN=60) ::  bar      !: progress bar, initially filled with "_"
-    CHARACTER(LEN=60) ::  crosses  !: filled with "X"
-
-    INTEGER(iwp) ::  ilength !: length of progress bar filled with "X"
-
-    LOGICAL ::  batch_job = .FALSE.   !: switch to determine the run mode
-
-    REAL(wp) ::  time_to_be_simulated !: in sec
-
-    LOGICAL ::  initialized = .FALSE. !: switch to determine if bar is initialized
+    CHARACTER(LEN=60) ::  bar      !< progress bar, initially filled with "_"
+    CHARACTER(LEN=60) ::  crosses  !< filled with "X"
+
+    INTEGER(iwp) ::  ilength !< length of progress bar filled with "X"
+
+    LOGICAL ::  batch_job = .FALSE.   !< switch to determine the run mode
+
+    REAL(wp) ::  time_to_be_simulated !< in sec
+
+    LOGICAL ::  initialized = .FALSE. !< switch to determine if bar is initialized
 
     SAVE
@@ -65 +66 @@
  CONTAINS
 
+!------------------------------------------------------------------------------!
+! Description:
+! ------------
+!> Initialize the progress bar/file
+!------------------------------------------------------------------------------!
+ 
     SUBROUTINE init_progress_bar
-!------------------------------------------------------------------------------!
-! Description:
-! ------------
-! Initialize the progress bar/file
-!------------------------------------------------------------------------------!
 
        IMPLICIT NONE
@@ -113 +115 @@
 
 
+!------------------------------------------------------------------------------!
+! Description:
+! ------------
+!> Print progress data to standard output (interactive) or to file (batch jobs)
+!------------------------------------------------------------------------------!
+ 
     SUBROUTINE output_progress_bar
-!------------------------------------------------------------------------------!
-! Description:
-! ------------
-! Print progress data to standard output (interactive) or to file (batch jobs)
-!------------------------------------------------------------------------------!
 
        IMPLICIT NONE
 
-       REAL(wp) ::  remaining_time_in_percent  !: remaining time to be simulated
-                                               !: in the job
-       REAL(wp) ::  remaining_time_in_percent_total !: total remaining time of
-                                                    !: the job chain
+       REAL(wp) ::  remaining_time_in_percent  !< remaining time to be simulated
+                                               !< in the job
+       REAL(wp) ::  remaining_time_in_percent_total !< total remaining time of
+                                                    !< the job chain
 
        IF ( .NOT. initialized )  CALL init_progress_bar
@@ -170 +173 @@
     END SUBROUTINE output_progress_bar
 
+!------------------------------------------------------------------------------!
+! Description:
+! ------------
+!> Finalization of the progress bar/file
+!------------------------------------------------------------------------------!
+ 
     SUBROUTINE finish_progress_bar
-!------------------------------------------------------------------------------!
-! Description:
-! ------------
-! Finalization of the progress bar/file
-!------------------------------------------------------------------------------!
 
        IMPLICIT NONE