From 83a3ca6f37682e73657b7f81b7d764b6de863097 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9bastien=20Rombauts?= Date: Fri, 15 Mar 2013 15:46:11 +0100 Subject: [PATCH] Doxygen group name without the trailing ++ --- src/Column.cpp | 2 +- src/Column.h | 2 +- src/Database.cpp | 2 +- src/Database.h | 2 +- src/Exception.h | 2 +- src/SQLiteC++.h | 11 +++++++++-- src/Statement.cpp | 2 +- src/Statement.h | 2 +- src/Transaction.cpp | 2 +- src/Transaction.h | 2 +- 10 files changed, 18 insertions(+), 11 deletions(-) diff --git a/src/Column.cpp b/src/Column.cpp index e44fe97..1301a42 100644 --- a/src/Column.cpp +++ b/src/Column.cpp @@ -1,7 +1,7 @@ /** * @file Column.cpp * @brief Encapsulation of a Column in a row of the result pointed by the prepared SQLite::Statement. - * @ingroup SQLiteC++ + * @ingroup SQLiteCpp * * Copyright (c) 2012-2013 Sebastien Rombauts (sebastien.rombauts@gmail.com) * diff --git a/src/Column.h b/src/Column.h index 6eafd71..baa43b8 100644 --- a/src/Column.h +++ b/src/Column.h @@ -1,7 +1,7 @@ /** * @file Column.h * @brief Encapsulation of a Column in a row of the result pointed by the prepared SQLite::Statement. - * @ingroup SQLiteC++ + * @ingroup SQLiteCpp * * Copyright (c) 2012-2013 Sebastien Rombauts (sebastien.rombauts@gmail.com) * diff --git a/src/Database.cpp b/src/Database.cpp index 67b61e9..9c2fb27 100644 --- a/src/Database.cpp +++ b/src/Database.cpp @@ -1,7 +1,7 @@ /** * @file Database.cpp * @brief Management of a SQLite Database Connection. - * @ingroup SQLiteC++ + * @ingroup SQLiteCpp * * Copyright (c) 2012-2013 Sebastien Rombauts (sebastien.rombauts@gmail.com) * diff --git a/src/Database.h b/src/Database.h index 2fed457..86337c1 100644 --- a/src/Database.h +++ b/src/Database.h @@ -1,7 +1,7 @@ /** * @file Database.h * @brief Management of a SQLite Database Connection. - * @ingroup SQLiteC++ + * @ingroup SQLiteCpp * * Copyright (c) 2012-2013 Sebastien Rombauts (sebastien.rombauts@gmail.com) * diff --git a/src/Exception.h b/src/Exception.h index 0754da2..841a945 100644 --- a/src/Exception.h +++ b/src/Exception.h @@ -1,7 +1,7 @@ /** * @file Exception.h * @brief Encapsulation of the error message from SQLite3 on a std::runtime_error. - * @ingroup SQLiteC++ + * @ingroup SQLiteCpp * * Copyright (c) 2012-2013 Sebastien Rombauts (sebastien.rombauts@gmail.com) * diff --git a/src/SQLiteC++.h b/src/SQLiteC++.h index 29f0832..91efd0e 100644 --- a/src/SQLiteC++.h +++ b/src/SQLiteC++.h @@ -1,20 +1,27 @@ /** * @file SQLiteC++.h * @brief SQLiteC++ is a smart and simple C++ SQLite3 wrapper. This file is only "easy include" for other files. - * @ingroup SQLiteC++ + * @ingroup SQLiteCpp + * + * Include this main header file in your project to gain access to all functionality provided by the wrapper. * * Copyright (c) 2012-2013 Sebastien Rombauts (sebastien.rombauts@gmail.com) * * Distributed under the MIT License (MIT) (See accompanying file LICENSE.txt * or copy at http://opensource.org/licenses/MIT) */ +/** + * @defgroup SQLiteCpp SQLiteC++ + * @brief SQLiteC++ is a smart and simple C++ SQLite3 wrapper. This file is only "easy include" for other files. + */ #pragma once // SQLiteC++.h requires sqlite3, and the corresponding library header -#include "sqlite3.h" +#include // Include useful headers of SQLiteC++ +#include "Exception.h" #include "Database.h" #include "Statement.h" #include "Column.h" diff --git a/src/Statement.cpp b/src/Statement.cpp index 868f942..b8a8edf 100644 --- a/src/Statement.cpp +++ b/src/Statement.cpp @@ -1,7 +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. - * @ingroup SQLiteC++ + * @ingroup SQLiteCpp * * Copyright (c) 2012-2013 Sebastien Rombauts (sebastien.rombauts@gmail.com) * diff --git a/src/Statement.h b/src/Statement.h index 18c61b1..577d0dd 100644 --- a/src/Statement.h +++ b/src/Statement.h @@ -1,7 +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. - * @ingroup SQLiteC++ + * @ingroup SQLiteCpp * * Copyright (c) 2012-2013 Sebastien Rombauts (sebastien.rombauts@gmail.com) * diff --git a/src/Transaction.cpp b/src/Transaction.cpp index ff8b16f..bdb3176 100644 --- a/src/Transaction.cpp +++ b/src/Transaction.cpp @@ -1,7 +1,7 @@ /** * @file Transaction.cpp * @brief A Transaction is way to group multiple SQL statements into an atomic secured operation. - * @ingroup SQLiteC++ + * @ingroup SQLiteCpp * * Copyright (c) 2012-2013 Sebastien Rombauts (sebastien.rombauts@gmail.com) * diff --git a/src/Transaction.h b/src/Transaction.h index 9150298..d189c04 100644 --- a/src/Transaction.h +++ b/src/Transaction.h @@ -1,7 +1,7 @@ /** * @file Transaction.h * @brief A Transaction is way to group multiple SQL statements into an atomic secured operation. - * @ingroup SQLiteC++ + * @ingroup SQLiteCpp * * Copyright (c) 2012-2013 Sebastien Rombauts (sebastien.rombauts@gmail.com) *