Added comments to gps classes.

diff --git a/src/gps/gpsposition.h b/src/gps/gpsposition.h
index 5c38c2a..329cef7 100644 (file)
--- a/src/gps/gpsposition.h
+++ b/src/gps/gpsposition.h
@@ -32,7 +32,7 @@ QTM_USE_NAMESPACE
 /**
 * @brief GPSPosition class use GPS to receive location information.
 *
-* @class GPSPosition engine.h "gps/gpsposition.h"
+* @class GPSPosition gpsposition.h "gps/gpsposition.h"
 */
 class GPSPosition : public GPSPositionInterface
 {
@@ -106,6 +106,6 @@ private:
     int m_updateInterval;                       ///< GPS update interval
 };
 
-const int DEFAULT_UPDATE_INTERVAL = 5000;   ///< Default update interval
+const int DEFAULT_UPDATE_INTERVAL = 5000;       ///< Default update interval
 
 #endif // GPSPOSITION_H

diff --git a/src/gps/gpspositioninterface.h b/src/gps/gpspositioninterface.h
index 99b1a2a..28aa234 100644 (file)
--- a/src/gps/gpspositioninterface.h
+++ b/src/gps/gpspositioninterface.h
@@ -25,16 +25,33 @@
 #include <QObject>
 #include <QPointF>
 
+/**
+* @brief GPSPositionInterface class is a interface to GPS.
+*
+* @class GPSPosition gpspositioninterface.h "gps/gpspositioninterface.h"
+*/
 class GPSPositionInterface : public QObject
 {
     Q_OBJECT
 
 public:
 
+    /**
+    * @brief Constructor.
+    *
+    * @param parent QObject
+    */
     GPSPositionInterface(QObject *parent = 0);
 
+    /**
+    * @brief Destructor.
+    */
     virtual ~GPSPositionInterface();
 
+/******************************************************************************
+* MEMBER FUNCTIONS AND SLOTS
+******************************************************************************/
+public:
     /**
     * @brief Checks if GPS is running.
     *
@@ -70,6 +87,13 @@ private slots:
 ******************************************************************************/
 signals:
     /**
+    * @brief Signal for error.
+    *
+    * @param message error message
+    */
+    void error(const QString &message);
+
+    /**
     * @brief Signal for position information.
     *
     * @param latLonCoordinate latitude and longitude values
@@ -80,13 +104,6 @@ signals:
     * @brief Signal for timeout.
     */
     void timeout();
-
-    /**
-    * @brief Signal for error.
-    *
-    * @param message error message
-    */
-    void error(const QString &message);
 };
 
 #endif // GPSPOSITIONINTERFACE_H

diff --git a/src/gps/gpspositionmockup.h b/src/gps/gpspositionmockup.h
index e3722c6..5191fb9 100644 (file)
--- a/src/gps/gpspositionmockup.h
+++ b/src/gps/gpspositionmockup.h
@@ -24,20 +24,27 @@
 
 #include "gpspositioninterface.h"
 
+/**
+* @brief GPSPositionMockup class does nothing.
+*
+* Class is used when compiling in desktop.
+*
+* @class GPSPosition gpspositionmockup.h "gps/gpspositionmockup.h"
+*/
 class GPSPositionMockup : public GPSPositionInterface
 {
     Q_OBJECT
 
 public:
     /**
-    * @brief Constructor creates GPS source.
+    * @brief Constructor.
     *
     * @param parent QObject
     */
     GPSPositionMockup(QObject *parent = 0);
 
     /**
-    * @brief Destructor stops GPS.
+    * @brief Destructor.
     */
     ~GPSPositionMockup();
 
@@ -48,28 +55,39 @@ public:
     /**
     * @brief Checks if GPS is running.
     *
+    * RETURNS FALSE.
     * @return true if GPS running, false otherwise
     */
     bool isRunning();
 
     /**
-    * @brief Set GPS update interval
+    * @brief Set GPS update interval.
     *
+    * DOES NOTHING.
     * @return interval interval in milliseconds
     */
     void setUpdateInterval(int interval);
 
     /**
     * @brief Start GPS.
+    *
+    * DOES NOTHING.
     */
     void start();
 
     /**
     * @brief Stop GPS.
+    *
+    * DOES NOTHING.
     */
     void stop();
 
 private slots:
+    /**
+    * @brief Slot for GPS update request.
+    *
+    * DOES NOTHING.
+    */
     void update();
 };