[Kstars-devel] KDE/kdeedu/kstars/kstars

[Prakash Mohan]

SVN commit 1001250 by prakash:

Fix some documentation updated descriptions of unclear functions.
Implement a TODO the SunSet was not in minutes, it was a fraction of the day.

CCMAIL: kstars-devel at kde.org, akarshsimha at gmail.com


 M  +1 -1      ksalmanac.cpp  
 M  +4 -14     ksalmanac.h  


--- trunk/KDE/kdeedu/kstars/kstars/ksalmanac.cpp #1001249:1001250
@@ -99,7 +99,7 @@
 double KSAlmanac::sunZenithAngleToTime( double z ) {
     double HA = acos( ( cos( z * dms::DegToRad ) - m_Sun->dec()->sin() * geo->lat()->sin() ) / (m_Sun->dec()->cos() * geo->lat()->cos()) );
     double HASunset = acos( ( -m_Sun->dec()->sin() * geo->lat()->sin() ) / (m_Sun->dec()->cos() * geo->lat()->cos()) );
-    return SunSet + ( HA - HASunset ) * 4.0 * 15.0; // Assumes SunSet is in minutes!! TODO: Fix otherwise
+    return SunSet*24*60 + ( HA - HASunset ) * 4.0 * 15.0;
 }
 */
     
--- trunk/KDE/kdeedu/kstars/kstars/ksalmanac.h #1001249:1001250
@@ -42,7 +42,8 @@
 class KSAlmanac {
  public:
     /**
-     * ??? I have absolutely no clue what this method does and why it takes a SkyObject at all - Akarsh
+     * This function computes the rise and set time for the given SkyObject. This is done in order to 
+     * have a common function for the computation of the Sun and Moon rise and set times.
      */
     void RiseSetTime( SkyObject *o, double *riseTime, double *setTime, QTime *RiseTime, QTime *SetTime );
 
@@ -65,23 +66,12 @@
     static KSAlmanac* Instance();
 
     /**
-     *??? in what units does this return?
+     *All the functions returns the fraction of the day
+     *as their return value
      */
     inline double getSunRise() { return SunRise; }
-    
-    /**
-     *??? in what units does this return?
-     */
     inline double getSunSet() { return SunSet; }
-    
-    /**
-     *??? in what units does this return?
-     */
     inline double getMoonRise() { return MoonRise; }
-    
-    /**
-     *??? in what units does this return?
-     */
     inline double getMoonSet() { return MoonSet; }
     
     inline QTime sunRise() { return SunRiseT; }