Skip to content

GitLab

Commit 1757a047 authored by Davis King's avatar Davis King
Browse files

updated docs

parent 94ff8e83
Show whitespace changes
Inline Side-by-side
Showing with 97 additions and 0 deletions
docs/docs/other.xml
View file @ 1757a047
......@@ -61,7 +61,42 @@
<item>serialize</item>
<item>zero_extend_cast</item>
<item>make_mfp</item>
</section>
<section>
<name>SQLite</name>
<item>database</item>
<item>statement</item>
<item>transaction</item>
<item nolink="true">
<name>simple_queries</name>
<sub>
<item>
<name>query_object</name>
<link>dlib/sqlite/sqlite_tools_abstract.h.html#query_object</link>
</item>
<item>
<name>query_text</name>
<link>dlib/sqlite/sqlite_tools_abstract.h.html#query_text</link>
</item>
<item>
<name>query_double</name>
<link>dlib/sqlite/sqlite_tools_abstract.h.html#query_double</link>
</item>
<item>
<name>query_int</name>
<link>dlib/sqlite/sqlite_tools_abstract.h.html#query_int</link>
</item>
<item>
<name>query_int64</name>
<link>dlib/sqlite/sqlite_tools_abstract.h.html#query_int64</link>
</item>
<item>
<name>query_blob</name>
<link>dlib/sqlite/sqlite_tools_abstract.h.html#query_blob</link>
</item>
</sub>
</item>
</section>
<section>
......@@ -878,6 +913,55 @@
</component>
<!-- ************************************************************************* -->
<component>
<name>database</name>
<file>dlib/sqlite.h</file>
<spec_file link="true">dlib/sqlite/sqlite_abstract.h</spec_file>
<description>
This object is a C++ wrapper around a SQLite database connection
handle and therefore represents a <a href="http://www.sqlite.org">SQLite</a> database file.
<p>
Note that this wrapper is targeted at SQLite Version 3. To use it
you must make sure you link your application with SQLite.
</p>
</description>
</component>
<!-- ************************************************************************* -->
<component>
<name>statement</name>
<file>dlib/sqlite.h</file>
<spec_file link="true">dlib/sqlite/sqlite_abstract.h</spec_file>
<description>
This object represents a SQL statement which can be executed
against a <a href="#database">database</a> object. In particular, this object is a
C++ wrapper around a <a href="http://www.sqlite.org">SQLite</a> prepared statement.
<p>
Note that this wrapper is targeted at SQLite Version 3. To use it
you must make sure you link your application with SQLite.
</p>
</description>
</component>
<!-- ************************************************************************* -->
<component>
<name>transaction</name>
<file>dlib/sqlite.h</file>
<spec_file link="true">dlib/sqlite/sqlite_tools_abstract.h</spec_file>
<description>
This object is a tool for creating exception safe
<a href="#database">database</a> transactions.
</description>
</component>
<!-- ************************************************************************* -->
<component>
......
docs/docs/term_index.xml
View file @ 1757a047
......@@ -1143,6 +1143,19 @@
<term link="dlib/algs.h.html#general_return_codes" name="PORTINUSE"/>
<term link="dlib/general_hash/general_hash.h.html" name="general_hash"/>
<term file="other.html" name="database"/>
<term file="other.html" name="statement"/>
<term file="other.html" name="transaction"/>
<term link="other.html#database" name="SQLite"/>
<term file="dlib/sqlite/sqlite_tools_abstract.h.html" name="query_object"/>
<term file="dlib/sqlite/sqlite_tools_abstract.h.html" name="query_text"/>
<term file="dlib/sqlite/sqlite_tools_abstract.h.html" name="query_double"/>
<term file="dlib/sqlite/sqlite_tools_abstract.h.html" name="query_int"/>
<term file="dlib/sqlite/sqlite_tools_abstract.h.html" name="query_int64"/>
<term file="dlib/sqlite/sqlite_tools_abstract.h.html" name="query_blob"/>
<term file="dlib/sqlite/sqlite_abstract.h.html" name="sqlite_error"/>
</term_list>
</body>
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment