Improve the documentation blocks in HAFS Fortran files

[BinLiu-NOAA]

Description

From NCO SPA: Many Fortran files don't have documentation blocks, …. Please add these blocks as described in “NCO WCOSS Implementation Standards” (check also other directories).

Please continue to improve the documentation for HAFS source codes.

Here are some quick checks the HAFS Fortran codes with "authors" or "history" as the following - under /lfs/h1/ops/para/packages/hafs.v1.0.3/sorc

 find *fd/. -name "*.[fF]90" -type f > /lfs/h1/nco/ptmp/simon.hsiao/hafs.src.F90
 find *fd/. -name "*.[fF]" -type f > /lfs/h1/nco/ptmp/simon.hsiao/hafs.src.F
 grep -l -i -e "authors" -e "history" `find *fd/. -name "*.[fF]90" -type f` > /lfs/h1/nco/ptmp/simon.hsiao/hafs.src.doc.blocks.F90
 grep -l -i -e "authors" -e "history" `find *fd/. -name "*.[fF]" -type f` > /lfs/h1/nco/ptmp/simon.hsiao/hafs.src.doc.blocks.F
 
 for dir in `ls -d *fd`; do echo $dir; echo "total Fortran files: " `grep -e $dir /lfs//h1/nco/ptmp/simon.hsiao/hafs.src.F*|wc -l`; echo "Documentation counts: " ` grep -e $dir /lfs/h1/nco/ptmp/simon.hsiao/hafs.src.doc.blocks.F*|wc -l`  ; done                                                                                  

hafs_forecast.fd total Fortran files: 2789 Documentation counts: 1094 hafs_gsi.fd total Fortran files: 763 Documentation counts: 709 hafs_hycom_utils.fd total Fortran files: 145 Documentation counts: 8 hafs_post.fd total Fortran files: 155 Documentation counts: 97 hafs_tools.fd total Fortran files: 111 Documentation counts: 21 hafs_tracker.fd total Fortran files: 10 Documentation counts: 2 hafs_utils.fd total Fortran files: 435 Documentation counts: 78

Proposed solution

Status (optional)

Related to (optional)