cuberite/SQLiteCpp
1
0
Fork 0
mirror of https://github.com/cuberite/SQLiteCpp.git synced 2025-08-04 09:46:02 -04:00
Code Issues Packages Projects Releases Wiki Activity

Added a short description on the RAII design

Browse Source
This commit is contained in:
Sébastien Rombauts 2012-04-04 14:12:38 +02:00
parent c2003d0bd1
commit dce8466f1e
2 changed files with 10 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
src/SQLiteC++/Database.h
View File

@ -22,10 +22,14 @@ class Statement;
class Exception; class Exception;
/** /**
* @brief Management of a SQLite Database Connection. * @brief RAII management of a SQLite Database Connection.
* *
* A Database object manage a list of all SQLite Statements associated with the * A Database object manage a list of all SQLite Statements associated with the
* underlying SQLite 3 database connection. * underlying SQLite 3 database connection.
*
* Resource Acquisition Is Initialization (RAII) means that the Database Connection
* is opened in the constructor and closed in the destructor, so that there is
* no need to worry about memory management or the validity of the underlying SQLite Connection.
*/ */
class Database class Database
{ {

6
src/SQLiteC++/Statement.h
View File

@ -19,10 +19,14 @@ namespace SQLite
class Database; class Database;
/** /**
* @brief Encapsulation of a prepared SQLite Statement. * @brief RAII encapsulation of a prepared SQLite Statement.
* *
* A Statement is a compiled SQL query ready to be executed step by step * A Statement is a compiled SQL query ready to be executed step by step
* to provide results one row at a time. * to provide results one row at a time.
*
* Resource Acquisition Is Initialization (RAII) means that the Statement
* is compiled in the constructor and finalized in the destructor, so that there is
* no need to worry about memory management or the validity of the underlying SQLite Statement.
*/ */
class Statement class Statement
{ {