Skip to content

ww3_doxy_tmpl.md: fix module vars #599

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
aliabdolali merged 2 commits into from
Feb 1, 2022
Merged

ww3_doxy_tmpl.md: fix module vars #599

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b2b3ce6
ww3_doxy_tmpl.md: fix module vars
MatthewMasarik-NOAA Jan 26, 2022
b02719c
Doxyfile.in: EXTENSION_MAPPING for F90
MatthewMasarik-NOAA Jan 31, 2022
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
2 changes: 1 addition & 1 deletion docs/Doxyfile.in
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -323,7 +323,7 @@ OPTIMIZE_OUTPUT_SLICE = NO
# Note that for custom extensions you also need to set FILE_PATTERNS otherwise
# the files are not read by doxygen.

EXTENSION_MAPPING =
EXTENSION_MAPPING = f=FortranFixed f90=FortranFree F90=FortranFree

# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
# according to the Markdown format, which allows for more readable
Expand Down
13 changes: 9 additions & 4 deletions docs/ww3_doxy_tmpl.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# WAVEWATCH III Doxygen Header Reference
<br>

_Doxygen markup headers to be placed directly above the respective Fortran code units._
_Doxygen markup headers to be placed **directly above** the respective Fortran code units._

### FILE
```
Expand All @@ -17,10 +17,15 @@ _Doxygen markup headers to be placed directly above the respective Fortran code
!>
!> @details <extended description>
!>
!> @param <module var 1> # ALL module variables documented
!> ...
!> @param <module var N>
!> @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>
```

### PROGRAM
Expand Down