Skip to content

ww3_doxy_tmpl.md: clarify MODULE markup #606

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
JessicaMeixner-NOAA merged 1 commit into from
Feb 9, 2022
Merged

ww3_doxy_tmpl.md: clarify MODULE markup #606

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 20 additions & 20 deletions docs/ww3_doxy_tmpl.md
View file
Open in desktop
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