Minor comment style cleanups

This commit is contained in:
Sébastien Rombauts 2016-07-16 17:04:49 +02:00
parent 7983b81f75
commit 223c14139b
5 changed files with 20 additions and 19 deletions

View File

@ -130,7 +130,7 @@ private:
/// @} /// @}
private: private:
sqlite3_backup* mpSQLiteBackup; //!< Pointer to SQLite Database Backup Handle sqlite3_backup* mpSQLiteBackup; ///< Pointer to SQLite Database Backup Handle
}; };
} // namespace SQLite } // namespace SQLite

View File

@ -239,8 +239,8 @@ public:
#endif #endif
private: private:
Statement::Ptr mStmtPtr; //!< Shared Pointer to the prepared SQLite Statement Object 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 int mIndex; ///< Index of the column in the row of result, starting at 0
}; };
/** /**

View File

@ -278,7 +278,7 @@ public:
* @brief Return raw pointer to SQLite Database Connection Handle. * @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. * 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 inline sqlite3* getHandle() const noexcept // nothrow
{ {
return mpSQLite; return mpSQLite;
@ -379,8 +379,8 @@ private:
} }
private: private:
sqlite3* mpSQLite; //!< Pointer to SQLite Database Connection Handle sqlite3* mpSQLite; ///< Pointer to SQLite Database Connection Handle
std::string mFilename; //!< UTF-8 filename used to open the database std::string mFilename; ///< UTF-8 filename used to open the database
}; };

View File

@ -463,14 +463,14 @@ public:
#ifdef SQLITE_ENABLE_COLUMN_METADATA #ifdef SQLITE_ENABLE_COLUMN_METADATA
/** /**
* @brief Return a pointer to the table column name that is the origin of the specified result column * @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 : * 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), * - when building the SQLite library itself (which is the case for the Debian libsqlite3 binary for instance),
* - and also when compiling this wrapper. * - and also when compiling this wrapper.
* *
* Throw an exception if the specified index is out of the [0, getColumnCount()) range. * Throw an exception if the specified index is out of the [0, getColumnCount()) range.
*/ */
const char* getColumnOriginName(const int aIndex) const; const char* getColumnOriginName(const int aIndex) const;
#endif #endif
@ -546,7 +546,7 @@ private:
} }
private: private:
/// @{ Unused/forbidden copy operator /// @{ Unused/forbidden copy/assignment operator
Ptr& operator=(const Ptr& aPtr); 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 inline void checkIndex(const int aIndex) const
{ {
if ((aIndex < 0) || (aIndex >= mColumnCount)) if ((aIndex < 0) || (aIndex >= mColumnCount))
@ -599,6 +599,7 @@ private:
} }
private: private:
/// Map of columns index by name (mutable so getColumnIndex can be const)
typedef std::map<std::string, int> TColumnNames; typedef std::map<std::string, int> TColumnNames;
private: private:

View File

@ -69,8 +69,8 @@ private:
/// @} /// @}
private: private:
Database& mDatabase; //!< Reference to the SQLite Database Connection Database& mDatabase; ///< Reference to the SQLite Database Connection
bool mbCommited; //!< True when commit has been called bool mbCommited; ///< True when commit has been called
}; };