Skip to content
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.

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

Doxygen documentation 8th subset #1046

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
31 commits
Select commit Hold shift + click to select a range
d0d0437
w3sdb1md.F90: add doxygen
MatthewMasarik-NOAA Jan 12, 2023
fb43025
w3sbt9md.F90: add doxygen
MatthewMasarik-NOAA Jan 12, 2023
2db0320
w3sbt8md.F90: add doxygen
MatthewMasarik-NOAA Jan 14, 2023
8915e1b
w3sbt4md.F90: add doxygen
MatthewMasarik-NOAA Jan 14, 2023
50ab655
w3sbt1md.F90: add doxygen
MatthewMasarik-NOAA Jan 14, 2023
ea2a25f
w3ref1md.F90: add doxygen
MatthewMasarik-NOAA Jan 15, 2023
6b433f4
w3pro3md.F90: add doxygen
MatthewMasarik-NOAA Jan 15, 2023
c679021
w3pro2md.F90: add doxygen
MatthewMasarik-NOAA Jan 16, 2023
db1a969
Merge branch 'NOAA-EMC:develop' into doc/doxygen8
MatthewMasarik-NOAA Feb 16, 2023
f8fe679
Merge branch 'NOAA-EMC:develop' into doc/doxygen8
MatthewMasarik-NOAA Mar 1, 2023
22b8390
Merge branch 'NOAA-EMC:develop' into doc/doxygen8
MatthewMasarik-NOAA Mar 2, 2023
4f72f82
Merge branch 'NOAA-EMC:develop' into doc/doxygen8
MatthewMasarik-NOAA Apr 19, 2023
579591e
Merge branch 'NOAA-EMC:develop' into doc/doxygen8
MatthewMasarik-NOAA May 3, 2023
a63aa97
Merge branch 'NOAA-EMC:develop' into doc/doxygen8
MatthewMasarik-NOAA Jun 27, 2023
ffa7d2d
Merge branch 'NOAA-EMC:develop' into doc/doxygen8
MatthewMasarik-NOAA Jul 17, 2023
a62ba0f
gx_outf.F90: add doxygen markdown
MatthewMasarik-NOAA Jul 21, 2023
4d6281f
gx_outp.F90: add doxygen markdown
MatthewMasarik-NOAA Jul 21, 2023
d47979e
w3canomd.F90: checkpoint - add doxygen
MatthewMasarik-NOAA Jul 21, 2023
e959207
w3canomd.F90: doxygen checkpoint 2
MatthewMasarik-NOAA Jul 24, 2023
0800230
w3canomd.F90: add doxygen markdown
MatthewMasarik-NOAA Jul 25, 2023
16e7e54
w3pro1md.F90: add doxygen markdown
MatthewMasarik-NOAA Jul 25, 2023
9f6ca6c
w3parall.F90: add doxygen markdown
MatthewMasarik-NOAA Jul 25, 2023
0fd264e
w3sbt4md.F90: punctuation fix for http formatting
MatthewMasarik-NOAA Jul 25, 2023
f2b86d0
w3pro3md.F90: fix documentation typo
MatthewMasarik-NOAA Jul 25, 2023
de8c8d7
w3pro2md.F90: fix documentation typo
MatthewMasarik-NOAA Jul 25, 2023
b183db2
gx_outf.F90: fix grammar in documentation
MatthewMasarik-NOAA Jul 25, 2023
a5d6acf
w3canomd.F90: fix documentation grammar
MatthewMasarik-NOAA Jul 25, 2023
366e38f
w3canomd.F90: fix multiple grammar in documentation
MatthewMasarik-NOAA Jul 25, 2023
c23b4f1
w3canomd.F90: fix remaining grammar in documentation
MatthewMasarik-NOAA Jul 25, 2023
078f020
w3parall.F90: fix spelling typo
MatthewMasarik-NOAA Jul 25, 2023
8ba649a
Merge branch 'NOAA-EMC:develop' into doc/doxygen8
MatthewMasarik-NOAA Jul 31, 2023
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
42 changes: 42 additions & 0 deletions model/src/gx_outf.F90
Original file line number Diff line number Diff line change
@@ -1,5 +1,37 @@
!> @file
!> @brief Generate GrADS input files from raw WAVEWATCH data file.
!>
!> @author H. L. Tolman
!> @author A. Chawla
!> @author J.H.G.M. Alves
!> @date 22-Mar-2021
!>
#include "w3macros.h"

!/ ------------------------------------------------------------------- /
!>
!> @brief Generate GrADS input files from raw WAVEWATCH data file.
!>
!> @details
!> Data is read from the grid output file out_grd.ww3 (raw data)
!> and from the file gx_outf.inp ( NDSI, output requests ).
!> Model definition and raw data files are read using WAVEWATCH III
!> subroutines.
!>
!> Output files are ww3.ctl and ww3.grads. The output files
!> contains a land-sea map, followed by requested fields. See the
!> control file for the names of the fields.
!>
!> @author H. L. Tolman
!> @author A. Chawla
!> @author J.H.G.M. Alves
!> @date 22-Mar-2021
!>
!> @copyright Copyright 2009-2022 National Weather Service (NWS),
!> National Oceanic and Atmospheric Administration. All rights
!> reserved. WAVEWATCH III is a trademark of the NWS.
!> No unauthorized use without permission.
!>
PROGRAM GXOUTF
!/
!/ +-----------------------------------+
Expand Down Expand Up @@ -740,6 +772,16 @@ PROGRAM GXOUTF
!/
CONTAINS
!/ ------------------------------------------------------------------- /
!>
!> @brief Perform actual output for GrADS postprocessing.
!>
!> @param[in] NX Grid dimensions.
!> @param[in] NY Grid dimensions.
!> @param[in] NSEA Number of sea points.
!>
!> @author H. L. Tolman
!> @date 22-Mar-2021
!>
SUBROUTINE GXEXGO ( NX, NY, NSEA )
!/
!/ +-----------------------------------+
Expand Down
28 changes: 28 additions & 0 deletions model/src/gx_outp.F90
Original file line number Diff line number Diff line change
@@ -1,5 +1,27 @@
!> @file
!> @brief Post-processing of point output for GrADS post-processing.
!>
!> @author H. L. Tolman
!> @author J.H. Alves
!> @author F. Ardhuin
!> @date 27-Aug-2015
!>

#include "w3macros.h"
!/ ------------------------------------------------------------------- /
!>
!> @brief Post-processing of point output for GrADS post-processing.
!>
!> @author H. L. Tolman
!> @author J.H. Alves
!> @author F. Ardhuin
!> @date 27-Aug-2015
!>
!> @copyright Copyright 2009-2022 National Weather Service (NWS),
!> National Oceanic and Atmospheric Administration. All rights
!> reserved. WAVEWATCH III is a trademark of the NWS.
!> No unauthorized use without permission.
!>
PROGRAM GXOUTP
!/
!/ +-----------------------------------+
Expand Down Expand Up @@ -539,6 +561,12 @@ PROGRAM GXOUTP
!/
CONTAINS
!/ ------------------------------------------------------------------- /
!>
!> @brief Perform actual point output.
!>
!> @author H. L. Tolman
!> @date 16-Jul-2012
!>
SUBROUTINE GXEXPO
!/
!/ +-----------------------------------+
Expand Down
Loading
Loading