Commit Graph

7 Commits

Author SHA1 Message Date
Don Cross
cd08fe5402 Eliminate doxygen warnings by pruning Doxyfile.
I use a variety of doxygen versions among the systems
that run the unit tests, including my personal development
systems and GitHub Actions.

Older versions of doxygen complain about options in Doxyfile
they don't know about.

Newer versions of doxygen complain about obsolete options in Doxyfile.

I'm trying to get rid of all these noisy warnings by pruning
all options in Doxyfile that are equivalent to their default
values. I only keep the options that I need to be different
from the default.

Hopefully this quiets down the warnings.
2022-11-02 12:02:31 -04:00
Don Cross
15fefc4922 Windows CI: Upgrade Doxyfile to eliminate warnings. 2022-01-10 16:54:36 -05:00
Don Cross
d0699e828e doxygen: enable more warnings, eliminate unnecessary output.
Tell doxygen to warn (and fail) for undocumented parameters.
Tell doxygen to generate XML only, not LaTeX, HTML, etc.
2020-05-23 13:58:23 -04:00
Don Cross
e3255c7401 Cleaned up and unified Earth and Moon radius constants.
In all 4 supported languages, use consistent constant names for
Earth and Moon radii.

Use Moon's equatorial radius for rise/set timing.

Use Moon's mean radius for calculating Moon's umbra radius for
detecting solar eclipses.

Also use Moon's mean radius for determining whether the Earth's shadow
touches the Moon, for finding lunar eclipses.

Use the Moon's polar radius for distinguishing between total
and annular eclipses, with a 14 meter bias (instead of 1420 meters!)
to match Espenak data.

Use consistent unit test error threshold of 0.57 minutes for rise/set.
Updated demo test data for slight changes to rise/set prediction times.

Updated doxygen options to issue an error on any warnings.
Fixed the incorrect function name link that doxygen was warning me about.
2020-05-23 13:08:25 -04:00
Don Cross
2dc6124f79 Explicitly specify astronomy.c and astronomy.h for doxygen.
I don't want doxygen processing any other files to generate
C documentation. I see that it can pull in .md files, which
could cause problems later.
2019-05-26 20:47:54 -04:00
Don Cross
c5ee9b6830 Starting to get doxygen to work. 2019-05-26 10:09:09 -04:00
Don Cross
6a96c520dd Original generated Doxyfile. 2019-05-26 09:21:18 -04:00