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

[Adriaan de Groot]

SVN commit 433141 by adridg:

Dox fixes (of the cut-and-paste-error type) and some
editorialization about default parameter values.
CCMAIL: kstars-devel at kde.org


 M  +6 -2      infoboxes.h  
 M  +3 -0      ksplanet.h  
 M  +4 -2      ksplanetbase.h  


--- trunk/KDE/kdeedu/kstars/kstars/infoboxes.h #433140:433141
@@ -63,7 +63,11 @@
 	*@param colorText The foreground color for infoboxes
 	*@param colorGrab The foreground color for infoboxes, while they are 
 	*"grabbed" by the user
-	*@param colorText The background color for infoboxes
+	*@param colorBG The background color for infoboxes
+	*
+	*@todo Use Qt::white as default color instead of QColor("white"),
+	*      for default values of colorText, colorGrab and colorBG,
+	*      since that's considerably faster.
 	*/
 	InfoBoxes( int w, int h,
 			int tx=0, int ty=0, bool tshade=false,
@@ -88,7 +92,7 @@
 	*@param colorText The foreground color for infoboxes
 	*@param colorGrab The foreground color for infoboxes, while they are 
 	*"grabbed" by the user
-	*@param colorText The background color for infoboxes
+	*@param colorBG The background color for infoboxes
 	*/
 	InfoBoxes( int w, int h,
 			QPoint tp, bool tshade,
--- trunk/KDE/kdeedu/kstars/kstars/ksplanet.h #433140:433141
@@ -45,9 +45,12 @@
 public:
 
 /**Constructor.  
+	*@param kd Some kind of data
 	*@param s Name of planet
 	*@param image_file filename of the planet's image
 	*@param pSize physical diameter of the planet, in km
+	*
+	*@todo figure out what @p kd does.
 	*/
 	KSPlanet( KStarsData *kd, QString s="unnamed", QString image_file="", double pSize=0 );
 
--- trunk/KDE/kdeedu/kstars/kstars/ksplanetbase.h #433140:433141
@@ -73,9 +73,12 @@
 
 /**Constructor.  Calls SkyObject constructor with type=2 (planet),
 	*coordinates=0.0, mag=0.0, primary name s, and all other QStrings empty.
+	@param kd Some kind of data
 	*@param s Name of planet
-	*@param im the planet's image
+	*@param image_file filename of the planet's image
 	*@param pSize the planet's physical size, in km
+	*
+	*@todo Figure out what @p kd does.
 	*/
 	KSPlanetBase( KStarsData *kd, QString s = i18n("unnamed"), QString image_file="", double pSize=0 );
 
@@ -249,7 +252,6 @@
 		QPtrList<SkyPoint>* trail() { return &Trail; }
 
 /**@short adds a point to the planet's trail
-	*@param sp a pointer to the SkyPoint to add (will be AutoDeleted)
 	*/
 		void addToTrail() { Trail.append( new SkyPoint( ra(), dec() ) ); }