Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

tidy up and document AppConfig build options

  • Loading branch information...
commit 20492f6d58af20bf913120ee7e50d04cae127e53 1 parent de3b4b8
Vinnie Falco vinniefalco authored
27 AppConfigTemplate/AppConfig.h
View
@@ -14,7 +14,7 @@
existing AppConfig.hto control the compilations options avilable in VFLib.
*/
-/** Activate Boost features.
+/** Activate features that require Boost.
Your project will need to be configured to find the Boost includes
and libraries.
@@ -23,36 +23,17 @@
#define VF_USE_BOOST 0
#endif
-/* Turns on BZip2 features */
+/** Turns on BZip2 features */
#ifndef VF_USE_BZIP2
#define VF_USE_BZIP2 1
#endif
-/* Turns on FreeType features */
+/** Activate features that require FreeType.
+*/
#ifndef VF_USE_FREETYPE
#define VF_USE_FREETYPE 1
#endif
-/* Turns on Lua features */
-#ifndef VF_USE_LUA
-#define VF_USE_LUA 1
-#endif
-
-/* Turn on luabridge features */
-#ifndef VF_USE_LUABRIDGE
-#define VF_USE_LUABRIDGE 1
-#endif
-
-/* Turns on SQLite features */
-#ifndef VF_USE_SQLITE
-#define VF_USE_SQLITE 1
-#endif
-
-/* Turns on Taglib features */
-#ifndef VF_USE_TAGLIB
-#define VF_USE_TAGLIB 1
-#endif
-
//==============================================================================
// Ignore this
11 include/vf/modules/vf_core/vf_core.h
View
@@ -48,21 +48,14 @@
#ifndef VF_USE_BOOST
#define VF_USE_BOOST 0
#endif
+
#ifndef VF_USE_BZIP2
#define VF_USE_BZIP2 0
#endif
+
#ifndef VF_USE_FREETYPE
#define VF_USE_FREETYPE 0
#endif
-#ifndef VF_USE_LUA
-#define VF_USE_LUA 0
-#endif
-#ifndef VF_USE_LUABRIDGE
-#define VF_USE_LUABRIDGE 0
-#endif
-#ifndef VF_USE_SQLITE
-#define VF_USE_SQLITE 0
-#endif
// Handy macro that lets pragma warnings be clicked in the output window
// Usage: #pragma message(VF_LOC_"Advertise here!")
25 include/vf/modules/vf_db/api/session.h
View
@@ -51,8 +51,7 @@
namespace db {
//==============================================================================
-/**
- A session for the embedded database.
+/** A session for the embedded database.
@ingroup vf_db
*/
@@ -67,14 +66,22 @@ class session
explicit session (session const& deferredClone);
Error clone ();
- //! Connect string parameters
- //!
- //! "timeout={#,infinite}" |
- //! "mode={read,write,create}" |
- //! "cache={shared,private}" |
- //! "threads={single,multi}" default is serialized
- //!
+ /** Open a database.
+ The database at the specified path is opened. The connection string is
+ a set of "{key}={value}" pairs separated with the pipe symbol ('|').
+ Choices for key and value are:
+
+ @code
+ timeout = (number) || "infinite"
+
+ mode = "read" || "write" || "create"
+
+ cache = "shared" || "private"
+
+ threads = "single" || "multi"
+ @endcode
+ */
Error open (String fileName,
std::string options = "timeout=infinite|mode=create|threads=multi");
15 include/vf/modules/vf_db/vf_db.h
View
@@ -23,14 +23,23 @@
#define VF_DB_VFHEADER
//==============================================================================
-/**
- A SQLite wrapper with a natural, intuitive, and type-safe interface.
+/** An embedded database wrapper with an intuitive, type-safe interface.
- Description.
+ This collection of classes let's you access embedded SQLite databases
+ using C++ syntax that is very similar to regular SQL.
+
+ This module requires the @ref vf_sqlite external module.
@defgroup vf_db vf_db
*/
+//==============================================================================
+/** Include file for the @ref vf_db module.
+
+ @file vf_db.h
+ @ingroup vf_db
+*/
+
#include "../vf_core/vf_core.h"
// forward declares
4 include/vf/modules/vf_lua/vf_lua.c
View
@@ -21,8 +21,6 @@
#include "AppConfig.h"
-#if VF_USE_LUA
-
#ifdef _MSC_VER
#pragma push_macro("_CRT_SECURE_NO_WARNINGS")
#ifndef _CRT_SECURE_NO_WARNINGS
@@ -107,5 +105,3 @@ extern "C"
#ifdef _MSC_VER
#pragma pop_macro("_CRT_SECURE_NO_WARNINGS")
#endif
-
-#endif
4 include/vf/modules/vf_lua/vf_lua.h
View
@@ -44,10 +44,6 @@
#include "AppConfig.h"
-#if VF_USE_LUA
-
#include "lua/lua.hpp"
#endif
-
-#endif
4 include/vf/modules/vf_luabridge/vf_luabridge.cpp
View
@@ -21,11 +21,7 @@
#include "AppConfig.h"
-#if VF_USE_LUABRIDGE
-
#include "vf_luabridge.h"
#include "luabridge/luabridge.cpp"
#include "luabridge/shared_ptr.cpp"
-
-#endif
10 include/vf/modules/vf_luabridge/vf_luabridge.h
View
@@ -48,16 +48,8 @@
#include "AppConfig.h"
-#if VF_USE_LUABRIDGE
-
-#if VF_USE_LUA
-# include "../vf_lua/vf_lua.h"
-#else
-# error vf_luabridge requires vf_lua
-#endif
+#include "../vf_lua/vf_lua.h"
#include "luabridge/luabridge.hpp"
#endif
-
-#endif
4 include/vf/modules/vf_sqlite/vf_sqlite.c
View
@@ -21,8 +21,6 @@
#include "AppConfig.h"
-#if VF_USE_SQLITE
-
#if _MSC_VER
#pragma warning (push)
#pragma warning (disable: 4127) // conditional expression is constant
@@ -45,5 +43,3 @@
#if _MSC_VER
#pragma warning (pop)
#endif
-
-#endif
4 include/vf/modules/vf_sqlite/vf_sqlite.h
View
@@ -48,10 +48,6 @@
#include "AppConfig.h"
-#if VF_USE_SQLITE
-
#include "sqlite/sqlite3.h"
#endif
-
-#endif
4 include/vf/modules/vf_taglib/vf_taglib.cpp
View
@@ -21,8 +21,6 @@
#include "AppConfig.h"
-#if VF_USE_TAGLIB
-
#ifdef _MSC_VER
#pragma warning (push)
#pragma warning (disable: 4018) // signed/unsigned comparison mismatch
@@ -43,5 +41,3 @@
#ifdef _MSC_VER
#pragma warning (pop)
#endif
-
-#endif
4 include/vf/modules/vf_taglib/vf_taglib.h
View
@@ -47,10 +47,6 @@
#include "AppConfig.h"
-#if VF_USE_TAGLIB
-
#include "taglib/TagLibAmalgam.h"
#endif
-
-#endif
Please sign in to comment.
Something went wrong with that request. Please try again.