X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=simgear%2Fephemeris%2Fephemeris.hxx;h=46029601a14de2532bc793bfaa1cf0babefa412a;hb=a0bdec284624820feb0a96a06c0c38e2f07d5e4e;hp=664b5c5f454d82614fca085af6c2aab598aea503;hpb=65fa6f2f0045a61896c3875d09519407e559aba7;p=simgear.git diff --git a/simgear/ephemeris/ephemeris.hxx b/simgear/ephemeris/ephemeris.hxx index 664b5c5f..46029601 100644 --- a/simgear/ephemeris/ephemeris.hxx +++ b/simgear/ephemeris/ephemeris.hxx @@ -31,10 +31,6 @@ #define _EPHEMERIS_HXX -#ifdef HAVE_CONFIG_H -# include -#endif - #include #include @@ -118,38 +114,38 @@ public: void update(double mjd, double lst, double lat); /** - * Returns a pointer to a Star class containing all the positional + * @return a pointer to a Star class containing all the positional * information for Earth's Sun. */ inline Star *get_sun() const { return our_sun; } - /** Returns the right ascension of the Sun. */ + /** @return the right ascension of the Sun. */ inline double getSunRightAscension() const { return our_sun->getRightAscension(); } - /** Returns the declination of the Sun. */ + /** @return the declination of the Sun. */ inline double getSunDeclination() const { return our_sun->getDeclination(); } /** - * Returns a pointer to a Moon class containing all the positional + * @return a pointer to a Moon class containing all the positional * information for Earth's Moon. */ inline MoonPos *get_moon() const { return moon; } - /** Returns the right ascension of the Moon. */ + /** @return the right ascension of the Moon. */ inline double getMoonRightAscension() const { return moon->getRightAscension(); } - /** Returns the declination of the Moon. */ + /** @return the declination of the Moon. */ inline double getMoonDeclination() const { return moon->getDeclination(); } - /** Returns the numbers of defined planets. */ + /** @return the numbers of defined planets. */ inline int getNumPlanets() const { return nplanets; } /** @@ -158,10 +154,11 @@ public: * the ``sg'' package.) An sgdVec3 is a 3 element double * array. The first element is the right ascension of the planet, * the second is the declination, and the third is the magnitude. + * @return planets array */ inline sgdVec3 *getPlanets() { return planets; } - /** Returns the numbers of defined stars. */ + /** @return the numbers of defined stars. */ inline int getNumStars() const { return stars->getNumStars(); } /** @@ -169,6 +166,7 @@ public: * format. An The first element of the sgdVec3 is the right * ascension of the planet, the second is the declination, and the * third is the magnitude. + * @returns star array */ inline sgdVec3 *getStars() { return stars->getStars(); } };