diff --git a/docs/ww3_doxy_tmpl.md b/docs/ww3_doxy_tmpl.md index 8069634ae8..afd7d0cfbe 100644 --- a/docs/ww3_doxy_tmpl.md +++ b/docs/ww3_doxy_tmpl.md @@ -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 # contents of _1. Purpose_ from original header +!> @brief # contents of '1. Purpose' from original header !> !> @details !> !> @author @date - # ALL module variables documented -module_var_1 !< - ... -!> # multiples lines can be used -!> # if needed. -module_var_i - ... -module_var_N !< +``` + +###### 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_N !< ``` ### PROGRAM ``` -!> @brief # contents of _1. Purpose_ from original header +!> @brief # contents of '1. Purpose' from original header !> -!> @details # contents of _2. Method_ from original header +!> @details # contents of '2. Method' from original header !> !> @author @date ``` ### SUBROUTINE ``` -!> @brief # contents of _1. Purpose_ from original header +!> @brief # contents of '1. Purpose' from original header !> -!> @details # contents of _2. Method_ from original header +!> @details # contents of '2. Method' from original header !> -!> @param[in/out] # specify: [in], [out], [inout], or just `@param`. +!> @param[inout] # specify: [in], [out], [inout], or just `@param`. !> @author @date ``` @@ -60,12 +66,6 @@ module_var_N !< ``` -### Inline documentation (variables) -``` -!< # '!>' 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`.