mirror of
https://github.com/cosinekitty/astronomy.git
synced 2026-01-30 18:21:56 -05:00
5a19727dfe
Certain macros and typedefs were ending up in Doxygen output that have no reason to be documented for outside users. Mostly I used Doxygen conditionals to hide them. In a couple of cases I had some internal functions that needed to be declared static so Doxygen hides them. Added DoxygenLayout.xml, but not using it yet. Still trying to figure out how to make Markdown output that doesn't look terrible. Not sure I can get Moxygen to do what I want. I may have to create my own simple(?) tool.
Summary
| Members | Descriptions |
|---|---|
struct astro_angle_result_t |
An angular value expressed in degrees. |
struct astro_apsis_t |
|
struct astro_ecliptic_t |
|
struct astro_elongation_t |
|
struct astro_equatorial_t |
|
struct astro_func_result_t |
|
struct astro_horizon_t |
|
struct astro_hour_angle_t |
|
struct astro_illum_t |
|
struct astro_moon_quarter_t |
|
struct astro_observer_t |
Represents a location of an observer on (or near) the surface of the Earth. |
struct astro_search_result_t |
|
struct astro_seasons_t |
|
struct astro_time_t |
A date and time used for astronomical calculations. |
struct astro_utc_t |
A calendar date and time expressed in UTC. |
struct astro_vector_t |
A 3D Cartesian vector whose components are expressed in Astronomical Units (AU). |
struct astro_angle_result_t
An angular value expressed in degrees.
Summary
| Members | Descriptions |
|---|---|
public astro_status_t status |
ASTRO_SUCCESS if this struct is valid; otherwise an error code. |
public double angle |
An angle expressed in degrees. |
Members
public astro_status_t status
ASTRO_SUCCESS if this struct is valid; otherwise an error code.
public double angle
An angle expressed in degrees.
struct astro_apsis_t
Summary
| Members | Descriptions |
|---|---|
public astro_status_t status |
|
public astro_time_t time |
|
public astro_apsis_kind_t kind |
|
public double dist_au |
|
public double dist_km |
Members
public astro_status_t status
public astro_time_t time
public astro_apsis_kind_t kind
public double dist_au
public double dist_km
struct astro_ecliptic_t
Summary
| Members | Descriptions |
|---|---|
public astro_status_t status |
|
public double ex |
|
public double ey |
|
public double ez |
|
public double elat |
|
public double elon |
Members
public astro_status_t status
public double ex
public double ey
public double ez
public double elat
public double elon
struct astro_elongation_t
Summary
| Members | Descriptions |
|---|---|
public astro_status_t status |
|
public astro_time_t time |
|
public astro_visibility_t visibility |
|
public double elongation |
|
public double relative_longitude |
Members
public astro_status_t status
public astro_time_t time
public astro_visibility_t visibility
public double elongation
public double relative_longitude
struct astro_equatorial_t
Summary
| Members | Descriptions |
|---|---|
public astro_status_t status |
|
public double ra |
|
public double dec |
|
public double dist |
Members
public astro_status_t status
public double ra
public double dec
public double dist
struct astro_func_result_t
Summary
| Members | Descriptions |
|---|---|
public astro_status_t status |
|
public double value |
Members
public astro_status_t status
public double value
struct astro_horizon_t
Summary
| Members | Descriptions |
|---|---|
public double azimuth |
|
public double altitude |
|
public double ra |
|
public double dec |
Members
public double azimuth
public double altitude
public double ra
public double dec
struct astro_hour_angle_t
Summary
| Members | Descriptions |
|---|---|
public astro_status_t status |
|
public astro_time_t time |
|
public astro_horizon_t hor |
|
public int iter |
Members
public astro_status_t status
public astro_time_t time
public astro_horizon_t hor
public int iter
struct astro_illum_t
Summary
| Members | Descriptions |
|---|---|
public astro_status_t status |
|
public astro_time_t time |
|
public double mag |
|
public double phase_angle |
|
public double helio_dist |
|
public double ring_tilt |
Members
public astro_status_t status
public astro_time_t time
public double mag
public double phase_angle
public double helio_dist
public double ring_tilt
struct astro_moon_quarter_t
Summary
| Members | Descriptions |
|---|---|
public astro_status_t status |
|
public int quarter |
|
public astro_time_t time |
Members
public astro_status_t status
public int quarter
public astro_time_t time
struct astro_observer_t
Represents a location of an observer on (or near) the surface of the Earth.
Summary
| Members | Descriptions |
|---|---|
public double latitude |
Geographic latitude in degrees north (positive) or south (negative) of the equator. |
public double longitude |
Geographic longitude in degrees east (positive) or west (negative) of the prime meridian at Greenwich, England. |
public double height |
The height above (positive) or below (negative) sea level, expressed in meters. |
Members
public double latitude
Geographic latitude in degrees north (positive) or south (negative) of the equator.
public double longitude
Geographic longitude in degrees east (positive) or west (negative) of the prime meridian at Greenwich, England.
public double height
The height above (positive) or below (negative) sea level, expressed in meters.
struct astro_search_result_t
Summary
| Members | Descriptions |
|---|---|
public astro_status_t status |
|
public astro_time_t time |
|
public int iter |
Members
public astro_status_t status
public astro_time_t time
public int iter
struct astro_seasons_t
Summary
| Members | Descriptions |
|---|---|
public astro_status_t status |
|
public astro_time_t mar_equinox |
|
public astro_time_t jun_solstice |
|
public astro_time_t sep_equinox |
|
public astro_time_t dec_solstice |
Members
public astro_status_t status
public astro_time_t mar_equinox
public astro_time_t jun_solstice
public astro_time_t sep_equinox
public astro_time_t dec_solstice
struct astro_time_t
A date and time used for astronomical calculations.
Summary
| Members | Descriptions |
|---|---|
public double ut |
UT1/UTC number of days since noon on January 1, 2000 |
public double tt |
Terrestrial Time days since noon on January 1, 2000 |
Members
public double ut
UT1/UTC number of days since noon on January 1, 2000
public double tt
Terrestrial Time days since noon on January 1, 2000
struct astro_utc_t
A calendar date and time expressed in UTC.
Summary
| Members | Descriptions |
|---|---|
public int year |
The year value, e.g. 2019. |
public int month |
The month value: 1=January, 2=February, ..., 12=December. |
public int day |
The day of the month in the range 1..31. |
public int hour |
The hour of the day in the range 0..23. |
public int minute |
The minute of the hour in the range 0..59. |
public double second |
The floating point number of seconds in the range [0,60). |
Members
public int year
The year value, e.g. 2019.
public int month
The month value: 1=January, 2=February, ..., 12=December.
public int day
The day of the month in the range 1..31.
public int hour
The hour of the day in the range 0..23.
public int minute
The minute of the hour in the range 0..59.
public double second
The floating point number of seconds in the range [0,60).
struct astro_vector_t
A 3D Cartesian vector whose components are expressed in Astronomical Units (AU).
Summary
| Members | Descriptions |
|---|---|
public astro_status_t status |
ASTRO_SUCCESS if this struct is valid; otherwise an error code. |
public double x |
The Cartesian x-coordinate of the vector in AU. |
public double y |
The Cartesian y-coordinate of the vector in AU. |
public double z |
The Cartesian z-coordinate of the vector in AU. |
public astro_time_t t |
The date and time at which this vector is valid. |
Members
public astro_status_t status
ASTRO_SUCCESS if this struct is valid; otherwise an error code.
public double x
The Cartesian x-coordinate of the vector in AU.
public double y
The Cartesian y-coordinate of the vector in AU.
public double z
The Cartesian z-coordinate of the vector in AU.
public astro_time_t t
The date and time at which this vector is valid.
Generated by Moxygen