more documentation, including for all modv files #124
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I know this is a lot of files, but it's all documentation enhancements, and more than half of the changed files are modv files which only define a single global parameter and thus are very short in length.
What's particularly neat about this commit is that I figured out how to implement the Doxygen @var tag, which creates a global reference to a particular variable name and also generates very nicely-formatted tables for modules. For examples of what this looks like in Doxygen, see my sample web site at https://emc.ncep.noaa.gov/emc/pages/infrastructure/bufrlib_jeff/html/index.html, then click on the "Files" tab, then click on some of the changed files such as cfe.h, moda_bitmaps.F, moda_tababd.F, or any of the modv_*.F files. All variables defined by these @var tags also end up getting added to a master global catalog, which you can see if you go to the "Main Page" tab, then click on "Data Types List", then click on "Data Fields", then click either "All" or "Variables".
Let me know if any questions - thanks!