Skip to content

Commit

Permalink
ww3_doxy_tmpl.md: clarify MODULE markup (#606)
Browse files Browse the repository at this point in the history
  • Loading branch information
MatthewMasarik-NOAA authored Feb 9, 2022
1 parent 82e34ba commit e6d27b9
Showing 1 changed file with 20 additions and 20 deletions.
40 changes: 20 additions & 20 deletions docs/ww3_doxy_tmpl.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,38 +12,44 @@ _Doxygen markup headers to be placed **directly above** the respective Fortran c
```

### MODULE
Module has two parts: a **header**, and **inline documentation** for module variables.
###### header
```
!> @brief <one sentence description> # contents of _1. Purpose_ from original header
!> @brief <one sentence description> # contents of '1. Purpose' from original header
!>
!> @details <extended description>
!>
!> @author <author name> @date <dd-Mon-yyyy>
# ALL module variables documented
module_var_1 !< <module_var_1 description>
...
!> <module_var_i description> # multiples lines can be used
!> <module_var_i description cont.> # if needed.
module_var_i
...
module_var_N !< <module_var_N description>
```

###### inline documentation
*ALL* module variables need to be documented. To accomodate this, put each variable on it own line.
The documentation can go directly above or to the right of the variable declaration. Multiple lines
can be used.
```
var_1 !< <var_1 description>
.
.
!< <var_N description>
var_N !< <var_N description continued>
```

### PROGRAM
```
!> @brief <one sentence description> # contents of _1. Purpose_ from original header
!> @brief <one sentence description> # contents of '1. Purpose' from original header
!>
!> @details <extended description> # contents of _2. Method_ from original header
!> @details <extended description> # contents of '2. Method' from original header
!>
!> @author <author name> @date <dd-Mon-yyyy>
```

### SUBROUTINE
```
!> @brief <one sentence description> # contents of _1. Purpose_ from original header
!> @brief <one sentence description> # contents of '1. Purpose' from original header
!>
!> @details <extended description> # contents of _2. Method_ from original header
!> @details <extended description> # contents of '2. Method' from original header
!>
!> @param[in/out] <param name> <very short description> # specify: [in], [out], [inout], or just `@param`.
!> @param[inout] <param name> <very short description> # specify: [in], [out], [inout], or just `@param`.
!> @author <author name> @date <dd-Mon-yyyy>
```

Expand All @@ -60,12 +66,6 @@ module_var_N !< <module_var_N description>
```


### Inline documentation (variables)
```
!< <inline variable description> # '!>' is equally valid here as well
```


### Optional tags
* Some of the more relevant tags that might be included: `@remark`, `@attention`, `@warning`, `@example`,
`@code`, `@cite`, `@copyright`.
Expand Down

0 comments on commit e6d27b9

Please sign in to comment.