search

NOAA-EMC / NCEPLIBS-bufr

The NCEPLIBS-bufr library contains routines and utilites for working with the WMO BUFR format.
Other
44 stars 19 forks source link

added module doc #417

Closed edwardhartnett closed 1 year ago

edwardhartnett commented 1 year ago

Part of #397

@jbathegit I forgot to mention this in code review, but we need doxygen documentation for every module as well. Even if it's a repeat of the file documentation block, as in this case.

Doxygen needs a brief description of the module as well as the file.

jbathegit commented 1 year ago

OK, but I don't think the module description should have a @brief tag. That tag should only be in the file documentation block, correct?

How about I try to add a more detailed module description as part of my next PR, rather than just repeating a copy of the same brief description from the file documentation block? Then you could just close this PR.