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

Documentation improvements #398

Closed edwardhartnett closed 1 year ago

edwardhartnett commented 1 year ago

Part of #397

Documentation improvements. No code changes or new tests in this PR, just documentation.

edwardhartnett commented 1 year ago

OK, I have discovered that if we say "@ref moda_tababd" instead of just "tababd", then doxygen generates a nice link to that module.

So for example:

C> This subroutine initializes the internal arrays
C> (in module @ref moda_tababd) holding the DX BUFR table. It then

The second line generates a link to the documentation for moda_tababd, which is very helpful.

I have made this change for most or all of the existing references to modules in the documentation, but if you see one that is not referenced, or add new documentation referencing modules, then please use this notation to generate the hyperlink in the doxygen output.

jbathegit commented 1 year ago

The @ref feature is a nice touch for the modules, so thanks for figuring that out!

FWIW, I'd only been using @ref previously to reference other points in the documentation that had already been tagged using @anchor. So this is good to know that it works automatically for defined modules!