[CHORE] documentation

Author: FelixTheC

Doxyfile

@@ -924,7 +924,7 @@ WARN_LOGFILE           =
 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
 # Note: If this tag is empty the current directory is searched.
 
-INPUT                  =    ./src README.md
+INPUT                  =    ./src ./pages
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
@@ -1138,7 +1138,7 @@ FILTER_SOURCE_PATTERNS =
 # (index.html). This can be useful if you have a project on for instance GitHub
 # and want to reuse the introduction page also for the doxygen output.
 
-USE_MDFILE_AS_MAINPAGE =
+USE_MDFILE_AS_MAINPAGE = ./docs/main.md
 
 # The Fortran standard specifies that for fixed formatted Fortran code all
 # characters from position 72 are to be considered as comment. A common

README.md

@@ -4,10 +4,11 @@
 
 This is a C++ driver built for type-safe query creation.
 
-AnnaDB uses a custom query language dubbed [TySON](https://github.com/roman-right/tyson)
+AnnaDB uses a custom query language called [TySON](https://github.com/roman-right/tyson)
 
 
-## Required
+## Requiredccccccvrcuhfhjvhckhlgnhbjurfnderebdflnkicvcr
+
 - [zeromq](https://zeromq.org/download/)
 - cmake >= 3.24
 

docs/html/TySON_8hpp_source.html

@@ -75,20 +75,30 @@
 <div class="textblock">Here are the classes, structs, unions and interfaces with brief descriptions:</div><div class="directory">
 <div class="levels">[detail level <span onclick="javascript:toggleLevel(1);">1</span><span onclick="javascript:toggleLevel(2);">2</span><span onclick="javascript:toggleLevel(3);">3</span>]</div><table class="directory">
 <tr id="row_0_" class="even"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_0_" class="arrow" onclick="toggleFolder('0_')">&#9660;</span><span class="icona"><span class="icon">N</span></span><b>annadb</b></td><td class="desc"></td></tr>
-<tr id="row_0_0_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span id="arr_0_0_" class="arrow" onclick="toggleFolder('0_0_')">&#9660;</span><span class="icona"><span class="icon">N</span></span><b>Query</b></td><td class="desc"></td></tr>
-<tr id="row_0_0_0_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classannadb_1_1Query_1_1Asc.html" target="_self">Asc</a></td><td class="desc"></td></tr>
-<tr id="row_0_0_1_" class="odd"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classannadb_1_1Query_1_1Delete.html" target="_self">Delete</a></td><td class="desc"></td></tr>
-<tr id="row_0_0_2_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classannadb_1_1Query_1_1Desc.html" target="_self">Desc</a></td><td class="desc"></td></tr>
-<tr id="row_0_0_3_" class="odd"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classannadb_1_1Query_1_1Find.html" target="_self">Find</a></td><td class="desc"></td></tr>
-<tr id="row_0_0_4_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classannadb_1_1Query_1_1Get.html" target="_self">Get</a></td><td class="desc"></td></tr>
-<tr id="row_0_0_5_" class="odd"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classannadb_1_1Query_1_1Insert.html" target="_self">Insert</a></td><td class="desc"></td></tr>
-<tr id="row_0_0_6_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classannadb_1_1Query_1_1Limit.html" target="_self">Limit</a></td><td class="desc"></td></tr>
-<tr id="row_0_0_7_" class="odd"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classannadb_1_1Query_1_1Offset.html" target="_self">Offset</a></td><td class="desc"></td></tr>
-<tr id="row_0_0_8_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classannadb_1_1Query_1_1Query.html" target="_self">Query</a></td><td class="desc"></td></tr>
-<tr id="row_0_0_9_" class="odd"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classannadb_1_1Query_1_1QueryCmd.html" target="_self">QueryCmd</a></td><td class="desc"></td></tr>
-<tr id="row_0_0_10_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classannadb_1_1Query_1_1Sort.html" target="_self">Sort</a></td><td class="desc"></td></tr>
-<tr id="row_0_0_11_" class="odd"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structannadb_1_1Query_1_1SortCmd.html" target="_self">SortCmd</a></td><td class="desc"></td></tr>
-<tr id="row_0_0_12_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classannadb_1_1Query_1_1Update.html" target="_self">Update</a></td><td class="desc"></td></tr>
+<tr id="row_0_0_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span id="arr_0_0_" class="arrow" onclick="toggleFolder('0_0_')">&#9660;</span><span class="icona"><span class="icon">N</span></span><a class="el" href="namespaceannadb_1_1Query.html" target="_self">Query</a></td><td class="desc"></td></tr>
+<tr id="row_0_0_0_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classannadb_1_1Query_1_1And.html" target="_self">And</a></td><td class="desc"></td></tr>
+<tr id="row_0_0_1_" class="odd"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classannadb_1_1Query_1_1Asc.html" target="_self">Asc</a></td><td class="desc"></td></tr>
+<tr id="row_0_0_2_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classannadb_1_1Query_1_1Comparison.html" target="_self">Comparison</a></td><td class="desc"></td></tr>
+<tr id="row_0_0_3_" class="odd"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classannadb_1_1Query_1_1Delete.html" target="_self">Delete</a></td><td class="desc"></td></tr>
+<tr id="row_0_0_4_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classannadb_1_1Query_1_1Desc.html" target="_self">Desc</a></td><td class="desc"></td></tr>
+<tr id="row_0_0_5_" class="odd"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classannadb_1_1Query_1_1Eq.html" target="_self">Eq</a></td><td class="desc"></td></tr>
+<tr id="row_0_0_6_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classannadb_1_1Query_1_1Find.html" target="_self">Find</a></td><td class="desc"></td></tr>
+<tr id="row_0_0_7_" class="odd"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classannadb_1_1Query_1_1Get.html" target="_self">Get</a></td><td class="desc"></td></tr>
+<tr id="row_0_0_8_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classannadb_1_1Query_1_1Gt.html" target="_self">Gt</a></td><td class="desc"></td></tr>
+<tr id="row_0_0_9_" class="odd"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classannadb_1_1Query_1_1Gte.html" target="_self">Gte</a></td><td class="desc"></td></tr>
+<tr id="row_0_0_10_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classannadb_1_1Query_1_1Insert.html" target="_self">Insert</a></td><td class="desc"></td></tr>
+<tr id="row_0_0_11_" class="odd"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classannadb_1_1Query_1_1Limit.html" target="_self">Limit</a></td><td class="desc"></td></tr>
+<tr id="row_0_0_12_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classannadb_1_1Query_1_1Lt.html" target="_self">Lt</a></td><td class="desc"></td></tr>
+<tr id="row_0_0_13_" class="odd"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classannadb_1_1Query_1_1Lte.html" target="_self">Lte</a></td><td class="desc"></td></tr>
+<tr id="row_0_0_14_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classannadb_1_1Query_1_1Neq.html" target="_self">Neq</a></td><td class="desc"></td></tr>
+<tr id="row_0_0_15_" class="odd"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classannadb_1_1Query_1_1Not.html" target="_self">Not</a></td><td class="desc"></td></tr>
+<tr id="row_0_0_16_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classannadb_1_1Query_1_1Offset.html" target="_self">Offset</a></td><td class="desc"></td></tr>
+<tr id="row_0_0_17_" class="odd"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classannadb_1_1Query_1_1Or.html" target="_self">Or</a></td><td class="desc"></td></tr>
+<tr id="row_0_0_18_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classannadb_1_1Query_1_1Query.html" target="_self">Query</a></td><td class="desc"></td></tr>
+<tr id="row_0_0_19_" class="odd"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classannadb_1_1Query_1_1QueryCmd.html" target="_self">QueryCmd</a></td><td class="desc"></td></tr>
+<tr id="row_0_0_20_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classannadb_1_1Query_1_1Sort.html" target="_self">Sort</a></td><td class="desc"></td></tr>
+<tr id="row_0_0_21_" class="odd"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structannadb_1_1Query_1_1SortCmd.html" target="_self">SortCmd</a></td><td class="desc"></td></tr>
+<tr id="row_0_0_22_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classannadb_1_1Query_1_1Update.html" target="_self">Update</a></td><td class="desc"></td></tr>
 <tr id="row_0_1_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classannadb_1_1AnnaDB.html" target="_self">AnnaDB</a></td><td class="desc"></td></tr>
 <tr id="row_0_2_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classannadb_1_1Data.html" target="_self">Data</a></td><td class="desc"></td></tr>
 <tr id="row_0_3_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classannadb_1_1Journal.html" target="_self">Journal</a></td><td class="desc"></td></tr>

docs/html/annotated.html

@@ -83,7 +83,8 @@
   <tr class="odd"><td class="entry"><a class="el" href="classannadb_1_1AnnaDB.html#a709f1664bdc539bdfd2533db6d04da52">close</a>()</td><td class="entry"><a class="el" href="classannadb_1_1AnnaDB.html">annadb::AnnaDB</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
   <tr class="even"><td class="entry"><a class="el" href="classannadb_1_1AnnaDB.html#a5b451c757817b312936f9cd73798d9ff">connect</a>()</td><td class="entry"><a class="el" href="classannadb_1_1AnnaDB.html">annadb::AnnaDB</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
   <tr class="odd"><td class="entry"><a class="el" href="classannadb_1_1AnnaDB.html#af005b166c5a91570dbafc2d74b35569a">send</a>(std::string_view query)</td><td class="entry"><a class="el" href="classannadb_1_1AnnaDB.html">annadb::AnnaDB</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
-  <tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>~AnnaDB</b>()=default (defined in <a class="el" href="classannadb_1_1AnnaDB.html">annadb::AnnaDB</a>)</td><td class="entry"><a class="el" href="classannadb_1_1AnnaDB.html">annadb::AnnaDB</a></td><td class="entry"></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="classannadb_1_1AnnaDB.html#a9e23c91f78b9df9c11b8828cd14d74b0">send</a>(annadb::Query::Query &amp;query)</td><td class="entry"><a class="el" href="classannadb_1_1AnnaDB.html">annadb::AnnaDB</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
+  <tr bgcolor="#f0f0f0" class="odd"><td class="entry"><b>~AnnaDB</b>()=default (defined in <a class="el" href="classannadb_1_1AnnaDB.html">annadb::AnnaDB</a>)</td><td class="entry"><a class="el" href="classannadb_1_1AnnaDB.html">annadb::AnnaDB</a></td><td class="entry"></td></tr>
 </table></div><!-- contents -->
 <!-- start footer part -->
 <hr class="footer"/><address class="footer"><small>

docs/html/classannadb_1_1AnnaDB-members.html

@@ -90,6 +90,8 @@
 <tr class="separator:a709f1664bdc539bdfd2533db6d04da52"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:af005b166c5a91570dbafc2d74b35569a"><td class="memItemLeft" align="right" valign="top">std::optional&lt; <a class="el" href="classannadb_1_1Journal.html">Journal</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classannadb_1_1AnnaDB.html#af005b166c5a91570dbafc2d74b35569a">send</a> (std::string_view query)</td></tr>
 <tr class="separator:af005b166c5a91570dbafc2d74b35569a"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a9e23c91f78b9df9c11b8828cd14d74b0"><td class="memItemLeft" align="right" valign="top">std::optional&lt; <a class="el" href="classannadb_1_1Journal.html">Journal</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classannadb_1_1AnnaDB.html#a9e23c91f78b9df9c11b8828cd14d74b0">send</a> (<a class="el" href="classannadb_1_1Query_1_1Query.html">annadb::Query::Query</a> &amp;query)</td></tr>
+<tr class="separator:a9e23c91f78b9df9c11b8828cd14d74b0"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table>
 <h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
 <a id="ad4e4ccad0b02cb9f73224e5656b68a64" name="ad4e4ccad0b02cb9f73224e5656b68a64"></a>
@@ -201,10 +203,45 @@ <h2 class="memtitle"><span class="permalink"><a href="#a5b451c757817b312936f9cd7
 </div><div class="memdoc">
 <p>open a connection with the <a class="el" href="classannadb_1_1AnnaDB.html">AnnaDB</a> </p>
 
+</div>
+</div>
+<a id="a9e23c91f78b9df9c11b8828cd14d74b0" name="a9e23c91f78b9df9c11b8828cd14d74b0"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a9e23c91f78b9df9c11b8828cd14d74b0">&#9670;&#160;</a></span>send() <span class="overload">[1/2]</span></h2>
+
+<div class="memitem">
+<div class="memproto">
+<table class="mlabels">
+  <tr>
+  <td class="mlabels-left">
+      <table class="memname">
+        <tr>
+          <td class="memname">std::optional&lt; <a class="el" href="classannadb_1_1Journal.html">Journal</a> &gt; annadb::AnnaDB::send </td>
+          <td>(</td>
+          <td class="paramtype"><a class="el" href="classannadb_1_1Query_1_1Query.html">annadb::Query::Query</a> &amp;&#160;</td>
+          <td class="paramname"><em>query</em></td><td>)</td>
+          <td></td>
+        </tr>
+      </table>
+  </td>
+  <td class="mlabels-right">
+<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
+  </tr>
+</table>
+</div><div class="memdoc">
+<p>Send a TySON formatted query to <a class="el" href="classannadb_1_1AnnaDB.html">AnnaDB</a></p>
+<dl class="params"><dt>Parameters</dt><dd>
+  <table class="params">
+    <tr><td class="paramname">query</td><td></td></tr>
+  </table>
+  </dd>
+</dl>
+<dl class="section see"><dt>See also</dt><dd>query.annadb::Query::Query </dd></dl>
+<dl class="section return"><dt>Returns</dt><dd>a <a class="el" href="classannadb_1_1Journal.html">Journal</a> object representing the result of the query if successful </dd></dl>
+
 </div>
 </div>
 <a id="af005b166c5a91570dbafc2d74b35569a" name="af005b166c5a91570dbafc2d74b35569a"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#af005b166c5a91570dbafc2d74b35569a">&#9670;&#160;</a></span>send()</h2>
+<h2 class="memtitle"><span class="permalink"><a href="#af005b166c5a91570dbafc2d74b35569a">&#9670;&#160;</a></span>send() <span class="overload">[2/2]</span></h2>
 
 <div class="memitem">
 <div class="memproto">