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

Timestamp:

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

Author:

knoop

Message:

Code annotations made doxygen readable

File:

• palm/trunk/SOURCE/message.f90 (modified) (6 diffs)

palm/trunk/SOURCE/message.f90

@@ -1 @@
- SUBROUTINE message( routine_name, message_identifier, requested_action, &
-                     message_level, output_on_pe, file_id, flush )
-
+!> @file message.f90
 !--------------------------------------------------------------------------------!
 ! This file is part of PALM.
@@ -21 +19 @@
 ! Current revisions:
 ! -----------------
-! 
+! Code annotations made doxygen readable 
 ! 
 ! Former revisions:
@@ -51 +49 @@
 ! Description:
 ! ------------
-! Handling of the different kinds of messages.
-! Meaning of formal parameters:
-! requested_action: 0 - continue, 1 - abort by stop, 2 - abort by mpi_abort
-! message_level: 0 - informative, 1 - warning, 2 - error
-! output_on_pe: -1 - all, else - output on specified PE
-! file_id: 6 - stdout (*)
-! flush: 0 - no action, 1 - flush the respective output buffer
+!> Handling of the different kinds of messages.
+!> Meaning of formal parameters:
+!> requested_action: 0 - continue, 1 - abort by stop, 2 - abort by mpi_abort
+!> message_level: 0 - informative, 1 - warning, 2 - error
+!> output_on_pe: -1 - all, else - output on specified PE
+!> file_id: 6 - stdout (*)
+!> flush: 0 - no action, 1 - flush the respective output buffer
 !------------------------------------------------------------------------------!
+ SUBROUTINE message( routine_name, message_identifier, requested_action, &
+                     message_level, output_on_pe, file_id, flush )
+ 
 
     USE control_parameters,                                                    &
@@ -69 +70 @@
     IMPLICIT NONE
 
-    CHARACTER(LEN=6)   ::  message_identifier            !:
-    CHARACTER(LEN=*)   ::  routine_name                  !:
-    CHARACTER(LEN=200) ::  header_string                 !:
-    CHARACTER(LEN=200) ::  information_string_1          !:
-    CHARACTER(LEN=200) ::  information_string_2          !:
-
-    INTEGER(iwp) ::  file_id                             !:
-    INTEGER(iwp) ::  flush                               !:
-    INTEGER(iwp) ::  i                                   !:
-    INTEGER(iwp) ::  message_level                       !:
-    INTEGER(iwp) ::  output_on_pe                        !:
-    INTEGER(iwp) ::  requested_action                    !:
-
-    LOGICAL ::  do_output                                !:
-    LOGICAL ::  pe_out_of_range                          !:
+    CHARACTER(LEN=6)   ::  message_identifier            !<
+    CHARACTER(LEN=*)   ::  routine_name                  !<
+    CHARACTER(LEN=200) ::  header_string                 !<
+    CHARACTER(LEN=200) ::  information_string_1          !<
+    CHARACTER(LEN=200) ::  information_string_2          !<
+
+    INTEGER(iwp) ::  file_id                             !<
+    INTEGER(iwp) ::  flush                               !<
+    INTEGER(iwp) ::  i                                   !<
+    INTEGER(iwp) ::  message_level                       !<
+    INTEGER(iwp) ::  output_on_pe                        !<
+    INTEGER(iwp) ::  requested_action                    !<
+
+    LOGICAL ::  do_output                                !<
+    LOGICAL ::  pe_out_of_range                          !<
 
 
@@ -205 +206 @@
 
 
- SUBROUTINE location_message( location, advance )
-
 !------------------------------------------------------------------------------!
 ! Description:
 ! ------------
-! Prints out the given location on stdout
+!> Prints out the given location on stdout
 !------------------------------------------------------------------------------!
+ 
+ SUBROUTINE location_message( location, advance )
+
 
     USE, INTRINSIC ::  ISO_FORTRAN_ENV,                                        &
@@ -221 +223 @@
     IMPLICIT NONE
 
-    CHARACTER(LEN=*) ::  location !: text to be output on stdout
-    LOGICAL          ::  advance  !: switch for advancing/noadvancing I/O
+    CHARACTER(LEN=*) ::  location !< text to be output on stdout
+    LOGICAL          ::  advance  !< switch for advancing/noadvancing I/O