Added review comments

diff --git a/src/map/mapengine.cpp b/src/map/mapengine.cpp
index 748f328..f7c2687 100644 (file)
--- a/src/map/mapengine.cpp
+++ b/src/map/mapengine.cpp
@@ -45,6 +45,10 @@ MapEngine::MapEngine(MapView *mapView, QWidget *parent)
             SLOT(mapImageReceived(QUrl, QPixmap)));
 }
 
+/**
+  * @todo Create URL builder method
+  * QUrl buildURL(zoomLevel, QPoint tileNumbers)
+  */
 void MapEngine::setViewLocation(QPointF latLonCoordinate)
 {
     m_mapView->setZoomLevel(m_zoomLevel);
@@ -59,6 +63,9 @@ void MapEngine::setViewLocation(QPointF latLonCoordinate)
     }
 }
 
+/**
+* @todo Create URL parser methor and refactor code (use pointers for returning)
+*/
 void MapEngine::mapImageReceived(const QUrl &url, const QPixmap &pixmap)
 {
 
@@ -82,6 +89,9 @@ void MapEngine::mapImageReceived(const QUrl &url, const QPixmap &pixmap)
     m_mapScene->addMapTile(mapTile);
 }
 
+/**
+  * @todo QPoint convertLatLonToTile(int zoomLevel, QPointF latLonCoordinate), convert to static
+  */
 QPoint MapEngine::latLonToTile(qreal latitude, qreal longitude, int zoom)
 {
     qDebug() << __PRETTY_FUNCTION__;
@@ -94,6 +104,9 @@ QPoint MapEngine::latLonToTile(qreal latitude, qreal longitude, int zoom)
     return QPoint(qFloor(x*z), qFloor(y*z));
 }
 
+/**
+  * @todo Remove both
+  */
 qreal MapEngine::tileXToLongitude(int x, int zoom)
 {
     qDebug() << __PRETTY_FUNCTION__;

diff --git a/src/map/mapengine.h b/src/map/mapengine.h
index 06dd4a8..2f59db9 100644 (file)
--- a/src/map/mapengine.h
+++ b/src/map/mapengine.h
@@ -58,6 +58,9 @@ public:
     * @param tileNumber x & y numbers of the tile
     * @return QPoint MapScene coordinate
     */
+    /**
+      * @todo use bit shift instead of pow
+      */
     static QPoint convertTileNumberToSceneCoordinate(int zoomLevel, QPoint tileNumber)
     {
         int x = tileNumber.x() * TILE_SIZE_X * pow(2, MAX_ZOOM_LEVEL - zoomLevel);

diff --git a/src/map/mapfetcher.cpp b/src/map/mapfetcher.cpp
index b0befe2..b6f01d0 100644 (file)
--- a/src/map/mapfetcher.cpp
+++ b/src/map/mapfetcher.cpp
@@ -59,6 +59,9 @@ void MapFetcher::fetchMapImage(const QUrl &url)
         startNextDownload();
 }
 
+/**
+  * @todo Return false if image can't be read and do not emit signal
+  */
 bool MapFetcher::loadImageFromCache(const QUrl &url)
 {
     qDebug() << __PRETTY_FUNCTION__;

diff --git a/src/map/mapfetcher.h b/src/map/mapfetcher.h
index 18fa135..b41776d 100644 (file)
--- a/src/map/mapfetcher.h
+++ b/src/map/mapfetcher.h
@@ -43,6 +43,9 @@ class MapFetcher : public QObject
 
 public:
     /**
+      * @todo remove fn:s from comment blocks
+      */
+    /**
     * @brief Constructor for MapFetcher.
     *
     * @fn MapFetcher
@@ -110,7 +113,9 @@ private:
     * @return bool true if image was loaded from cache, false otherwise
     */
     bool loadImageFromCache(const QUrl &url);
-
+/**
+  * @todo add comments for data members
+  */
     QNetworkAccessManager *m_manager;
     QList<QNetworkReply*> currentDownloads;
     QQueue<QUrl> downloadQueue;

diff --git a/src/map/maptile.cpp b/src/map/maptile.cpp
index 7b3306a..0069987 100644 (file)
--- a/src/map/maptile.cpp
+++ b/src/map/maptile.cpp
@@ -43,7 +43,9 @@ void MapTile::setZoomLevel(int zoomLevel)
 {
     m_zoomLevel = zoomLevel;
     setPosition();
-
+/**
+  * @todo use bit shifting
+  */
     double zoomFactor = pow(2, (MapEngine::MAX_ZOOM_LEVEL - m_zoomLevel));
     setScale(zoomFactor);
 }
@@ -61,6 +63,9 @@ void MapTile::setTileNumber(QPoint tileNumber)
 
 void MapTile::setPosition()
 {
+    /**
+      * @todo use bit shifting
+      */
     if ((m_zoomLevel >= MapEngine::MIN_ZOOM_LEVEL) && (m_zoomLevel <= MapEngine::MAX_ZOOM_LEVEL) &&
             (m_tileNumber.x() >= 0) && (m_tileNumber.x() <= pow(2, m_zoomLevel) -1) &&
             (m_tileNumber.y() >= 0) && (m_tileNumber.y() <= pow(2, m_zoomLevel) -1)) {

diff --git a/src/map/mapview.h b/src/map/mapview.h
index fb43d46..2ab7a5b 100644 (file)
--- a/src/map/mapview.h
+++ b/src/map/mapview.h
@@ -40,8 +40,6 @@ public:
     */
     MapView(QWidget *parent = 0);
 
-    /// \brief
-    /// \param zoomLevel
     /**
     * @brief Set zoom level of the view
     *