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

Timestamp:

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

Author:

knoop

Message:

Code annotations made doxygen readable

File:

• palm/trunk/SOURCE/user_statistics.f90 (modified) (4 diffs)

palm/trunk/SOURCE/user_statistics.f90

@@ -1 @@
- SUBROUTINE user_statistics( mode, sr, tn )
-
+!> @file user_statistics.f90
 !--------------------------------------------------------------------------------!
 ! This file is part of PALM.
@@ -20 +19 @@
 ! Current revisions:
 ! -----------------
-! 
+! Code annotations made doxygen readable 
 ! 
 ! Former revisions:
@@ -48 +47 @@
 ! Description:
 ! ------------
-! Calculation of user-defined statistics, i.e. horizontally averaged profiles
-! and time series.
-! This routine is called for every statistic region sr defined by the user,
-! but at least for the region "total domain" (sr=0).
-! See section 3.5.4 on how to define, calculate, and output user defined
-! quantities.
+!> Calculation of user-defined statistics, i.e. horizontally averaged profiles
+!> and time series.
+!> This routine is called for every statistic region sr defined by the user,
+!> but at least for the region "total domain" (sr=0).
+!> See section 3.5.4 on how to define, calculate, and output user defined
+!> quantities.
 !------------------------------------------------------------------------------!
+ SUBROUTINE user_statistics( mode, sr, tn )
+ 
 
     USE arrays_3d
@@ -72 +73 @@
     IMPLICIT NONE
 
-    CHARACTER (LEN=*) ::  mode   !: 
+    CHARACTER (LEN=*) ::  mode   !< 
 
-    INTEGER(iwp) ::  i    !: 
-    INTEGER(iwp) ::  j    !: 
-    INTEGER(iwp) ::  k    !: 
-    INTEGER(iwp) ::  sr   !: 
-    INTEGER(iwp) ::  tn   !: 
+    INTEGER(iwp) ::  i    !< 
+    INTEGER(iwp) ::  j    !< 
+    INTEGER(iwp) ::  k    !< 
+    INTEGER(iwp) ::  sr   !< 
+    INTEGER(iwp) ::  tn   !< 
 
     REAL(wp),                                                                  &
        DIMENSION(dots_num_palm+1:dots_max) ::                                  &
-          ts_value_l   !: 
+          ts_value_l   !<