From 223c14139b73a6d9594422feb351fbd8a5891c45 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?S=C3=A9bastien=20Rombauts?= <sebastien.rombauts@gmail.com>
Date: Sat, 16 Jul 2016 17:04:49 +0200
Subject: [PATCH] Minor comment style cleanups

---
 include/SQLiteCpp/Backup.h      |  2 +-
 include/SQLiteCpp/Column.h      |  4 ++--
 include/SQLiteCpp/Database.h    |  6 +++---
 include/SQLiteCpp/Statement.h   | 23 ++++++++++++-----------
 include/SQLiteCpp/Transaction.h |  4 ++--
 5 files changed, 20 insertions(+), 19 deletions(-)

diff --git a/include/SQLiteCpp/Backup.h b/include/SQLiteCpp/Backup.h
index 0978cda..52096c1 100644
--- a/include/SQLiteCpp/Backup.h
+++ b/include/SQLiteCpp/Backup.h
@@ -130,7 +130,7 @@ private:
     /// @}
 
 private:
-    sqlite3_backup* mpSQLiteBackup;   //!< Pointer to SQLite Database Backup Handle
+    sqlite3_backup* mpSQLiteBackup;   ///< Pointer to SQLite Database Backup Handle
 };
 
 }  // namespace SQLite
diff --git a/include/SQLiteCpp/Column.h b/include/SQLiteCpp/Column.h
index 7f09b09..54d9406 100644
--- a/include/SQLiteCpp/Column.h
+++ b/include/SQLiteCpp/Column.h
@@ -239,8 +239,8 @@ public:
 #endif
 
 private:
-    Statement::Ptr  mStmtPtr;   //!< Shared Pointer to the prepared SQLite Statement Object
-    int             mIndex;     //!< Index of the column in the row of result, starting at 0
+    Statement::Ptr  mStmtPtr;   ///< Shared Pointer to the prepared SQLite Statement Object
+    int             mIndex;     ///< Index of the column in the row of result, starting at 0
 };
 
 /**
diff --git a/include/SQLiteCpp/Database.h b/include/SQLiteCpp/Database.h
index 352aa5e..4d044eb 100644
--- a/include/SQLiteCpp/Database.h
+++ b/include/SQLiteCpp/Database.h
@@ -278,7 +278,7 @@ public:
      * @brief Return raw pointer to SQLite Database Connection Handle.
      *
      * This is often needed to mix this wrapper with other libraries or for advance usage not supported by SQLiteCpp.
-    */
+     */
     inline sqlite3* getHandle() const noexcept // nothrow
     {
         return mpSQLite;
@@ -379,8 +379,8 @@ private:
     }
 
 private:
-    sqlite3*    mpSQLite;   //!< Pointer to SQLite Database Connection Handle
-    std::string mFilename;  //!< UTF-8 filename used to open the database
+    sqlite3*    mpSQLite;   ///< Pointer to SQLite Database Connection Handle
+    std::string mFilename;  ///< UTF-8 filename used to open the database
 };
 
 
diff --git a/include/SQLiteCpp/Statement.h b/include/SQLiteCpp/Statement.h
index 17c6ad6..4ae6835 100644
--- a/include/SQLiteCpp/Statement.h
+++ b/include/SQLiteCpp/Statement.h
@@ -463,14 +463,14 @@ public:
 
 #ifdef SQLITE_ENABLE_COLUMN_METADATA
     /**
-    * @brief Return a pointer to the table column name that is the origin of the specified result column
-    *
-    *  Require definition of the SQLITE_ENABLE_COLUMN_METADATA preprocessor macro :
-    * - when building the SQLite library itself (which is the case for the Debian libsqlite3 binary for instance),
-    * - and also when compiling this wrapper.
-    *
-    *  Throw an exception if the specified index is out of the [0, getColumnCount()) range.
-    */
+     * @brief Return a pointer to the table column name that is the origin of the specified result column
+     *
+     *  Require definition of the SQLITE_ENABLE_COLUMN_METADATA preprocessor macro :
+     * - when building the SQLite library itself (which is the case for the Debian libsqlite3 binary for instance),
+     * - and also when compiling this wrapper.
+     *
+     *  Throw an exception if the specified index is out of the [0, getColumnCount()) range.
+     */
     const char* getColumnOriginName(const int aIndex) const;
 #endif
 
@@ -546,7 +546,7 @@ private:
         }
 
     private:
-        /// @{ Unused/forbidden copy operator
+        /// @{ Unused/forbidden copy/assignment operator
         Ptr& operator=(const Ptr& aPtr);
         /// @}
 
@@ -588,8 +588,8 @@ private:
     }
 
     /**
-    * @brief Check if there is a Column index is in the range of columns in the result.
-    */
+     * @brief Check if there is a Column index is in the range of columns in the result.
+     */
     inline void checkIndex(const int aIndex) const
     {
         if ((aIndex < 0) || (aIndex >= mColumnCount))
@@ -599,6 +599,7 @@ private:
     }
 
 private:
+    /// Map of columns index by name (mutable so getColumnIndex can be const)
     typedef std::map<std::string, int> TColumnNames;
 
 private:
diff --git a/include/SQLiteCpp/Transaction.h b/include/SQLiteCpp/Transaction.h
index 33935a6..1e6b4e9 100644
--- a/include/SQLiteCpp/Transaction.h
+++ b/include/SQLiteCpp/Transaction.h
@@ -69,8 +69,8 @@ private:
     /// @}
 
 private:
-    Database&   mDatabase;  //!< Reference to the SQLite Database Connection
-    bool        mbCommited; //!< True when commit has been called
+    Database&   mDatabase;  ///< Reference to the SQLite Database Connection
+    bool        mbCommited; ///< True when commit has been called
 };