Changeset 1682 for palm/trunk/SOURCE/user_module.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_module.f90 (modified) (4 diffs)

palm/trunk/SOURCE/user_module.f90

@@ -1 @@
- MODULE user
-
+!> @file user_module.f90
 !--------------------------------------------------------------------------------!
 ! This file is part of PALM.
@@ -20 +19 @@
 ! Current revisions:
 ! -----------------
-! 
+! Code annotations made doxygen readable 
 !
 ! Former revisions:
@@ -43 +42 @@
 ! Description:
 ! ------------
-! Declaration of user-defined variables. This module may only be used
-! in the user-defined routines (contained in user_interface.f90).
+!> Declaration of user-defined variables. This module may only be used
+!> in the user-defined routines (contained in user_interface.f90).
 !------------------------------------------------------------------------------!
+ MODULE user
+ 
 
     USE kinds
@@ -51 +52 @@
     IMPLICIT NONE
 
-    INTEGER(iwp) ::  dots_num_palm   !: 
-    INTEGER(iwp) ::  user_idummy     !: 
+    INTEGER(iwp) ::  dots_num_palm   !< 
+    INTEGER(iwp) ::  user_idummy     !< 
     
-    LOGICAL ::  user_defined_namelist_found = .FALSE.   !: 
+    LOGICAL ::  user_defined_namelist_found = .FALSE.   !< 
     
-    REAL(wp) ::  user_rdummy   !: 
+    REAL(wp) ::  user_rdummy   !< 
 
 !
 !-- Sample for user-defined output
-!    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  u2       !: user defined array
-!    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  u2_av    !: user defined array
-!    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  ustvst   !: user defined array
+!    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  u2       !< user defined array
+!    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  u2_av    !< user defined array
+!    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  ustvst   !< user defined array
 
     SAVE