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

[Adriaan de Groot]

SVN commit 433031 by adridg:

Dox fixes. Remember all parameters should be documented (or none
at all, but that's not a good choice). See
http://www.englishbreakfastnetwork.org/apidocs/kdeedu.log
for kdeedu dox error log -- most of them are KStars oriented.

CCMAIL: kstars-devel at kde.org


 M  +6 -4      dmsbox.h  
 M  +2 -0      infobox.h  
 M  +6 -0      infoboxes.h  


--- trunk/KDE/kdeedu/kstars/kstars/dmsbox.h #433030:433031
@@ -46,10 +46,10 @@
 
 public:
 	/**Constructor for the dmsBox object.
-		*@p parent pointer to the parent QWidget
-		*@p ni the name of the object
-		*@p deg if TRUE use deg/arcmin/arcsec; otherwise 
-		*use hours/min/sec.
+		*@param parent pointer to the parent QWidget
+		*@param ni the name of the object
+		*@param deg if TRUE use deg/arcmin/arcsec; otherwise 
+		*           use hours/min/sec.
 		*/
 	dmsBox(QWidget *parent, const char *ni=0, bool deg=TRUE);
 
@@ -106,6 +106,8 @@
 		*or colons) representing deg/hrs, min, sec.  It is also possible to have two
 		*fields.  In this case, if the second field is a double, it is converted
 		*to decimal min and double sec.
+		*@param deg if TRUE use deg/arcmin/arcsec; otherwise 
+		*           use hours/min/sec.
 		*@param ok set to true if a dms object was succedssfully created.
 		*@return a dms object constructed from the fields of the dmsbox
 		*/
--- trunk/KDE/kdeedu/kstars/kstars/infobox.h #433030:433031
@@ -46,6 +46,7 @@
 	/**General constructor.  Specify The text string, x,y position and size.
 		*@param x the X-coordinate for the box
 		*@param y the Y-coordinate for the box
+		*@param shade if TRUE, apply text shading as well
 		*@param t1 The first line of text
 		*@param t2 The second line of text
 		*@param t3 The third line of text
@@ -56,6 +57,7 @@
 		*This behaves just like the above function.  It differs only in the data types
 		*of its arguments.
 		*@param p The (x,y) position of the box
+		*@param shade if TRUE, apply text shading as well
 		*@param t1 The first line of text
 		*@param t2 The second line of text
 		*@param t3 The third line of text
--- trunk/KDE/kdeedu/kstars/kstars/infoboxes.h #433030:433031
@@ -53,10 +53,13 @@
 	*(typically the height of the SkyMap)
 	*@param tx the x-position of the Time infobox
 	*@param ty the y-position of the Time infobox
+	*@param tshade if TRUE, apply text shading to the Time infobox
 	*@param gx the x-position of the Geographic infobox
 	*@param gy the y-position of the Geographic infobox
+	*@param gshade if TRUE, apply text shading to the Geographic infobox
 	*@param fx the x-position of the Focus-object infobox
 	*@param fy the y-position of the Focus-object infobox
+	*@param fshade if TRUE, apply text shading to the Focus-object infobox
 	*@param colorText The foreground color for infoboxes
 	*@param colorGrab The foreground color for infoboxes, while they are 
 	*"grabbed" by the user
@@ -77,8 +80,11 @@
 	*@param h The height of the region in which the boxes can be drawn 
 	*(typically the height of the SkyMap)
 	*@param tp the position of the Time infobox
+	*@param tshade if TRUE, apply text shading to the Time infobox
 	*@param gp the position of the Geographic infobox
+	*@param gshade if TRUE, apply text shading to the Geographic infobox
 	*@param fp the position of the Focus-object infobox
+	*@param fshade if TRUE, apply text shading to the Focus-object infobox
 	*@param colorText The foreground color for infoboxes
 	*@param colorGrab The foreground color for infoboxes, while they are 
 	*"grabbed" by the user