From 4ee32ec7364af52834997995ebdddc313cbfcea7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9bastien=20Rombauts?= Date: Fri, 15 Mar 2013 15:32:41 +0100 Subject: [PATCH] Doxygen group name without the trailing "++" --- SQLiteCpp.Doxyfile | 2 +- src/Column.cpp | 5 +++-- src/Column.h | 17 +++++++++-------- src/Database.cpp | 5 +++-- src/Database.h | 5 +++-- src/Exception.h | 10 ++++++---- src/SQLiteC++.h | 5 +++-- src/Statement.cpp | 5 +++-- src/Statement.h | 9 +++++---- src/Transaction.cpp | 5 +++-- src/Transaction.h | 5 +++-- 11 files changed, 42 insertions(+), 31 deletions(-) diff --git a/SQLiteCpp.Doxyfile b/SQLiteCpp.Doxyfile index e0a1d9e..c1fd44a 100644 --- a/SQLiteCpp.Doxyfile +++ b/SQLiteCpp.Doxyfile @@ -666,7 +666,7 @@ WARN_FORMAT = "$file:$line: $text" # and error messages should be written. If left blank the output is written # to stderr. -WARN_LOGFILE = doc/warnings.txt +WARN_LOGFILE = #--------------------------------------------------------------------------- # configuration options related to the input files diff --git a/src/Column.cpp b/src/Column.cpp index c088535..e44fe97 100644 --- a/src/Column.cpp +++ b/src/Column.cpp @@ -1,6 +1,7 @@ /** - * @file Column.cpp - * @brief Encapsulation of a Column in a row of the result pointed by the prepared SQLite::Statement. + * @file Column.cpp + * @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) * diff --git a/src/Column.h b/src/Column.h index 7052439..6eafd71 100644 --- a/src/Column.h +++ b/src/Column.h @@ -1,6 +1,7 @@ /** - * @file Column.h - * @brief Encapsulation of a Column in a row of the result pointed by the prepared SQLite::Statement. + * @file Column.h + * @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) * @@ -24,7 +25,7 @@ namespace SQLite * of the Statement : it points to a single cell. * * 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 { @@ -73,27 +74,27 @@ public: */ 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 { 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 { 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 { 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 { 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 { return (SQLITE_NULL == getType()); diff --git a/src/Database.cpp b/src/Database.cpp index 7ce146f..67b61e9 100644 --- a/src/Database.cpp +++ b/src/Database.cpp @@ -1,6 +1,7 @@ /** - * @file Database.cpp - * @brief Management of a SQLite Database Connection. + * @file Database.cpp + * @brief Management of a SQLite Database Connection. + * @ingroup SQLiteC++ * * Copyright (c) 2012-2013 Sebastien Rombauts (sebastien.rombauts@gmail.com) * diff --git a/src/Database.h b/src/Database.h index 55c7973..2fed457 100644 --- a/src/Database.h +++ b/src/Database.h @@ -1,6 +1,7 @@ /** - * @file Database.h - * @brief Management of a SQLite Database Connection. + * @file Database.h + * @brief Management of a SQLite Database Connection. + * @ingroup SQLiteC++ * * Copyright (c) 2012-2013 Sebastien Rombauts (sebastien.rombauts@gmail.com) * diff --git a/src/Exception.h b/src/Exception.h index 4c8ad5d..0754da2 100644 --- a/src/Exception.h +++ b/src/Exception.h @@ -1,6 +1,7 @@ /** - * @file Exception.h - * @brief Encapsulation of the error message from SQLite3 on a std::runtime_error. + * @file Exception.h + * @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) * @@ -14,8 +15,8 @@ // assert() is used in destructors, where exceptions are not allowed -// here you can chose if you whant to use them or not -#ifdef _DEBUG +// here you can chose if you want to use them or not +#ifndef NDEBUG // in debug mode : #define SQLITE_CPP_ASSERT(expression) assert(expression) #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) #endif + namespace SQLite { diff --git a/src/SQLiteC++.h b/src/SQLiteC++.h index 8059ff1..29f0832 100644 --- a/src/SQLiteC++.h +++ b/src/SQLiteC++.h @@ -1,6 +1,7 @@ /** - * @file SQLiteC++.h - * @brief SQLiteC++ is a smart and simple C++ SQLite3 wrapper. This file is only "easy include" for other files. + * @file SQLiteC++.h + * @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) * diff --git a/src/Statement.cpp b/src/Statement.cpp index 1cdf6a3..868f942 100644 --- a/src/Statement.cpp +++ b/src/Statement.cpp @@ -1,6 +1,7 @@ /** - * @file Statement.cpp - * @brief A prepared SQLite Statement is a compiled SQL query ready to be executed, pointing to a row of result. + * @file Statement.cpp + * @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) * diff --git a/src/Statement.h b/src/Statement.h index 99c38a6..18c61b1 100644 --- a/src/Statement.h +++ b/src/Statement.h @@ -1,6 +1,7 @@ /** - * @file Statement.h - * @brief A prepared SQLite Statement is a compiled SQL query ready to be executed, pointing to a row of result. + * @file Statement.h + * @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) * @@ -170,7 +171,7 @@ public: * * 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), - * - 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 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. * * @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. * Thus, you should instead extract immediately its data (getInt(), getText()...) * and use or copy this data for any later usage. diff --git a/src/Transaction.cpp b/src/Transaction.cpp index cad0034..ff8b16f 100644 --- a/src/Transaction.cpp +++ b/src/Transaction.cpp @@ -1,6 +1,7 @@ /** - * @file Transaction.cpp - * @brief A Transaction is way to group multiple SQL statements into an atomic secured operation. + * @file Transaction.cpp + * @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) * diff --git a/src/Transaction.h b/src/Transaction.h index a06b3fe..9150298 100644 --- a/src/Transaction.h +++ b/src/Transaction.h @@ -1,6 +1,7 @@ /** - * @file Transaction.h - * @brief A Transaction is way to group multiple SQL statements into an atomic secured operation. + * @file Transaction.h + * @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) *