Merge pull request #179 from NOAA-EMC/jba_moredox

more Doxygen updates, including using table formatting for all program history logs
NOAA-EMC · Nov 9, 2021 · 3f2e10b · 3f2e10b
2 parents 6c61f7e + 1e07063
commit 3f2e10b
Show file tree

Hide file tree

Showing 165 changed files with 2,176 additions and 2,466 deletions.
diff --git a/docs/ReleaseNotes.md b/docs/ReleaseNotes.md
@@ -3,7 +3,7 @@
 @brief Detailed description of changes included within each new release.
 
 
-### Version 11.6.0 - TBD
+### Version 11.6.0 - November 10, 2021
 
 * All of the library builds now use dynamic allocation, so the "_DA" suffix
 has now been correspondingly removed from the names of the library builds.

diff --git a/src/adn30.f b/src/adn30.f
@@ -9,22 +9,21 @@
 C> @author J. Woollen
 C> @date 1994-01-06
 C>
-C> @param[in] IDN - integer: Bit-wise representation of FXY value
-C> @param[in] L30 - integer: Length of string to be returned; can be
+C> @param[in] IDN -- integer: Bit-wise representation of FXY value
+C> @param[in] L30 -- integer: Length of string to be returned; can be
 C>                either 5 or 6 characters
-C> @returns adn30 - character*(*): FXY value
+C> @returns adn30 -- character*(*): FXY value
 C>
 C> @remarks
 C> - This function is the logical inverse of function idn30().
 C>
 C> <b>Program History Log:</b>
-C> - 1994-01-06  J. Woollen -- Original author
-C> - 1998-07-08  J. Woollen -- Replaced call to CRAY library routine
-C>                           "ABORT" with call to new internal BUFRLIB
-C>                           routine bort()
-C> - 2003-11-04  S. Bender  -- Added remarks and routine interdependencies
-C> - 2003-11-04  D. Keyser  -- Unified/portable for WRF; added
-C>                           history documentation
+C> | Date | Programmer | Comments |
+C> | -----|------------|----------|
+C> | 1994-01-06 | J. Woollen | Original author |
+C> | 1998-07-08 | J. Woollen | Replaced call to CRAY library routine "ABORT" with call to new internal BUFRLIB routine bort() |
+C> | 2003-11-04 | S. Bender  | Added remarks and routine interdependencies |
+C> | 2003-11-04 | D. Keyser  | Unified/portable for WRF; added history documentation |
 
       FUNCTION ADN30(IDN,L30)
 

diff --git a/src/arallocc.c b/src/arallocc.c
@@ -27,8 +27,10 @@
  *   operating system once the application program terminates.
  *
  * <b>Program history log:</b>
- * - 2014-12-04  J. Ator    -- Original author
- * - 2021-05-17  J. Ator    -- Allow up to 24 characters in cbunit
+ * | Date | Programmer | Comments |
+ * | -----|------------|----------|
+ * | 2014-12-04 | J. Ator | Original author |
+ * | 2021-05-17 | J. Ator | Allow up to 24 characters in cbunit |
  */
 
 void arallocc( void )

diff --git a/src/arallocf.f b/src/arallocf.f
@@ -22,14 +22,14 @@
 C> operating system once the application program terminates.
 C>
 C> <b>Program history log:</b>
-C> - 2014-12-04  J. Ator    -- Original author
-C> - 2016-05-24  J. Ator    -- Added allocations for MODA_BITMAPS
-C>                             and MODA_NRV203
-C> - 2017-05-22  J. Ator    -- Added allocations for MODA_RLCCMN
-C> - 2019-05-09  J. Ator    -- Modified allocations for MODA_BUFRMG
-C> - 2021-01-08  J. Ator    -- Modified mstabs array declarations
-C>                             for GNUv10 portability
-C> - 2021-05-17  J. Ator    -- Allow up to 24 characters in cbunit
+C> | Date | Programmer | Comments |
+C> | -----|------------|----------|
+C> | 2014-12-04 | J. Ator | Original author |
+C> | 2016-05-24 | J. Ator | Added allocations for MODA_BITMAPS and MODA_NRV203 |
+C> | 2017-05-22 | J. Ator | Added allocations for MODA_RLCCMN |
+C> | 2019-05-09 | J. Ator | Modified allocations for MODA_BUFRMG |
+C> | 2021-01-08 | J. Ator | Modified mstabs array declarations for GNUv10 portability |
+C> | 2021-05-17 | J. Ator | Allow up to 24 characters in cbunit |
 C>
 	SUBROUTINE ARALLOCF
 

diff --git a/src/ardllocc.c b/src/ardllocc.c
@@ -15,7 +15,9 @@
  * @date 2014-12-04
  *
  * <b>Program history log:</b>
- * - 2014-12-04  J. Ator    -- Original author
+ * | Date | Programmer | Comments |
+ * | -----|------------|----------|
+ * | 2014-12-04 | J. Ator | Original author |
  */
 
 void ardllocc( void )

diff --git a/src/ardllocf.f b/src/ardllocf.f
@@ -9,7 +9,9 @@
 C> @date 2014-12-04
 C>
 C> <b>Program history log:</b>
-C> - 2014-12-04  J. Ator    -- Original author
+C> | Date | Programmer | Comments |
+C> | -----|------------|----------|
+C> | 2014-12-04 | J. Ator | Original author |
 C>
 	SUBROUTINE ARDLLOCF
 

diff --git a/src/atrcpt.f b/src/atrcpt.f
@@ -14,11 +14,11 @@
 C> @author J. Ator
 C> @date 2009-03-23
 C>
-C> @param[in] MSGIN    - integer(*): BUFR message
-C> @param[in] LMSGOT   - integer: Dimensioned size (in integers) of
+C> @param[in] MSGIN   -- integer(*): BUFR message
+C> @param[in] LMSGOT  -- integer: Dimensioned size (in integers) of
 C>                       MSGOT; used by the subroutine to ensure that
 C>                       it doesn't overflow the MSGOT array
-C> @param[out] MSGOT   - integer(*): Copy of MSGIN with a tank
+C> @param[out] MSGOT  -- integer(*): Copy of MSGIN with a tank
 C>                       receipt time added to Section 1
 C>
 C> @remarks
@@ -27,7 +27,9 @@
 C> for extra space when allocating MSGOT within the application program.
 C>
 C> <b>Program history log:</b>
-C> - 2009-03-23  J. Ator    -- Original author
+C> | Date | Programmer | Comments |
+C> | -----|------------|----------|
+C> | 2009-03-23 | J. Ator  | Original author |
 C>
 	SUBROUTINE ATRCPT(MSGIN,LMSGOT,MSGOT)
 

diff --git a/src/bfrini.f90.in b/src/bfrini.f90.in
@@ -15,44 +15,27 @@
 !> @date 1994-01-06
 !>
 !> <b>Program history log:</b>
-!> - 1994-01-06  J. Woollen -- Original author
-!> - 1995-06-28  J. Woollen -- Increased the size of internal BUFR table
-!>                           arrays in order to handle bigger files
-!> - 1998-07-08  J. Woollen -- Modified to make Y2K-compliant
-!> - 1999-11-18  J. Woollen -- The number of BUFR files which can be
-!>                             opened at one time increased from 10 to 32
-!>                             (necessary in order to process multiple
-!>                             BUFR files under the MPI)
-!> - 2000-09-19  J. Woollen -- Maximum message length increased from
-!>                           10,000 to 20,000 bytes
-!> - 2003-11-04  J. Ator    -- Added documentation
-!> - 2003-11-04  S. Bender  -- Added remarks and routine interdependencies
-!> - 2003-11-04  D. Keyser  -- MAXJL (maximum number of jump/link entries)
-!>                           increased from 15000 to 16000 (was in
-!>                           verification version); initialize
-!>                           variable JSR to zero in new COMMON block
-!>                           /BUFRSR/ (was in verification version);
-!>                           unified/portable for WRF; added history
-!>                           documentation
-!> - 2004-08-18  J. Ator    -- Added initialization of COMMON /MSGSTD/;
-!>                           maximum message length increased from
-!>                           20,000 to 50,000 bytes
-!> - 2005-11-29  J. Ator    -- Added initialization of COMMON /MSGCMP/
-!>			    and calls to pkvs1 and pkvs01()
-!> - 2009-03-23  J. Ator    -- Added initialization of COMMON /DSCACH/,
-!>                           COMMON /MSTINF/ and COMMON /TNKRCP/
-!> - 2012-09-15  J. Woollen -- Modified for C/I/O/BUFR interface,
-!>                           added initialization of COMMON blocks
-!>                           /ENDORD/ and /BUFRBMISS/
-!> - 2014-09-15  J. Ator    -- Change default location of MTDIR
-!> - 2014-11-18  J. Ator    -- Added initialization of modules MSGLIM
-!>                           and USRINT; remove S01CM initialization
-!> - 2016-11-29  J. Ator    -- Explicitly initialize BMISS as 10E10_8
-!> - 2017-10-13  J. Ator    -- Added initialization of COMMON /TABLEF/
-!> - 2019-05-03  J. Ator    -- Change default location of MTDIR
-!> - 2019-05-09  J. Ator    -- Added dimensions for MSGLEN
-!> - 2021-03-23  J. Ator    -- Use mtinfo() with MASTER_TABLE_DIR
-!>                             macro from CMake
+!> | Date | Programmer | Comments |
+!> | -----|------------|----------|
+!> | 1994-01-06 | J. Woollen | Original author |
+!> | 1995-06-28 | J. Woollen | Increased the size of internal BUFR table arrays in order to handle bigger files |
+!> | 1998-07-08 | J. Woollen | Modified to make Y2K-compliant |
+!> | 1999-11-18 | J. Woollen | The number of BUFR files which can be opened at one time increased from 10 to 32 (necessary in order to process multiple BUFR files under the MPI) |
+!> | 2000-09-19 | J. Woollen | Maximum message length increased from 10,000 to 20,000 bytes |
+!> | 2003-11-04 | J. Ator    | Added documentation |
+!> | 2003-11-04 | S. Bender  | Added remarks and routine interdependencies |
+!> | 2003-11-04 | D. Keyser  | MAXJL increased from 15000 to 16000; initialize variable JSR to zero in new COMMON block /BUFRSR/; unified/portable for WRF; added documentation |
+!> | 2004-08-18 | J. Ator    | Added initialization of COMMON /MSGSTD/; maximum message length increased from 20,000 to 50,000 bytes |
+!> | 2005-11-29 | J. Ator    | Added initialization of COMMON /MSGCMP/ and calls to pkvs1 and pkvs01() |
+!> | 2009-03-23 | J. Ator    | Added initialization of COMMON /DSCACH/, COMMON /MSTINF/ and COMMON /TNKRCP/ |
+!> | 2012-09-15 | J. Woollen | Modified for C/I/O/BUFR interface, added initialization of COMMON blocks /ENDORD/ and /BUFRBMISS/ |
+!> | 2014-09-15 | J. Ator    | Change default location of MTDIR |
+!> | 2014-11-18 | J. Ator    | Added initialization of modules MSGLIM and USRINT; remove S01CM initialization |
+!> | 2016-11-29 | J. Ator    | Explicitly initialize BMISS as 10E10_8 |
+!> | 2017-10-13 | J. Ator    | Added initialization of COMMON /TABLEF/ |
+!> | 2019-05-03 | J. Ator    | Change default location of MTDIR |
+!> | 2019-05-09 | J. Ator    | Added dimensions for MSGLEN |
+!> | 2021-03-23 | J. Ator    | Use mtinfo() with MASTER_TABLE_DIR macro from CMake |
 !>
 subroutine bfrini
 

diff --git a/src/blocks.f b/src/blocks.f
@@ -23,10 +23,10 @@
 C> @author J. Woollen
 C> @date 2012-09-15
 C>
-C> @param[in,out] MBAY - integer(*): BUFR message, possibly with
-C>                       added control words on output
-C> @param[in,out] MWRD - integer: Size (in integers) of contents
-C>                       of MBAY
+C> @param[in,out] MBAY -- integer(*): BUFR message, possibly with
+C>                        added control words on output
+C> @param[in,out] MWRD -- integer: Size (in integers) of contents
+C>                        of MBAY
 C>
 C> @remarks
 C> - For more information about IEEE Fortran control words, as
@@ -38,7 +38,9 @@
 C> application program.
 C>
 C> <b>Program history log:</b>
-C> - 2012-09-15  J. Woollen -- Original author
+C> | Date | Programmer | Comments |
+C> | -----|------------|----------|
+C> | 2012-09-15 | J. Ator  | Original author |
 C>
       SUBROUTINE BLOCKS(MBAY,MWRD)
 

diff --git a/src/bort.f b/src/bort.f
@@ -10,15 +10,14 @@
 C> @author J. Woollen
 C> @date 1998-07-08
 C>
-C> @param[in] STR   - character*(*): Error message
+C> @param[in] STR   -- character*(*): Error message
 C>
 C> <b>Program history log:</b>
-C> - 1998-07-08  J. Woollen -- Original author
-C> - 2003-11-04  J. Ator    -- Added documentation; replaced call to
-C>                             intrinsic C routine "exit" with call
-C>                             to bort_exit() to ensure return of
-C>                             non-zero status code
-C> - 2009-04-21  J. Ator    -- Use errwrt()
+C> | Date | Programmer | Comments |
+C> | -----|------------|----------|
+C> | 1998-07-08 | J. Woollen | Original author |
+C> | 2003-11-04 | J. Ator    | Added documentation; replaced call to intrinsic C routine "exit" with call to bort_exit() to ensure return of non-zero status code |
+C> | 2009-04-21 | J. Ator    | Use errwrt() |
 C>
       SUBROUTINE BORT(STR)
 

diff --git a/src/bort2.f b/src/bort2.f
@@ -10,12 +10,14 @@
 C> @author D. Keyser
 C> @date 2003-11-04
 C>
-C> @param[in] STR1   - character*(*): First error message
-C> @param[in] STR2   - character*(*): Second error message
+C> @param[in] STR1  -- character*(*): First error message
+C> @param[in] STR2  -- character*(*): Second error message
 C>
 C> <b>Program history log:</b>
-C> - 2003-11-04  D. Keyser  -- Original author
-C> - 2009-04-21  J. Ator    -- Use errwrt()
+C> | Date | Programmer | Comments |
+C> | -----|------------|----------|
+C> | 2003-11-04 | D. Keyser | Original author |
+C> | 2009-04-21 | J. Ator   | Use errwrt() |
 C>
       SUBROUTINE BORT2(STR1,STR2)
 

diff --git a/src/bort_exit.c b/src/bort_exit.c
@@ -12,10 +12,12 @@
  * @date 2003-11-04
  *
  * <b>Program history log:</b>
- * - 2003-11-04  J. Ator    -- Original author
- * - 2003-11-04  D. Keyser  -- Unified/portable for WRF
- * - 2004-08-18  J. Ator    -- Use bufrlib.h include file
- * - 2007-01-19  J. Ator    -- Fix declaration for ANSI-C
+ * | Date | Programmer | Comments |
+ * | -----|------------|----------|
+ * | 2003-11-04 | J. Ator   | Original author |
+ * | 2003-11-04 | D. Keyser | Unified/portable for WRF |
+ * | 2004-08-18 | J. Ator  | Use bufrlib.h include file |
+ * | 2007-01-19 | J. Ator  | Fix declaration for ANSI-C |
  */
 
 void bort_exit( void )

diff --git a/src/bvers.f.in b/src/bvers.f.in
@@ -8,26 +8,27 @@ C>
 C> @author J. Ator
 C> @date 2009-03-23
 C>
-C> @param[out]    CVERSTR  - character*(*): Version string
+C> @param[out]    CVERSTR -- character*(*): Version string
 C>
 C> <b>Program history log:</b>
-C> - 2009-03-23  J. Ator    -- Original author
-C> - 2011-09-26  J. Ator    -- Updated to version 10.0.1
-C> - 2012-02-24  J. Ator    -- Updated to version 10.1.0
-C> - 2012-10-12  J. Ator    -- Updated to version 10.2.0
-C> - 2012-11-29  J. Ator    -- Updated to version 10.2.1
-C> - 2012-12-04  J. Ator    -- Updated to version 10.2.2
-C> - 2013-01-08  J. Ator    -- Updated to version 10.2.3
-C> - 2013-01-09  J. Ator    -- Updated to version 10.2.4
-C> - 2013-01-25  J. Ator    -- Updated to version 10.2.5
-C> - 2014-11-12  J. Ator    -- Updated to version 11.0.0
-C> - 2015-09-24  J. Ator    -- Updated to version 11.0.1
-C> - 2016-02-12  J. Ator    -- Updated to version 11.0.2
-C> - 2016-03-18  J. Ator    -- Updated to version 11.1.0
-C> - 2016-05-10  J. Ator    -- Updated to version 11.2.0
-C> - 2017-04-03  J. Ator    -- Updated to version 11.3.0
-C> - 2020-10-21  J. Ator    -- Updated to use PROJECT_VERSION
-C>                           macro from CMake
+C> | Date | Programmer | Comments |
+C> | -----|------------|----------|
+C> | 2009-03-23 | J. Ator | Original author |
+C> | 2011-09-26 | J. Ator | Updated to version 10.0.1 |
+C> | 2012-02-24 | J. Ator | Updated to version 10.1.0 |
+C> | 2012-10-12 | J. Ator | Updated to version 10.2.0 |
+C> | 2012-11-29 | J. Ator | Updated to version 10.2.1 |
+C> | 2012-12-04 | J. Ator | Updated to version 10.2.2 |
+C> | 2013-01-08 | J. Ator | Updated to version 10.2.3 |
+C> | 2013-01-09 | J. Ator | Updated to version 10.2.4 |
+C> | 2013-01-25 | J. Ator | Updated to version 10.2.5 |
+C> | 2014-11-12 | J. Ator | Updated to version 11.0.0 |
+C> | 2015-09-24 | J. Ator | Updated to version 11.0.1 |
+C> | 2016-02-12 | J. Ator | Updated to version 11.0.2 |
+C> | 2016-03-18 | J. Ator | Updated to version 11.1.0 |
+C> | 2016-05-10 | J. Ator | Updated to version 11.2.0 |
+C> | 2017-04-03 | J. Ator | Updated to version 11.3.0 |
+C> | 2020-10-21 | J. Ator | Updated to use PROJECT_VERSION macro from CMake |
 C>
 	SUBROUTINE BVERS (CVERSTR)
 

diff --git a/src/cadn30.f b/src/cadn30.f
@@ -12,11 +12,13 @@
 C> @author J. Ator
 C> @date 2004-08-18
 C>
-C> @param[in] IDN - integer: Bit-wise representation of FXY value
-C> @param[out] ADN - character*6: FXY value
+C> @param[in] IDN -- integer: Bit-wise representation of FXY value
+C> @param[out] ADN -- character*6: FXY value
 C>
 C> <b>Program History Log:</b>
-C> - 2004-08-18  J. Ator -- Original author
+C> | Date | Programmer | Comments |
+C> | -----|------------|----------|
+C> | 2004-08-18 | J. Ator | Original author |
 C>
 	SUBROUTINE CADN30( IDN, ADN )
 

diff --git a/src/capit.f b/src/capit.f
@@ -7,12 +7,13 @@
 C> @author J. Woollen
 C> @date 2002-05-14
 C>
-C> @param[in,out] STR - character*(*): String
+C> @param[in,out] STR -- character*(*): String
 C>
 C> <b>Program History Log:</b>
-C> - 2002-05-14  J. Woollen -- Original author
-C> - 2012-03-02  J. Ator    -- Changed name of ups array to upcs to avoid
-C>                             namespace contention with function ups()
+C> | Date | Programmer | Comments |
+C> | -----|------------|----------|
+C> | 2002-05-14 | J. Woollen | Original author |
+C> | 2012-03-02 | J. Ator | Changed name of ups array to upcs to avoid namespace contention with function ups() |
 C>
       SUBROUTINE CAPIT(STR)
 

diff --git a/src/ccbfl.c b/src/ccbfl.c
@@ -13,7 +13,9 @@
  *  @date 2005-11-29
  *
  *  <b>Program history log:</b>
- *  - 2005-11-29  J. Ator    -- Original author
+ * | Date | Programmer | Comments |
+ * | -----|------------|----------|
+ * | 2005-11-29 | J. Ator | Original author |
  */
 void ccbfl( void )
 {

diff --git a/src/chrtrna.f b/src/chrtrna.f
@@ -13,20 +13,22 @@
 C> @author J. Woollen
 C> @date 1994-01-06
 C>
-C> @param[in] CHR     - character(*): Array of characters in ASCII
-C> @param[in] N       - integer: Number of characters to be copied
+C> @param[in] CHR    -- character(*): Array of characters in ASCII
+C> @param[in] N      -- integer: Number of characters to be copied
 C>                      from CHR, starting from the beginning of
 C>                      the array
-C> @param[out] STR    - character*(*): Character string in ASCII or
+C> @param[out] STR   -- character*(*): Character string in ASCII or
 C>                      EBCDIC, depending on native machine
 C>
 C> @remarks
 C> - The determination as to whether the native machine is ASCII or
 C> EBCDIC is made via an internal call to subroutine wrdlen().
 C>
 C> <b>Program history log:</b>
-C> - 1994-01-06  J. Woollen -- Original author
-C> - 2003-11-04  J. Ator    -- Added documentation
+C> | Date | Programmer | Comments |
+C> | -----|------------|----------|
+C> | 1994-01-06 | J. Woollen | Original author |
+C> | 2003-11-04 | J. Ator    | Added documentation |
 C>
       SUBROUTINE CHRTRNA(STR,CHR,N)