Skip to content

Commit

Permalink
apidoc edits and site update
Browse files Browse the repository at this point in the history
  • Loading branch information
attipaci committed Nov 11, 2024
1 parent 4e8e46e commit ffbf208
Show file tree
Hide file tree
Showing 8 changed files with 23 additions and 10 deletions.
1 change: 1 addition & 0 deletions include/solarsystem.h
Original file line number Diff line number Diff line change
Expand Up @@ -173,6 +173,7 @@ typedef short (*novas_planet_provider_hp)(const double jd_tdb[2], enum novas_pla
* @sa set_ephem_provider()
* @sa ephemeris()
* @sa NOVAS_EPHEM_OBJECT
* @sa solsys-ephem.c
*
* @since 1.0
* @author Attila Kovacs
Expand Down
1 change: 1 addition & 0 deletions src/novas.c
Original file line number Diff line number Diff line change
Expand Up @@ -5636,6 +5636,7 @@ double ira_equinox(double jd_tdb, enum novas_equinox_type equinox, enum novas_ac
* @sa set_planet_provider()
* @sa set_planet_provider_hp()
* @sa ephemeris()
* @sa solsys-ephem.c
*
*/
int set_ephem_provider(novas_ephem_provider func) {
Expand Down
1 change: 1 addition & 0 deletions src/solsys-calceph.c
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
* <li>CALCEPH source code is at https://gitlab.obspm.fr/imcce_calceph/calceph</li>
* </ol>
*
* @sa solarsystem.h
* @sa solsys-cspice.c
*/

Expand Down
1 change: 1 addition & 0 deletions src/solsys-cspice.c
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
* <li>the Smithsonian/cspice-sharedlib repository: https://github.com/Smithsonian/cspice-sharedlib</li>
* </ol>
*
* @sa solarsystem.h
* @sa solsys-calceph.c
*/

Expand Down
5 changes: 3 additions & 2 deletions src/solsys-ephem.c
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,9 @@
* @date Created on Jan 29, 2024
* @author Attila Kovacs
*
* @sa solsys1.c
* @sa solsys2.c
* @sa solarsystem.h
* @sa solsys-calceph.c
* @sa solsys-cspice.c
*/

#include <errno.h>
Expand Down
16 changes: 10 additions & 6 deletions src/solsys1.c
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,13 @@
* @author G. Kaplan and A. Kovacs
*
* SuperNOVAS major planet ephemeris lookup implementation using JPL 1997 ephemeris data, to be
* used together with eph_manager.c. A more generic solution is to implement a
* novas_ephem_provider (e.g. relying on the current version of the CSPICE library) and set it as
* the default ephemeris handler via set_ephem_provider(), and then use solsys-ephem.c instead to
* use the same implementation for major planets.
* used together with eph_manager.c. This is a legacy API, maiunly for supporting older code
* written for NOVAS C.
*
* A more generic solution is to implement a novas_ephem_provider (e.g. relying on the current
* version of the CSPICE library) and set it as the default ephemeris handler via
* set_ephem_provider(), and then use solsys-ephem.c instead to use the same implementation for
* major planets.
*
* Based on the NOVAS C Edition, Version 3.1:
*
Expand All @@ -17,8 +20,9 @@
* <a href="http://www.usno.navy.mil/USNO/astronomical-applications">
* http://www.usno.navy.mil/USNO/astronomical-applications</a>
*
* @sa solsys-ephem.c
* @sa solsys1.c
* @sa solarsystem.h
* @sa solsys-calceph.c
* @sa solsys-cspice.c
*/

#include <errno.h>
Expand Down
5 changes: 3 additions & 2 deletions src/solsys2.c
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,9 @@
* <a href="http://www.usno.navy.mil/USNO/astronomical-applications">
* http://www.usno.navy.mil/USNO/astronomical-applications</a>
*
* @sa solsys-ephem.c
* @sa solsys1.c
* @sa solarsystem.h
* @sa solsys-calceph.c
* @sa solsys-cspice.c
*/

#include <errno.h>
Expand Down
3 changes: 3 additions & 0 deletions src/solsys3.c
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,9 @@
* <a href="http://www.usno.navy.mil/USNO/astronomical-applications">
* http://www.usno.navy.mil/USNO/astronomical-applications</a>
*
* @sa solarsystem.h
* @sa solsys-calceph.c
* @sa solsys-cspice.c
* @sa solsys-ephem.c
*/

Expand Down

0 comments on commit ffbf208

Please sign in to comment.