mirror of
https://github.com/cuberite/SQLiteCpp.git
synced 2025-08-04 17:56:13 -04:00
Doxygen group name without the trailing "++"
This commit is contained in:
parent
3ee357900e
commit
4ee32ec736
@ -666,7 +666,7 @@ WARN_FORMAT = "$file:$line: $text"
|
|||||||
# and error messages should be written. If left blank the output is written
|
# and error messages should be written. If left blank the output is written
|
||||||
# to stderr.
|
# to stderr.
|
||||||
|
|
||||||
WARN_LOGFILE = doc/warnings.txt
|
WARN_LOGFILE =
|
||||||
|
|
||||||
#---------------------------------------------------------------------------
|
#---------------------------------------------------------------------------
|
||||||
# configuration options related to the input files
|
# configuration options related to the input files
|
||||||
|
@ -1,6 +1,7 @@
|
|||||||
/**
|
/**
|
||||||
* @file Column.cpp
|
* @file Column.cpp
|
||||||
* @brief Encapsulation of a Column in a row of the result pointed by the prepared SQLite::Statement.
|
* @brief Encapsulation of a Column in a row of the result pointed by the prepared SQLite::Statement.
|
||||||
|
* @ingroup SQLiteC++
|
||||||
*
|
*
|
||||||
* Copyright (c) 2012-2013 Sebastien Rombauts (sebastien.rombauts@gmail.com)
|
* Copyright (c) 2012-2013 Sebastien Rombauts (sebastien.rombauts@gmail.com)
|
||||||
*
|
*
|
||||||
|
13
src/Column.h
13
src/Column.h
@ -1,6 +1,7 @@
|
|||||||
/**
|
/**
|
||||||
* @file Column.h
|
* @file Column.h
|
||||||
* @brief Encapsulation of a Column in a row of the result pointed by the prepared SQLite::Statement.
|
* @brief Encapsulation of a Column in a row of the result pointed by the prepared SQLite::Statement.
|
||||||
|
* @ingroup SQLiteC++
|
||||||
*
|
*
|
||||||
* Copyright (c) 2012-2013 Sebastien Rombauts (sebastien.rombauts@gmail.com)
|
* Copyright (c) 2012-2013 Sebastien Rombauts (sebastien.rombauts@gmail.com)
|
||||||
*
|
*
|
||||||
@ -24,7 +25,7 @@ namespace SQLite
|
|||||||
* of the Statement : it points to a single cell.
|
* of the Statement : it points to a single cell.
|
||||||
*
|
*
|
||||||
* Its value can be expressed as a text, and, when applicable, as a numeric
|
* Its value can be expressed as a text, and, when applicable, as a numeric
|
||||||
* (integer or floting point) or a binary blob.
|
* (integer or floating point) or a binary blob.
|
||||||
*/
|
*/
|
||||||
class Column
|
class Column
|
||||||
{
|
{
|
||||||
@ -73,27 +74,27 @@ public:
|
|||||||
*/
|
*/
|
||||||
int getType(void) const throw(); // nothrow
|
int getType(void) const throw(); // nothrow
|
||||||
|
|
||||||
/// @brief Test if the column is an integer type value (meaningfull only before any conversion)
|
/// @brief Test if the column is an integer type value (meaningful only before any conversion)
|
||||||
inline bool isInteger(void) const throw() // nothrow
|
inline bool isInteger(void) const throw() // nothrow
|
||||||
{
|
{
|
||||||
return (SQLITE_INTEGER == getType());
|
return (SQLITE_INTEGER == getType());
|
||||||
}
|
}
|
||||||
/// @brief Test if the column is a floting point type value (meaningfull only before any conversion)
|
/// @brief Test if the column is a floating point type value (meaningful only before any conversion)
|
||||||
inline bool isFloat(void) const throw() // nothrow
|
inline bool isFloat(void) const throw() // nothrow
|
||||||
{
|
{
|
||||||
return (SQLITE_FLOAT == getType());
|
return (SQLITE_FLOAT == getType());
|
||||||
}
|
}
|
||||||
/// @brief Test if the column is a text type value (meaningfull only before any conversion)
|
/// @brief Test if the column is a text type value (meaningful only before any conversion)
|
||||||
inline bool isText(void) const throw() // nothrow
|
inline bool isText(void) const throw() // nothrow
|
||||||
{
|
{
|
||||||
return (SQLITE_TEXT == getType());
|
return (SQLITE_TEXT == getType());
|
||||||
}
|
}
|
||||||
/// @brief Test if the column is a binary blob type value (meaningfull only before any conversion)
|
/// @brief Test if the column is a binary blob type value (meaningful only before any conversion)
|
||||||
inline bool isBlob(void) const throw() // nothrow
|
inline bool isBlob(void) const throw() // nothrow
|
||||||
{
|
{
|
||||||
return (SQLITE_BLOB == getType());
|
return (SQLITE_BLOB == getType());
|
||||||
}
|
}
|
||||||
/// @brief Test if the column is NULL (meaningfull only before any conversion)
|
/// @brief Test if the column is NULL (meaningful only before any conversion)
|
||||||
inline bool isNull(void) const throw() // nothrow
|
inline bool isNull(void) const throw() // nothrow
|
||||||
{
|
{
|
||||||
return (SQLITE_NULL == getType());
|
return (SQLITE_NULL == getType());
|
||||||
|
@ -1,6 +1,7 @@
|
|||||||
/**
|
/**
|
||||||
* @file Database.cpp
|
* @file Database.cpp
|
||||||
* @brief Management of a SQLite Database Connection.
|
* @brief Management of a SQLite Database Connection.
|
||||||
|
* @ingroup SQLiteC++
|
||||||
*
|
*
|
||||||
* Copyright (c) 2012-2013 Sebastien Rombauts (sebastien.rombauts@gmail.com)
|
* Copyright (c) 2012-2013 Sebastien Rombauts (sebastien.rombauts@gmail.com)
|
||||||
*
|
*
|
||||||
|
@ -1,6 +1,7 @@
|
|||||||
/**
|
/**
|
||||||
* @file Database.h
|
* @file Database.h
|
||||||
* @brief Management of a SQLite Database Connection.
|
* @brief Management of a SQLite Database Connection.
|
||||||
|
* @ingroup SQLiteC++
|
||||||
*
|
*
|
||||||
* Copyright (c) 2012-2013 Sebastien Rombauts (sebastien.rombauts@gmail.com)
|
* Copyright (c) 2012-2013 Sebastien Rombauts (sebastien.rombauts@gmail.com)
|
||||||
*
|
*
|
||||||
|
@ -1,6 +1,7 @@
|
|||||||
/**
|
/**
|
||||||
* @file Exception.h
|
* @file Exception.h
|
||||||
* @brief Encapsulation of the error message from SQLite3 on a std::runtime_error.
|
* @brief Encapsulation of the error message from SQLite3 on a std::runtime_error.
|
||||||
|
* @ingroup SQLiteC++
|
||||||
*
|
*
|
||||||
* Copyright (c) 2012-2013 Sebastien Rombauts (sebastien.rombauts@gmail.com)
|
* Copyright (c) 2012-2013 Sebastien Rombauts (sebastien.rombauts@gmail.com)
|
||||||
*
|
*
|
||||||
@ -14,8 +15,8 @@
|
|||||||
|
|
||||||
|
|
||||||
// assert() is used in destructors, where exceptions are not allowed
|
// assert() is used in destructors, where exceptions are not allowed
|
||||||
// here you can chose if you whant to use them or not
|
// here you can chose if you want to use them or not
|
||||||
#ifdef _DEBUG
|
#ifndef NDEBUG
|
||||||
// in debug mode :
|
// in debug mode :
|
||||||
#define SQLITE_CPP_ASSERT(expression) assert(expression)
|
#define SQLITE_CPP_ASSERT(expression) assert(expression)
|
||||||
#else
|
#else
|
||||||
@ -28,6 +29,7 @@
|
|||||||
#pragma warning(disable:4290) // Disable warning C4290: C++ exception specification ignored except to indicate a function is not __declspec(nothrow)
|
#pragma warning(disable:4290) // Disable warning C4290: C++ exception specification ignored except to indicate a function is not __declspec(nothrow)
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
|
|
||||||
namespace SQLite
|
namespace SQLite
|
||||||
{
|
{
|
||||||
|
|
||||||
|
@ -1,6 +1,7 @@
|
|||||||
/**
|
/**
|
||||||
* @file SQLiteC++.h
|
* @file SQLiteC++.h
|
||||||
* @brief SQLiteC++ is a smart and simple C++ SQLite3 wrapper. This file is only "easy include" for other files.
|
* @brief SQLiteC++ is a smart and simple C++ SQLite3 wrapper. This file is only "easy include" for other files.
|
||||||
|
* @ingroup SQLiteC++
|
||||||
*
|
*
|
||||||
* Copyright (c) 2012-2013 Sebastien Rombauts (sebastien.rombauts@gmail.com)
|
* Copyright (c) 2012-2013 Sebastien Rombauts (sebastien.rombauts@gmail.com)
|
||||||
*
|
*
|
||||||
|
@ -1,6 +1,7 @@
|
|||||||
/**
|
/**
|
||||||
* @file Statement.cpp
|
* @file Statement.cpp
|
||||||
* @brief A prepared SQLite Statement is a compiled SQL query ready to be executed, pointing to a row of result.
|
* @brief A prepared SQLite Statement is a compiled SQL query ready to be executed, pointing to a row of result.
|
||||||
|
* @ingroup SQLiteC++
|
||||||
*
|
*
|
||||||
* Copyright (c) 2012-2013 Sebastien Rombauts (sebastien.rombauts@gmail.com)
|
* Copyright (c) 2012-2013 Sebastien Rombauts (sebastien.rombauts@gmail.com)
|
||||||
*
|
*
|
||||||
|
@ -1,6 +1,7 @@
|
|||||||
/**
|
/**
|
||||||
* @file Statement.h
|
* @file Statement.h
|
||||||
* @brief A prepared SQLite Statement is a compiled SQL query ready to be executed, pointing to a row of result.
|
* @brief A prepared SQLite Statement is a compiled SQL query ready to be executed, pointing to a row of result.
|
||||||
|
* @ingroup SQLiteC++
|
||||||
*
|
*
|
||||||
* Copyright (c) 2012-2013 Sebastien Rombauts (sebastien.rombauts@gmail.com)
|
* Copyright (c) 2012-2013 Sebastien Rombauts (sebastien.rombauts@gmail.com)
|
||||||
*
|
*
|
||||||
@ -170,7 +171,7 @@ public:
|
|||||||
*
|
*
|
||||||
* It is similar to Database::exec(), but using a precompiled statement, it adds :
|
* It is similar to Database::exec(), but using a precompiled statement, it adds :
|
||||||
* - the ability to bind() arguments to it (best way to insert data),
|
* - the ability to bind() arguments to it (best way to insert data),
|
||||||
* - reusing it allows for better performances (efficent for multiple insersion).
|
* - reusing it allows for better performances (efficient for multiple insertion).
|
||||||
*
|
*
|
||||||
* @see executeStep() execute a step of the prepared query to fetch one row of results
|
* @see executeStep() execute a step of the prepared query to fetch one row of results
|
||||||
* @see Database::exec() is a shortcut to execute one or multiple statements without results
|
* @see Database::exec() is a shortcut to execute one or multiple statements without results
|
||||||
@ -203,7 +204,7 @@ public:
|
|||||||
* share the ownership of the underlying sqlite3_stmt.
|
* share the ownership of the underlying sqlite3_stmt.
|
||||||
*
|
*
|
||||||
* @warning The resulting Column object must not be memorized "as-is".
|
* @warning The resulting Column object must not be memorized "as-is".
|
||||||
* Is is only a wrapper arround the current result row, so it is only valid
|
* Is is only a wrapper around the current result row, so it is only valid
|
||||||
* while the row from the Statement remains valid, that is only until next executeStep() call.
|
* while the row from the Statement remains valid, that is only until next executeStep() call.
|
||||||
* Thus, you should instead extract immediately its data (getInt(), getText()...)
|
* Thus, you should instead extract immediately its data (getInt(), getText()...)
|
||||||
* and use or copy this data for any later usage.
|
* and use or copy this data for any later usage.
|
||||||
|
@ -1,6 +1,7 @@
|
|||||||
/**
|
/**
|
||||||
* @file Transaction.cpp
|
* @file Transaction.cpp
|
||||||
* @brief A Transaction is way to group multiple SQL statements into an atomic secured operation.
|
* @brief A Transaction is way to group multiple SQL statements into an atomic secured operation.
|
||||||
|
* @ingroup SQLiteC++
|
||||||
*
|
*
|
||||||
* Copyright (c) 2012-2013 Sebastien Rombauts (sebastien.rombauts@gmail.com)
|
* Copyright (c) 2012-2013 Sebastien Rombauts (sebastien.rombauts@gmail.com)
|
||||||
*
|
*
|
||||||
|
@ -1,6 +1,7 @@
|
|||||||
/**
|
/**
|
||||||
* @file Transaction.h
|
* @file Transaction.h
|
||||||
* @brief A Transaction is way to group multiple SQL statements into an atomic secured operation.
|
* @brief A Transaction is way to group multiple SQL statements into an atomic secured operation.
|
||||||
|
* @ingroup SQLiteC++
|
||||||
*
|
*
|
||||||
* Copyright (c) 2012-2013 Sebastien Rombauts (sebastien.rombauts@gmail.com)
|
* Copyright (c) 2012-2013 Sebastien Rombauts (sebastien.rombauts@gmail.com)
|
||||||
*
|
*
|
||||||
|
Loading…
x
Reference in New Issue
Block a user