Documenting doxygen style. Removed census.h and census.cpp

census.cpp

@@ -1,49 +0,0 @@
-#include "census.h"
-#include <QFile>
-#include <QJsonDocument>
-#include <QJsonArray>
-#include <QJsonObject>
-#include <qDebug>
-
-
-///
-/// \brief
-/// Census::readDataFromFile - Populates the Census object with data from a file.
-/// at the end we should have Map with (key,value) = (city name, some metric).
-/// \param fileName: name of the JSON file
-/// \return true if the file was openned and read
-///
-bool Census::readDataFromFile(QString fileName) {
-    QFile loadFile(fileName);
-
-    if (!loadFile.open(QIODevice::ReadOnly)) {
-        qWarning("Couldn't open save file.");
-        return false;
-    }
-
-    QByteArray saveData = loadFile.readAll();
-    QJsonDocument loadDoc(QJsonDocument::fromJson(saveData));
-    QJsonArray topLevelArray = loadDoc.array();
-
-    int ctr = 1;
-
-    minValue = maxValue = topLevelArray[0].toObject()["percent_change"].toDouble();
-
-    foreach(QJsonValue obj, topLevelArray) {
-        double value = obj.toObject()["percent_change"].toDouble();
-        (*this)[obj.toObject()["city"].toString()] =  value;
-        if (value > maxValue) maxValue = value;
-        if (value < minValue) minValue = value;
-
-        ctr++;
-    }
-
-    Census::iterator it = this->begin();
-
-    for (; it != this->end(); ++it)
-        qDebug() << it.key() << it.value();
-
-    factor = 128.0 / (maxValue - minValue) ;
-
-}
-

census.h

@@ -1,19 +0,0 @@
-#ifndef CENSUS_H
-#define CENSUS_H
-
-#include <QString>
-#include <QMap>
-
-///
-/// \brief The Census class
-///
-class Census : public QMap<QString, double> {
-
-public:
-    bool readDataFromFile(QString fileName);
-    double minValue, maxValue, factor, negFactor;
-};
-
-
-
-#endif // CENSUS_H

country.cpp

@@ -8,9 +8,6 @@
 void Country::limits(){
     QMap<QString,City*>::iterator it = Cities.begin();
 
-
-
-
     minX = maxX = Cities.begin().value()->geometry->at(0).x;
     minY = maxY = Cities.begin().value()->geometry->at(0).y;
 
@@ -50,7 +47,7 @@ void Country::topLeft(QString &st, DoublePoint &p ) {
     }
 }
 unsigned long  *colorMap;
-bool Country::readInfoFromJSON(QString fileName) {
+bool Country::readInfoFromJSON(const QString &fileName) {
     QFile loadFile(fileName);
 
     if (!loadFile.open(QIODevice::ReadOnly)) {

country.h

@@ -6,19 +6,61 @@
 #include <QMap>
 
 
-///
-/// \brief The Country class
-///        A map of (city name, city structure)
-///
+/// A class to display a map of a country, given the coordinates
+/// that define its limits.
+
 class Country {
+private:
 public:
     QMap<QString,City*> Cities;
-
     double minX, minY, maxX, maxY;
+
+    /// \fn Country()
+    /// \~English
+    /// \brief default constructor
+    /// \~Spanish
+    /// \brief default constructor
+    ///
     Country() {}
-    bool readInfoFromJSON(QString fileName);
+
+    /// \fn bool readInfoFromJSON(QString fileName)
+    /// \~English
+    /// \brief Reads a json file that contains the polygons for the
+    ///        various parts of the country (e.g., cities)
+    /// \param fileName name of the json file
+    /// \~Spanish
+    /// \brief Lee un archivo en formato json que contiene los polígonos
+    ///        the los componentes del mapa del pais (e.g. las ciuidades)
+    /// \param fileName nombre del archivo en formato json
+    ///
+    bool readInfoFromJSON(const QString &fileName);
+
+    /// \fn topLeft(QString &st, DoublePoint &p );
+    /// \~English
+    /// \brief ??
+    /// \param ??
+    /// \~Spanish
+    /// \brief ??
+    /// \param ??
+    ///
     void topLeft(QString &st, DoublePoint &p );
+
+    /// \fn void limits();
+    /// \~English
+    /// \brief ??
+    /// \param ??
+    /// \~Spanish
+    /// \brief ??
+    /// \param ??
+    ///
     void limits();
+
+    /// \fn QMap<QString,City*> getCities()
+    /// \~English
+    /// \brief gets the Cities map structure.
+    /// \~Spanish
+    /// \brief consigue la estructura de mapa de Cities.
+    ///
     QMap<QString,City*> getCities() { return Cities;}
     //~Country() { delete Cities; }
 };

doublepoint.h

@@ -1,14 +1,28 @@
 #ifndef DOUBLEPOINT_H
 #define DOUBLEPOINT_H
 
+/// A class to display to store an x, y coordinate of type double.
+///
 class DoublePoint {
 public:
     double x, y;
+
+    /// \fn DoublePoint()
+    /// \~English
+    /// \brief default constructor
+    /// \~Spanish
+    /// \brief constructor por defecto
+    ///
     DoublePoint() {x = 0; y = 0;}
-    DoublePoint(double a, double b) {
-        x = a; y = b;
-    }
 
+
+    /// \fn DoublePoint(double xp, double yp)
+    /// \~English
+    /// \brief constructor that sets the coordinates
+    /// \~Spanish
+    /// \brief constructor que setea las coordenadas
+    ///
+    DoublePoint(double xp, double yp) { x = xp; y = yp; }
 };
 
 #endif // DOUBLEPOINT_H

gispoi.h

@@ -10,42 +10,123 @@ using namespace std;
 const double EARTH_RADIUS =  6372.8;
 const double TWOPI = 2 * acos(-1);
 
+///
+/// \brief deg2rad
+/// \~English
+/// \param deg angle in degrees
+/// \return angle in radians
+/// \~Spanish
+/// \param deg ángulo en grados
+/// \return angle ángulo en radianes
+///
 inline double deg2rad(double deg) {
     return deg/360.0 * TWOPI;
 }
 
 
-class GISPOI
-{
+///
+/// \brief This class is for representing GIS points of interests.
+///
+
+class GISPOI {
 private:
     QString name;
     double lat, lon;
 
 public:
+
+    /// \fn GISPOI()
+    /// \~English
+    /// \brief default constructor
+    /// \~Spanish
+    /// \brief constructor por defecto
+    ///
     GISPOI();
-    GISPOI(QString s, double latitude, double longitude) 
+
+    /// \fn GISPOI(const QString &s, double latitude, double longitude)
+    /// \~English
+    /// \brief constructor that sets all the data members.
+    /// \~Spanish
+    /// \brief constructor que asigna valores a los miembros de data.
+    ///
+    GISPOI(const QString &s, double latitude, double longitude)
         {name = s; lat = latitude; lon = longitude;}
 
-    double getLat()   const {return lat;}
-    double getLon()   const {return lon;}
+
+    /// \fn double getLat()
+    /// \~English
+    /// \brief getter for the latitude
+    /// \return the latitude value
+    /// \~Spanish
+    /// \brief "getter" para el valor de latitud
+    /// \return el valor de la latitud
+    ///
+    double getLat() const {return lat;}
+
+    /// \fn double getLon()
+    /// \~English
+    /// \brief getter for the longitude
+    /// \return the longitude value
+    /// \~Spanish
+    /// \brief "getter" para el valor de longitud
+    /// \return el valor de la longitud
+    ///
+    double getLon() const {return lon;}
+
+    /// \fn QString getName()
+    /// \~English
+    /// \brief getter for the name
+    /// \return a copy of the name
+    /// \~Spanish
+    /// \brief "getter" para el nombre
+    /// \return una copia del nombre
+    ///
     QString getName() const {return name;}
     
+    /// \fn setAll(const QString &s, double latitude, double longitude)
+    /// \~English
+    /// \brief setter for all data members
+    /// \~Spanish
+    /// \brief "setter" para todos los miembros de datos
+    ///
     void setAll(QString s, double latitude, double longitude)
         {name = s; lat = latitude; lon = longitude;}
+
+    /// \fn setAll(const string &s, double latitude, double longitude)
+    /// \~English
+    /// \brief setter for all data members
+    /// \~Spanish
+    /// \brief "setter" para todos los miembros de datos
+    ///
     void setAll(string s, double latitude, double longitude) 
         {name = QString::fromStdString(s); lat = latitude; lon = longitude;}
     
+
+    /// \fn print()
+    /// \~English
+    /// \brief a utility function to print the data members
+    /// \~Spanish
+    /// \brief imprime los valores de los miembros de datos
+    ///
     void print() {
         qDebug() << name << " " << lat  << " "
              << lon << endl;
     }
 
-    double odDistance(const GISPOI &B) const;
-// Function odDistance(A,B)
-// Given two objects A and B of type GISPOI, uses their longitudes and
-// latitudes to compute and return their orthodromic distance in kilometers.
 
- 
+    /// \fn print()
+    /// \~English
+    /// \brief Given two objects A and B of class GISPOI, uses their
+    ///        longitudes and latitudes to compute and return their orthodromic
+    ///        distance in kilometers.
+    /// \returns orthodromic distance in kilometers
+    /// \~Spanish
+    /// \brief Dados dos objetos A y B de clase GISPOI, usa sus
+    ///        longitudes and latitudes para determinar y devolver distancia
+    ///        ortodrómica en kilómetros.
+    /// \returns distancia ortodrómica en kilómetros
+    ///
+    double odDistance(const GISPOI &B) const;
 
 };