Fix Doxygen comments

This commit is contained in:
Sébastien Rombauts 2016-07-05 07:53:35 +02:00
parent db7aefb271
commit a2abbf1d96
3 changed files with 10 additions and 9 deletions

View File

@ -81,6 +81,6 @@ Version 1.3.1 - February 10 2016
Remove biicode support (defunct service, servers will shutdown the 16th of February 2016)
Version 1.3.x ?
Update SQLite3 from 3.10.2 ot latest 3.13 (2016-05-18)
Update SQLite3 from 3.10.2 to latest 3.13 (2016-05-18)
Better exception messages when statements fail #84
Variadic templates for bind() (C++14) #85

View File

@ -2049,7 +2049,7 @@ HIDE_UNDOC_RELATIONS = YES
# set to NO
# The default value is: NO.
HAVE_DOT = YES
HAVE_DOT = NO
# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
# to run in parallel. When set to 0 doxygen will base this on the number of

View File

@ -61,6 +61,7 @@ public:
* @brief Encapsulation of the error message from SQLite3, based on std::runtime_error.
*
* @param[in] aErrorMessage The string message describing the SQLite error
* @param[in] ret Return value from function call that failed.
*/
explicit Exception(const std::string& aErrorMessage, int ret) :
std::runtime_error(aErrorMessage),
@ -108,27 +109,27 @@ public:
{
}
/// @brief Return the result code (if any, otherwise -1).
/// Return the result code (if any, otherwise -1).
inline int getErrorCode() const noexcept // nothrow
{
return mErrcode;
}
/// @brief Return the extended numeric result code (if any, otherwise -1).
/// Return the extended numeric result code (if any, otherwise -1).
inline int getExtendedErrorCode() const noexcept // nothrow
{
return mExtendedErrcode;
}
/// @brief Return a string, solely based on the error code
/// Return a string, solely based on the error code
inline const char *getErrStr() const noexcept // nothrow
{
return sqlite3_errstr(mErrcode);
}
private:
const int mErrcode;
const int mExtendedErrcode;
const int mErrcode; ///< Error code value
const int mExtendedErrcode; ///< Detailed error code if any
};