Added missing comments
authorSami Rämö <sami.ramo@ixonos.com>
Mon, 19 Jul 2010 12:29:05 +0000 (15:29 +0300)
committerSami Rämö <sami.ramo@ixonos.com>
Mon, 19 Jul 2010 12:29:05 +0000 (15:29 +0300)
src/coordinates/geocoordinate.h
src/coordinates/scenecoordinate.h

index b684e45..1406de1 100644 (file)
@@ -126,6 +126,11 @@ private:
  * DATA MEMBERS
  ******************************************************************************/
 private:
+    /**
+    * @enum ValidityFlag
+    *
+    * @brief Flag values for coordinate validity
+    */
     enum ValidityFlag {
         NoCoordinatesSet = 0x0,
         LatitudeSet = 0x1,
@@ -141,7 +146,20 @@ private:
  * OPERATORS
  ******************************************************************************/
 public:
+    /**
+    * @brief Output operator
+    *
+    * @param out Output stream
+    * @param coordinate Coordinate object which is written to the stream
+    */
     friend QDataStream &operator<<(QDataStream &out, const GeoCoordinate &coordinate);
+
+    /**
+    * @brief Input operator
+    *
+    * @param in Input stream
+    * @param coordinate Object where the values from the stream are saved
+    */
     friend QDataStream &operator>>(QDataStream &in, GeoCoordinate &coordinate);
 };
 
index 1caf745..b1c41c8 100644 (file)
@@ -83,6 +83,11 @@ public:
     */
     void setY(double y);
 
+    /**
+    * @brief Convert to QPointF
+    *
+    * @returns a QPointF object
+    */
     QPointF toPointF() const;
 
     /**