Removed a bunch of silly documentation

A C++ developer should be able to recognize a constructor and a
destructor by just looking at it, so let's stop writing down the
obvious. :)

12 files changed, 5 insertions, 117 deletions

diff --git a/src/dal/dalexcept.h b/src/dal/dalexcept.h
index 1ad36df..bf20282 100644
--- a/src/dal/dalexcept.h
+++ b/src/dal/dalexcept.h
@@ -43,9 +43,6 @@ class DbException: public std::exception
                 : mMsg(msg)
         {}
 
-        /**
-         * Destructor.
-         */
         ~DbException()
             throw()
         {}
diff --git a/src/dal/dataprovider.cpp b/src/dal/dataprovider.cpp
index 684c255..a88e205 100644
--- a/src/dal/dataprovider.cpp
+++ b/src/dal/dataprovider.cpp
@@ -54,9 +54,6 @@ void PerformTransaction::commit()
 }
 
 
-/**
- * Constructor.
- */
 DataProvider::DataProvider()
     throw()
         : mIsConnected(false),
@@ -64,9 +61,6 @@ DataProvider::DataProvider()
 {
 }
 
-/**
- * Destructor.
- */
 DataProvider::~DataProvider()
     throw()
 {
diff --git a/src/dal/dataproviderfactory.cpp b/src/dal/dataproviderfactory.cpp
index 96f4e8e..d8c44f0 100644
--- a/src/dal/dataproviderfactory.cpp
+++ b/src/dal/dataproviderfactory.cpp
@@ -37,25 +37,16 @@
 namespace dal
 {
 
-
-/**
- * Default constructor.
- */
 DataProviderFactory::DataProviderFactory()
     throw()
 {
 }
 
-
-/**
- * Destructor.
- */
 DataProviderFactory::~DataProviderFactory()
     throw()
 {
 }
 
-
 /**
  * Create a data provider.
  */
@@ -73,5 +64,4 @@ DataProvider *DataProviderFactory::createDataProvider()
 #endif
 }
 
-
 } // namespace dal
diff --git a/src/dal/dataproviderfactory.h b/src/dal/dataproviderfactory.h
index 5ae7799..5cceeac 100644
--- a/src/dal/dataproviderfactory.h
+++ b/src/dal/dataproviderfactory.h
@@ -49,9 +49,6 @@ class DataProviderFactory
         DataProviderFactory()
             throw();
 
-        /**
-         * Destructor.
-         */
         ~DataProviderFactory()
             throw();
 
diff --git a/src/dal/mysqldataprovider.cpp b/src/dal/mysqldataprovider.cpp
index c1f4573..1303646 100644
--- a/src/dal/mysqldataprovider.cpp
+++ b/src/dal/mysqldataprovider.cpp
@@ -37,9 +37,6 @@ const std::string  MySqlDataProvider::CFGPARAM_MYSQL_DB_DEF   = "mana";
 const std::string  MySqlDataProvider::CFGPARAM_MYSQL_USER_DEF = "mana";
 const std::string  MySqlDataProvider::CFGPARAM_MYSQL_PWD_DEF  = "mana";
 
-/**
- * Constructor.
- */
 MySqlDataProvider::MySqlDataProvider()
     throw()
         : mDb(0),
@@ -49,10 +46,6 @@ MySqlDataProvider::MySqlDataProvider()
 {
 }
 
-
-/**
- * Destructor.
- */
 MySqlDataProvider::~MySqlDataProvider()
     throw()
 {
@@ -65,7 +58,6 @@ MySqlDataProvider::~MySqlDataProvider()
         disconnect();
 }
 
-
 /**
  * Get the database backend name.
  */
@@ -75,7 +67,6 @@ DbBackends MySqlDataProvider::getDbBackend() const
     return DB_BKEND_MYSQL;
 }
 
-
 /**
  * Create a connection to the database.
  */
@@ -136,13 +127,11 @@ void MySqlDataProvider::connect()
     LOG_INFO("Connection to mySQL was sucessfull.");
 }
 
-
 /**
  * Execute a SQL query.
  */
-const RecordSet&
-MySqlDataProvider::execSql(const std::string& sql,
-                           const bool refresh)
+const RecordSet &MySqlDataProvider::execSql(const std::string& sql,
+                                            const bool refresh)
 {
     if (!mIsConnected)
         throw std::runtime_error("not connected to database");
@@ -197,7 +186,6 @@ MySqlDataProvider::execSql(const std::string& sql,
     return mRecordSet;
 }
 
-
 /**
  * Close the connection to the database.
  */
diff --git a/src/dal/mysqldataprovider.h b/src/dal/mysqldataprovider.h
index a35d35e..945b284 100644
--- a/src/dal/mysqldataprovider.h
+++ b/src/dal/mysqldataprovider.h
@@ -53,15 +53,9 @@ class MySqlDataProvider: public DataProvider
             AUTOCOMMIT_ON = 1
         };
 
-        /**
-         * Constructor.
-         */
         MySqlDataProvider()
             throw();
 
-        /**
-         * Destructor.
-         */
         ~MySqlDataProvider()
             throw();
 
diff --git a/src/dal/pqdataprovider.cpp b/src/dal/pqdataprovider.cpp
index 5351b0c..1ba62f2 100644
--- a/src/dal/pqdataprovider.cpp
+++ b/src/dal/pqdataprovider.cpp
@@ -24,20 +24,12 @@
 namespace dal
 {
 
-
-/**
- * Constructor
- */
 PqDataProvider::PqDataProvider()
     throw()
         : mDb(0)
 {
 }
 
-
-/**
- * Destructor
- */
 PqDataProvider::~PqDataProvider()
     throw()
 {
@@ -45,7 +37,6 @@ PqDataProvider::~PqDataProvider()
         disconnect();
 }
 
-
 /**
  * Get the database backend name.
  */
@@ -55,7 +46,6 @@ DbBackends PqDataProvider::getDbBackend() const
     return DB_BKEND_POSTGRESQL;
 }
 
-
 /**
  * Create a connection to the database.
  */
@@ -86,7 +76,6 @@ void PqDataProvider::connect(const std::string& dbName,
     mIsConnected = true;
 }
 
-
 /**
  * Execute a SQL query.
  */
@@ -138,7 +127,6 @@ const RecordSet &PqDataProvider::execSql(const std::string& sql,
     return mRecordSet;
 }
 
-
 /**
  * Close connection to database.
  */
@@ -154,5 +142,4 @@ void PqDataProvider::disconnect()
     mIsConnected = false;
 }
 
-
 } // namespace dal
diff --git a/src/dal/pqdataprovider.h b/src/dal/pqdataprovider.h
index 872428a..6a2a1b1 100644
--- a/src/dal/pqdataprovider.h
+++ b/src/dal/pqdataprovider.h
@@ -35,15 +35,9 @@ namespace dal
 class PqDataProvider: public DataProvider
 {
     public:
-        /**
-         * Constructor
-         */
         PqDataProvider()
             throw();
 
-        /**
-         * Destructor
-         */
         ~PqDataProvider()
             throw();
 
diff --git a/src/dal/recordset.cpp b/src/dal/recordset.cpp
index 77b2a94..065bbd7 100644
--- a/src/dal/recordset.cpp
+++ b/src/dal/recordset.cpp
@@ -29,17 +29,11 @@
 namespace dal
 {
 
-/**
- * Default constructor.
- */
 RecordSet::RecordSet()
     throw()
 {
 }
 
-/**
- * Destructor.
- */
 RecordSet::~RecordSet()
     throw()
 {
@@ -62,7 +56,6 @@ bool RecordSet::isEmpty() const
     return mRows.size() == 0;
 }
 
-
 /**
  * Get the number of rows.
  *
@@ -83,7 +76,6 @@ unsigned int RecordSet::cols() const
     return mHeaders.size();
 }
 
-
 /**
  * Set the column headers.
  */
@@ -96,7 +88,6 @@ void RecordSet::setColumnHeaders(const Row &headers)
     mHeaders = headers;
 }
 
-
 /**
  * Add a new row.
  */
@@ -119,10 +110,6 @@ void RecordSet::add(const Row &row)
     mRows.push_back(row);
 }
 
-
-/**
- * Operator()
- */
 const std::string &RecordSet::operator()(const unsigned int row,
                                          const unsigned int col) const
 {
@@ -138,10 +125,6 @@ const std::string &RecordSet::operator()(const unsigned int row,
     return mRows[row][col];
 }
 
-
-/**
- * Operator()
- */
 const std::string &RecordSet::operator()(const unsigned int row,
                                          const std::string& name) const
 {
@@ -175,10 +158,6 @@ const std::string &RecordSet::operator()(const unsigned int row,
     return mRows[row][i];
 }
 
-
-/**
- * Operator<<
- */
 std::ostream &operator<<(std::ostream &out, const RecordSet &rhs)
 {
     // print the field names first.
@@ -211,5 +190,4 @@ std::ostream &operator<<(std::ostream &out, const RecordSet &rhs)
     return out;
 }
 
-
 } // namespace dal
diff --git a/src/dal/recordset.h b/src/dal/recordset.h
index 3abef8e..80c2e68 100644
--- a/src/dal/recordset.h
+++ b/src/dal/recordset.h
@@ -44,15 +44,9 @@ typedef std::vector<std::string> Row;
 class RecordSet
 {
     public:
-        /**
-         * Default constructor.
-         */
         RecordSet()
             throw();
 
-        /**
-         * Destructor.
-         */
         ~RecordSet()
             throw();
 
diff --git a/src/dal/sqlitedataprovider.cpp b/src/dal/sqlitedataprovider.cpp
index ea394e0..74fa072 100644
--- a/src/dal/sqlitedataprovider.cpp
+++ b/src/dal/sqlitedataprovider.cpp
@@ -29,24 +29,15 @@
 namespace dal
 {
 
-
 const std::string SqLiteDataProvider::CFGPARAM_SQLITE_DB     = "sqlite_database";
 const std::string SqLiteDataProvider::CFGPARAM_SQLITE_DB_DEF = "mana.db";
 
-
-/**
- * Constructor.
- */
 SqLiteDataProvider::SqLiteDataProvider()
     throw()
         : mDb(0)
 {
 }
 
-
-/**
- * Destructor.
- */
 SqLiteDataProvider::~SqLiteDataProvider()
     throw()
 {
@@ -64,7 +55,6 @@ SqLiteDataProvider::~SqLiteDataProvider()
     }
 }
 
-
 /**
  * Get the name of the database backend.
  */
@@ -74,12 +64,10 @@ DbBackends SqLiteDataProvider::getDbBackend() const
     return DB_BKEND_SQLITE;
 }
 
-
 /**
  * Create a connection to the database.
  */
-void
-SqLiteDataProvider::connect()
+void SqLiteDataProvider::connect()
 {
     // get configuration parameter for sqlite
     const std::string dbName
@@ -114,13 +102,11 @@ SqLiteDataProvider::connect()
     LOG_INFO("Connection to database successful.");
 }
 
-
 /**
  * Execute a SQL query.
  */
-const RecordSet&
-SqLiteDataProvider::execSql(const std::string& sql,
-                            const bool refresh)
+const RecordSet &SqLiteDataProvider::execSql(const std::string& sql,
+                                             const bool refresh)
 {
     if (!mIsConnected)
         throw std::runtime_error("not connected to database");
@@ -187,7 +173,6 @@ SqLiteDataProvider::execSql(const std::string& sql,
     return mRecordSet;
 }
 
-
 /**
  * Close the connection to the database.
  */
diff --git a/src/dal/sqlitedataprovider.h b/src/dal/sqlitedataprovider.h
index 3941364..e948f00 100644
--- a/src/dal/sqlitedataprovider.h
+++ b/src/dal/sqlitedataprovider.h
@@ -45,15 +45,9 @@ namespace dal
 class SqLiteDataProvider: public DataProvider
 {
     public:
-        /**
-         * Constructor.
-         */
         SqLiteDataProvider()
             throw();
 
-        /**
-         * Destructor.
-         */
         ~SqLiteDataProvider()
             throw();
 
@@ -65,7 +59,6 @@ class SqLiteDataProvider: public DataProvider
         DbBackends getDbBackend() const
             throw();
 
-
         /**
          * Create a connection to the database.
          *
@@ -73,7 +66,6 @@ class SqLiteDataProvider: public DataProvider
          */
         void connect();
 
-
         /**
          * Execute a SQL query.
          *
@@ -88,7 +80,6 @@ class SqLiteDataProvider: public DataProvider
         const RecordSet &execSql(const std::string& sql,
                                  const bool refresh = false);
 
-
         /**
          * Close the connection to the database.
          *
@@ -171,7 +162,6 @@ class SqLiteDataProvider: public DataProvider
         void bindValue(int place, int value);
 
     private:
-
         /** defines the name of the database config parameter */
         static const std::string CFGPARAM_SQLITE_DB;
         /** defines the default value of the CFGPARAM_SQLITE_DB parameter */