[prev in list] [next in list] [prev in thread] [next in thread] 

List:       kde-commits
Subject:    KDE/kdeedu/kstars/kstars/skycomponents
From:       Akarsh Simha <akarshsimha () gmail ! com>
Date:       2010-08-28 18:57:26
Message-ID: 20100828185726.67D5EAC86C () svn ! kde ! org
[Download RAW message or body]

SVN commit 1169229 by asimha:

Add some documentation to methods in DeepStarComponent

 M  +13 -0     deepstarcomponent.h  


--- trunk/KDE/kdeedu/kstars/kstars/skycomponents/deepstarcomponent.h #1169228:1169229
@@ -66,12 +66,25 @@
 
     bool openDataFile();
 
+    /**
+     *@return true if this DeepStarComponent has static stars (that are not dynamically loaded)
+     */
     inline bool hasStaticStars() { return staticStars; }
 
+    /**
+     *@return return the estimated faint magnitude limit of this DeepStarComponent
+     */
     float faintMagnitude() const { return m_FaintMagnitude; }
 
+    /**
+     *@param HDnum Henry-Draper catalog number of the desired star
+     *@return A star matching the given Henry-Draper catalog number
+     */
     SkyObject* findByHDIndex( int HDnum );
 
+    /**
+     *@return Nearest star within maxrad of SkyPoint p, or NULL if not found
+     */
     SkyObject* objectNearest(SkyPoint *p, double &maxrad );
 
     inline bool fileOpen() { return fileOpened; }
[prev in list] [next in list] [prev in thread] [next in thread]