Skip to content

Commit 68c60c7

Browse files
braindigitalisbraindigitalis
committed
docs
1 parent 84430a1 commit 68c60c7

20 files changed

+26
-35
lines changed

Diff for: ‎docs/annotated.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@
9797
<!-- start footer part -->
9898
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
9999
<ul>
100-
<li class="footer">Generated on Mon Jul 15 2024 14:16:41 for DPP-MySQL by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
100+
<li class="footer">Generated on Mon Jul 15 2024 14:18:07 for DPP-MySQL by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
101101
</ul>
102102
</div>
103103
</body>

Diff for: ‎docs/classes.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@
9797
<!-- start footer part -->
9898
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
9999
<ul>
100-
<li class="footer">Generated on Mon Jul 15 2024 14:16:41 for DPP-MySQL by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
100+
<li class="footer">Generated on Mon Jul 15 2024 14:18:07 for DPP-MySQL by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
101101
</ul>
102102
</div>
103103
</body>

Diff for: ‎docs/deprecated.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@
9898
<!-- start footer part -->
9999
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
100100
<ul>
101-
<li class="footer">Generated on Mon Jul 15 2024 14:16:40 for DPP-MySQL by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
101+
<li class="footer">Generated on Mon Jul 15 2024 14:18:07 for DPP-MySQL by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
102102
</ul>
103103
</div>
104104
</body>

Diff for: ‎docs/functions.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@
125125
<!-- start footer part -->
126126
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
127127
<ul>
128-
<li class="footer">Generated on Mon Jul 15 2024 14:16:41 for DPP-MySQL by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
128+
<li class="footer">Generated on Mon Jul 15 2024 14:18:07 for DPP-MySQL by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
129129
</ul>
130130
</div>
131131
</body>

Diff for: ‎docs/functions_func.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@
116116
<!-- start footer part -->
117117
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
118118
<ul>
119-
<li class="footer">Generated on Mon Jul 15 2024 14:16:41 for DPP-MySQL by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
119+
<li class="footer">Generated on Mon Jul 15 2024 14:18:07 for DPP-MySQL by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
120120
</ul>
121121
</div>
122122
</body>

Diff for: ‎docs/functions_vars.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@
9898
<!-- start footer part -->
9999
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
100100
<ul>
101-
<li class="footer">Generated on Mon Jul 15 2024 14:16:41 for DPP-MySQL by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
101+
<li class="footer">Generated on Mon Jul 15 2024 14:18:07 for DPP-MySQL by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
102102
</ul>
103103
</div>
104104
</body>

Diff for: ‎docs/graph_legend.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@
151151
<!-- start footer part -->
152152
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
153153
<ul>
154-
<li class="footer">Generated on Mon Jul 15 2024 14:16:40 for DPP-MySQL by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
154+
<li class="footer">Generated on Mon Jul 15 2024 14:18:07 for DPP-MySQL by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
155155
</ul>
156156
</div>
157157
</body>

Diff for: ‎docs/index.html

+3-6
Original file line numberDiff line numberDiff line change
@@ -103,11 +103,8 @@ <h1><a class="anchor" id="autotoc_md2"></a>
103103
<li>A C++ compiler capable of building D++ bots with coroutine support, if you want to use the asynchronous interface</li>
104104
</ul>
105105
<h1><a class="anchor" id="autotoc_md3"></a>
106-
Documentation</h1>
107-
<p>All functions in the <code>db</code> namespace have Doxygen comment blocks.</p>
108-
<h1><a class="anchor" id="autotoc_md4"></a>
109106
Using the wrapper</h1>
110-
<h2><a class="anchor" id="autotoc_md5"></a>
107+
<h2><a class="anchor" id="autotoc_md4"></a>
111108
Simple Queries</h2>
112109
<p>This is an example of using the asynchronous interface:</p>
113110
<div class="fragment"><div class="line"><span class="preprocessor">#include &lt;dpp/dpp.h&gt;</span></div>
@@ -153,7 +150,7 @@ <h2><a class="anchor" id="autotoc_md5"></a>
153150
<div class="line"> &quot;socket&quot;: &quot;/path/to/mysqld.sock&quot;</div>
154151
<div class="line"> }</div>
155152
<div class="line">}</div>
156-
</div><!-- fragment --><h2><a class="anchor" id="autotoc_md6"></a>
153+
</div><!-- fragment --><h2><a class="anchor" id="autotoc_md5"></a>
157154
Using Transactions</h2>
158155
<p>To use transactions, wrap the transaction in the <code><a class="el" href="namespacedb.html#a2b4f92b15fde6491a19818b96b0d79d9" title="Start an SQL transaction. SQL transactions are atomic in nature, ALL other queries will be forced to ...">db::transaction</a></code> function, and use only the <code><a class="el" href="namespacedb.html#a8e64d322c430542846327f26e9d00ff6" title="Run a mysql query, with automatic escaping of parameters to prevent SQL injection.">db::query</a></code> function within it for queries. Return true to commit the transaction, or throw any exception or return false to roll back the transaction.</p>
159156
<p>Note that during a transaction all other queries will be forced to wait until the transaction is completed. Transactions are asynchronous, so use the callback to be notified when it completes, or use co_transaction as below:</p>
@@ -184,7 +181,7 @@ <h2><a class="anchor" id="autotoc_md5"></a>
184181
<!-- start footer part -->
185182
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
186183
<ul>
187-
<li class="footer">Generated on Mon Jul 15 2024 14:16:40 for DPP-MySQL by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
184+
<li class="footer">Generated on Mon Jul 15 2024 14:18:07 for DPP-MySQL by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
188185
</ul>
189186
</div>
190187
</body>

Diff for: ‎docs/namespaceconfig.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -185,7 +185,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a3b6fc04da34bbdb59ec97861
185185
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
186186
<ul>
187187
<li class="navelem"><a class="el" href="namespaceconfig.html">config</a></li>
188-
<li class="footer">Generated on Mon Jul 15 2024 14:16:40 for DPP-MySQL by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
188+
<li class="footer">Generated on Mon Jul 15 2024 14:18:07 for DPP-MySQL by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
189189
</ul>
190190
</div>
191191
</body>

Diff for: ‎docs/namespacedb.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -674,7 +674,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a2b4f92b15fde6491a19818b9
674674
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
675675
<ul>
676676
<li class="navelem"><a class="el" href="namespacedb.html">db</a></li>
677-
<li class="footer">Generated on Mon Jul 15 2024 14:16:40 for DPP-MySQL by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
677+
<li class="footer">Generated on Mon Jul 15 2024 14:18:07 for DPP-MySQL by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
678678
</ul>
679679
</div>
680680
</body>

Diff for: ‎docs/namespacemembers.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@
144144
<!-- start footer part -->
145145
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
146146
<ul>
147-
<li class="footer">Generated on Mon Jul 15 2024 14:16:41 for DPP-MySQL by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
147+
<li class="footer">Generated on Mon Jul 15 2024 14:18:07 for DPP-MySQL by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
148148
</ul>
149149
</div>
150150
</body>

Diff for: ‎docs/namespacemembers_func.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@
132132
<!-- start footer part -->
133133
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
134134
<ul>
135-
<li class="footer">Generated on Mon Jul 15 2024 14:16:41 for DPP-MySQL by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
135+
<li class="footer">Generated on Mon Jul 15 2024 14:18:07 for DPP-MySQL by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
136136
</ul>
137137
</div>
138138
</body>

Diff for: ‎docs/namespacemembers_type.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@
101101
<!-- start footer part -->
102102
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
103103
<ul>
104-
<li class="footer">Generated on Mon Jul 15 2024 14:16:41 for DPP-MySQL by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
104+
<li class="footer">Generated on Mon Jul 15 2024 14:18:07 for DPP-MySQL by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
105105
</ul>
106106
</div>
107107
</body>

Diff for: ‎docs/namespaces.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@
9898
<!-- start footer part -->
9999
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
100100
<ul>
101-
<li class="footer">Generated on Mon Jul 15 2024 14:16:40 for DPP-MySQL by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
101+
<li class="footer">Generated on Mon Jul 15 2024 14:18:07 for DPP-MySQL by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
102102
</ul>
103103
</div>
104104
</body>

Diff for: ‎docs/navtreedata.js

+3-4
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,9 @@ var NAVTREE =
2828
[ "A simple asynchronous MySQL wrapper for D++ bots", "index.html", [
2929
[ "Documentation", "index.html#autotoc_md1", null ],
3030
[ "Dependencies", "index.html#autotoc_md2", null ],
31-
[ "Documentation", "index.html#autotoc_md3", null ],
32-
[ "Using the wrapper", "index.html#autotoc_md4", [
33-
[ "Simple Queries", "index.html#autotoc_md5", null ],
34-
[ "Using Transactions", "index.html#autotoc_md6", null ]
31+
[ "Using the wrapper", "index.html#autotoc_md3", [
32+
[ "Simple Queries", "index.html#autotoc_md4", null ],
33+
[ "Using Transactions", "index.html#autotoc_md5", null ]
3534
] ]
3635
] ],
3736
[ "Deprecated List", "deprecated.html", null ],

Diff for: ‎docs/navtreeindex0.js

+2-3
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,8 @@ var NAVTREEINDEX0 =
1111
"index.html#autotoc_md1":[0,0],
1212
"index.html#autotoc_md2":[0,1],
1313
"index.html#autotoc_md3":[0,2],
14-
"index.html#autotoc_md4":[0,3],
15-
"index.html#autotoc_md5":[0,3,0],
16-
"index.html#autotoc_md6":[0,3,1],
14+
"index.html#autotoc_md4":[0,2,0],
15+
"index.html#autotoc_md5":[0,2,1],
1716
"namespaceconfig.html":[2,0,0],
1817
"namespaceconfig.html#a3b6fc04da34bbdb59ec978612c865538":[2,0,0,2],
1918
"namespaceconfig.html#a7948a6875d305616d8cebf8aaeeb6ae2":[2,0,0,0],

Diff for: ‎docs/pages.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@
9696
<!-- start footer part -->
9797
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
9898
<ul>
99-
<li class="footer">Generated on Mon Jul 15 2024 14:16:40 for DPP-MySQL by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
99+
<li class="footer">Generated on Mon Jul 15 2024 14:18:07 for DPP-MySQL by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
100100
</ul>
101101
</div>
102102
</body>

Diff for: ‎docs/structdb_1_1resultset-members.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@
106106
<!-- start footer part -->
107107
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
108108
<ul>
109-
<li class="footer">Generated on Mon Jul 15 2024 14:16:40 for DPP-MySQL by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
109+
<li class="footer">Generated on Mon Jul 15 2024 14:18:07 for DPP-MySQL by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
110110
</ul>
111111
</div>
112112
</body>

Diff for: ‎docs/structdb_1_1resultset.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -446,7 +446,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a86664b2b52696b3732e21453
446446
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
447447
<ul>
448448
<li class="navelem"><a class="el" href="namespacedb.html">db</a></li><li class="navelem"><a class="el" href="structdb_1_1resultset.html">resultset</a></li>
449-
<li class="footer">Generated on Mon Jul 15 2024 14:16:40 for DPP-MySQL by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
449+
<li class="footer">Generated on Mon Jul 15 2024 14:18:07 for DPP-MySQL by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
450450
</ul>
451451
</div>
452452
</body>

Diff for: ‎docs/xml/indexpage.xml

+2-6
Original file line numberDiff line numberDiff line change
@@ -26,12 +26,8 @@
2626
</para>
2727
</sect1>
2828
<sect1 id="index_1autotoc_md3">
29-
<title>Documentation</title>
30-
<para>All functions in the <computeroutput>db</computeroutput> namespace have Doxygen comment blocks.</para>
31-
</sect1>
32-
<sect1 id="index_1autotoc_md4">
3329
<title>Using the wrapper</title>
34-
<sect2 id="index_1autotoc_md5">
30+
<sect2 id="index_1autotoc_md4">
3531
<title>Simple Queries</title>
3632
<para>This is an example of using the asynchronous interface:</para>
3733
<para><programlisting filename=".cpp"><codeline><highlight class="preprocessor">#include<sp/>&lt;dpp/dpp.h&gt;</highlight><highlight class="normal"></highlight></codeline>
@@ -76,7 +72,7 @@
7672
<codeline><highlight class="normal">}</highlight></codeline>
7773
</programlisting></para>
7874
</sect2>
79-
<sect2 id="index_1autotoc_md6">
75+
<sect2 id="index_1autotoc_md5">
8076
<title>Using Transactions</title>
8177
<para>To use transactions, wrap the transaction in the <computeroutput><ref refid="namespacedb_1a2b4f92b15fde6491a19818b96b0d79d9" kindref="member">db::transaction</ref></computeroutput> function, and use only the <computeroutput><ref refid="namespacedb_1a8e64d322c430542846327f26e9d00ff6" kindref="member">db::query</ref></computeroutput> function within it for queries. Return true to commit the transaction, or throw any exception or return false to roll back the transaction.</para>
8278
<para>Note that during a transaction all other queries will be forced to wait until the transaction is completed. Transactions are asynchronous, so use the callback to be notified when it completes, or use co_transaction as below:</para>

0 commit comments

Comments
 (0)