Commit Graph

270 Commits

Author SHA1 Message Date
Don Cross
5e755fe894 Fixed warnings found by lgtm. 2019-06-16 13:47:10 -04:00
Don Cross
e9a6c036ab Added comments to a couple of static functions. 2019-06-15 20:38:49 -04:00
Don Cross
18251d16a4 Added another C example program: positions.c.
This example demonstrates how to calculate equatorial coordinates
and horizontal coordinates of solar system bodies.

Added explanatory comments to moonphase.c.

Added #defines for MIN_YEAR, MAX_YEAR in astronomy.h.

Removed unnecessary code from positions.html; no longer need
to calculate geocentric vector before calculating equatorial coordinates.
2019-06-11 20:31:22 -04:00
Don Cross
10f4490047 Make type names larger in their respective section headers. 2019-06-09 13:21:23 -04:00
Don Cross
0dc47d17a7 A couple of minor fixes to C documentation. 2019-06-09 13:15:47 -04:00
Don Cross
067a4e3059 Replace doxygen links in raw Markdown with Markdown links. 2019-06-09 13:05:06 -04:00
Don Cross
50d18825d7 Fixed link syntax in C topic index. 2019-06-09 12:59:53 -04:00
Don Cross
38499434f3 More work on the C documentation topic index.
Added more functions to the topic index.
Use consistent verb tense: "finds", "calculates", etc.
2019-06-09 12:51:27 -04:00
Don Cross
628eb80080 Added "Celestial Bodies" section to C documentation topic index. 2019-06-09 12:28:06 -04:00
Don Cross
663f8cdb49 Added date/time section to C documentation topic index. 2019-06-09 12:22:14 -04:00
Don Cross
92241cb1e7 Documented C functions Astronomy_SearchLunarApsis and Astronomy_NextLunarApsis. 2019-06-09 11:58:47 -04:00
Don Cross
e05b666713 Getting ready to publish npm package v1.0.1. 2019-06-08 22:06:48 -04:00
Don Cross
416c3cfee3 Found a better way to define what files should be published to npm. 2019-06-08 22:00:18 -04:00
Don Cross
ae1c1dd80d Exclude extraneous files from npm package. 2019-06-08 21:51:43 -04:00
Don Cross
dd2f6fb7b1 Added documentation for C function Astronomy_SearchPeakMagnitude. 2019-06-08 21:48:53 -04:00
Don Cross
a9f29f1c52 Added documentation for C function Astronomy_SearchRiseSet.
Added more parameter checking for C and JS versions of that function.
2019-06-08 21:11:39 -04:00
Don Cross
435c1e1533 Added documentation for C function Astronomy_SearchHourAngle.
Also added extra parameter checking in C and JS versions of this function.
2019-06-08 19:57:31 -04:00
Don Cross
f02c523f1b Added documentation for Astronomy_SearchRelativeLongitude.
Also consistently use startTime as the parameter name for the
astro_time_t at which a search is to be started.
2019-06-08 17:35:29 -04:00
Don Cross
1fd7305b92 Documented C functions SearchMoonPhase, SearchMoonQuarter, NextMoonQuarter.
Added parameter checking in NextMoonQuarter.
Fixed typo.
2019-06-06 21:41:02 -04:00
Don Cross
642b1c1748 Documented C function Astronomy_SearchSunLongitude. 2019-06-06 21:04:56 -04:00
Don Cross
b151c2e43d Added npm package 1.0.0 astronomy-engine 2019-06-06 19:52:34 -04:00
Don Cross
fcb04cd40f Fixed #15 - Using Google Closure Compiler to minify astronomy.js. 2019-06-05 20:52:05 -04:00
Don Cross
e0a119426a Correct for aberration when calculating angles seen from Earth.
Resolved FIXFIXFIX comments regarding whether or not to
correct for aberration. In all cases, the observations are
made from the Earth, in which case it makes the most sense
to correct for aberration.
2019-06-05 19:56:41 -04:00
Don Cross
3f60d2fac1 Added documentation for Astronomy_LongitudeFromSun and Astronomy_MoonPhase. 2019-06-05 19:23:25 -04:00
Don Cross
5a1cb85318 Fixed #44 - Renamed relative_longitude to ecliptic_separation.
I was using "relative longitude" to mean two different things.
Resolved the ambiguity by using relative longitude only for
differences in eclitpic longitude as seen from the Sun.

Use "ecliptic separation" for differences in ecliptic longitude
as measured from the Earth.

Fixed completely wrong documentation in the JavaScript code;
it had the meanings backwards inside the ElongationEvent class.
2019-06-05 17:32:23 -04:00
Don Cross
bb6edf67ed Added documentation for Astronomy_SearchMaxElongation.
Also renamed startDate parameters to startTime.
2019-06-05 12:44:36 -04:00
Don Cross
23dfc35177 This should be last attempt to keep Pluto model identical between Linux and Windows. 2019-06-04 20:04:09 -04:00
Don Cross
436d598b76 One more attempt to avoid diff noise in Chebyshev models between Linux and Windows. 2019-06-04 18:29:29 -04:00
Don Cross
c1779c01ae Fixed bug in trimspace.js -- was not working on Linux. 2019-06-04 17:08:23 -04:00
Don Cross
7eb88d30b3 Added documentation for Astronomy_Elongation. Added support for bullet lists. 2019-06-04 11:38:53 -04:00
Don Cross
35dcf2c403 Documented C function Astronomy_AngleFromSun. 2019-06-03 21:47:29 -04:00
Don Cross
83ec1a6b1a Fixed #43 - Trim trailing whitespace from source code before processing it.
This resolves an issue that sometimes messed up generating
markdown from C source code via doxygen and custom script hydrogen.js.
2019-06-03 15:08:10 -04:00
Don Cross
79c3c5a956 Discovered that trailing whitespace causes problems in doxygen on Windows.
I'm not sure exactly whether it is Windows versus Linux,
or just different versions of doxygen, but on my Windows laptop
I was getting messed up doxygen output. It turns out that everything
is back on track once I cleaned up all the trailing whitespace in
template/astronomy.c.  I will need to automate this in the future.
2019-06-03 14:45:40 -04:00
Don Cross
318ea259dc Fixed a typo in the documentation for Astronomy_Seasons. 2019-06-03 14:19:16 -04:00
Don Cross
60e2644f8f Added documentation for C function Astronomy_Seasons.
Also modified hydrogen.js to enclose function parameter names
inside a code block.
2019-06-03 14:13:24 -04:00
Don Cross
bf4ec1b057 Added documentation for C function Astronomy_Search. 2019-06-02 21:07:42 -04:00
Don Cross
a80d4899f3 Added documentation for C function Astronomy_EclipticLongitude. 2019-06-02 16:11:17 -04:00
Don Cross
abda37086d Added documentation for C function Astronomy_Ecliptic. 2019-06-02 16:01:48 -04:00
Don Cross
c03d12952e Eliminate potential thread-safety problem in Astronomy_Ecliptic.
Hardcode the mean obliquity of the ecliptic at J2000 instead of lazy-evaluating it.
This change eliminates a potential thread-safety issue.
2019-06-02 15:44:32 -04:00
Don Cross
1744b7c72e Added documentation for C function Astronomy_SunPosition. 2019-06-02 15:33:12 -04:00
Don Cross
5a9550b8db Added documentation for C function Astronomy_Horizon. 2019-06-02 14:34:53 -04:00
Don Cross
4bb1c73c10 C: replace magic numbers with enumerated types. Added documentation.
The following functions had parameters that accepted cryptic numeric values:

    Astronomy_GeoVector
    Astronomy_Equator
    Astronomy_SearchRiseSet

Replaced such parameters with enumerations. Added the following enumerated types:

    astro_aberration_t
    astro_direction_t
    astro_equator_date_t

Added more C documentation.
2019-06-02 13:34:30 -04:00
Don Cross
2e638da314 More work on C documentation. Tweaks to JS documentation. 2019-06-02 11:45:45 -04:00
Don Cross
1054042330 Added more documentation of C functions. 2019-06-01 22:10:28 -04:00
Don Cross
c6845c2d58 Generate documentation for C typedefs. 2019-06-01 21:00:58 -04:00
Don Cross
5bcaad1ac3 Added tables of contents with links to sections. 2019-06-01 20:27:16 -04:00
Don Cross
ee83dde084 Use code blocks for enum type names. 2019-06-01 20:07:48 -04:00
Don Cross
1091cc9ea7 Nope, trying to add links to enum values did not work. 2019-06-01 19:47:31 -04:00
Don Cross
2153e12181 Experiment with adding intra-document links to enum values.
I have a feeling this won't work, but at least I should try it.
2019-06-01 19:42:06 -04:00
Don Cross
14ba63eab5 hydrogen: Documenting C enumeration types. 2019-06-01 18:24:17 -04:00