Clamp pitch values rather than just dumping an error message.

[simgear.git] / simgear / ephemeris / ephemeris.hxx

diff --git a/simgear/ephemeris/ephemeris.hxx b/simgear/ephemeris/ephemeris.hxx
index 6f487c3ea1dbf6d16a0992b0695c9a91f5a75db6..46029601a14de2532bc793bfaa1cf0babefa412a 100644 (file)
--- a/simgear/ephemeris/ephemeris.hxx
+++ b/simgear/ephemeris/ephemeris.hxx
@@ -31,10 +31,6 @@
 #define _EPHEMERIS_HXX
 
 
-#ifdef HAVE_CONFIG_H
-#  include <config.h>
-#endif
-
 #include <plib/sg.h>
 
 #include <simgear/ephemeris/star.hxx>
@@ -50,6 +46,9 @@
 
 
 /** Ephemeris class
+ *
+ * Written by Durk Talsma <d.talsma@direct.a2000.nl> and Curtis Olson
+ * <curt@flightgear.org>
  *
  * Introduction 
  *
@@ -115,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; }
 
     /**
@@ -155,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(); }
 
     /**
@@ -166,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(); }
 };