Skip to content

Commit af2bece

Browse files
endurodaveendurodave
committed
Update Doxygen documentation
1 parent 5a2e119 commit af2bece

File tree

90 files changed

+1379
-1322
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

90 files changed

+1379
-1322
lines changed

‎docs/html/_async_invoke_8h.html‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -109,19 +109,19 @@
109109
<table class="memberdecls">
110110
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
111111
Functions</h2></td></tr>
112-
<tr class="memitem:a05707757f68e2f853116cdcaed699d0a" id="r_a05707757f68e2f853116cdcaed699d0a"><td class="memTemplParams" colspan="2">template&lt;class Func , class... Args&gt; </td></tr>
113-
<tr class="memitem:a05707757f68e2f853116cdcaed699d0a"><td class="memTemplItemLeft" align="right" valign="top">auto&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a05707757f68e2f853116cdcaed699d0a">AsyncInvoke</a> (Func func, <a class="el" href="class_thread.html">Thread</a> &amp;thread, const std::chrono::milliseconds &amp;timeout, Args &amp;&amp;... args)</td></tr>
114-
<tr class="separator:a05707757f68e2f853116cdcaed699d0a"><td class="memSeparator" colspan="2">&#160;</td></tr>
115-
<tr class="memitem:a198c6443999a45a9650b5f1e06d50bf3" id="r_a198c6443999a45a9650b5f1e06d50bf3"><td class="memTemplParams" colspan="2">template&lt;class TClass , class Func , class... Args&gt; </td></tr>
116-
<tr class="memitem:a198c6443999a45a9650b5f1e06d50bf3"><td class="memTemplItemLeft" align="right" valign="top">auto&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a198c6443999a45a9650b5f1e06d50bf3">AsyncInvoke</a> (TClass tclass, Func func, <a class="el" href="class_thread.html">Thread</a> &amp;thread, const std::chrono::milliseconds &amp;timeout, Args &amp;&amp;... args)</td></tr>
117-
<tr class="separator:a198c6443999a45a9650b5f1e06d50bf3"><td class="memSeparator" colspan="2">&#160;</td></tr>
112+
<tr class="memitem:a99ebea3e2f28d5c5650539df12e588e7" id="r_a99ebea3e2f28d5c5650539df12e588e7"><td class="memTemplParams" colspan="2">template&lt;class Func , class... Args&gt; </td></tr>
113+
<tr class="memitem:a99ebea3e2f28d5c5650539df12e588e7"><td class="memTemplItemLeft" align="right" valign="top">auto&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a99ebea3e2f28d5c5650539df12e588e7">AsyncInvoke</a> (Func func, <a class="el" href="class_thread.html">Thread</a> &amp;thread, const <a class="el" href="namespacedmq.html#a13ee4c32c184d1339bf5dc2657948156">dmq::Duration</a> &amp;timeout, Args &amp;&amp;... args)</td></tr>
114+
<tr class="separator:a99ebea3e2f28d5c5650539df12e588e7"><td class="memSeparator" colspan="2">&#160;</td></tr>
115+
<tr class="memitem:aca2ee254a7b9c83aaa7d4d4d973f12c0" id="r_aca2ee254a7b9c83aaa7d4d4d973f12c0"><td class="memTemplParams" colspan="2">template&lt;class TClass , class Func , class... Args&gt; </td></tr>
116+
<tr class="memitem:aca2ee254a7b9c83aaa7d4d4d973f12c0"><td class="memTemplItemLeft" align="right" valign="top">auto&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#aca2ee254a7b9c83aaa7d4d4d973f12c0">AsyncInvoke</a> (TClass tclass, Func func, <a class="el" href="class_thread.html">Thread</a> &amp;thread, const <a class="el" href="namespacedmq.html#a13ee4c32c184d1339bf5dc2657948156">dmq::Duration</a> &amp;timeout, Args &amp;&amp;... args)</td></tr>
117+
<tr class="separator:aca2ee254a7b9c83aaa7d4d4d973f12c0"><td class="memSeparator" colspan="2">&#160;</td></tr>
118118
</table>
119119
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
120120
<div class="textblock"><p>Helper functions to simplify invoking a free or member function on the user-specified thread of control using a single line of code. Particually useful for creating asynhronous APIs (see AsyncAPI.cpp). </p>
121121
<p>size_t send_data(const std::string&amp; data) { return AsyncInvoke(send_data_private, comm_thread, WAIT_INFINITE, data); } </p>
122122
</div><h2 class="groupheader">Function Documentation</h2>
123-
<a id="a05707757f68e2f853116cdcaed699d0a" name="a05707757f68e2f853116cdcaed699d0a"></a>
124-
<h2 class="memtitle"><span class="permalink"><a href="#a05707757f68e2f853116cdcaed699d0a">&#9670;&#160;</a></span>AsyncInvoke() <span class="overload">[1/2]</span></h2>
123+
<a id="a99ebea3e2f28d5c5650539df12e588e7" name="a99ebea3e2f28d5c5650539df12e588e7"></a>
124+
<h2 class="memtitle"><span class="permalink"><a href="#a99ebea3e2f28d5c5650539df12e588e7">&#9670;&#160;</a></span>AsyncInvoke() <span class="overload">[1/2]</span></h2>
125125

126126
<div class="memitem">
127127
<div class="memproto">
@@ -141,7 +141,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a05707757f68e2f853116cdca
141141
<tr>
142142
<td class="paramkey"></td>
143143
<td></td>
144-
<td class="paramtype">const std::chrono::milliseconds &amp;</td> <td class="paramname"><span class="paramname"><em>timeout</em></span>, </td>
144+
<td class="paramtype">const <a class="el" href="namespacedmq.html#a13ee4c32c184d1339bf5dc2657948156">dmq::Duration</a> &amp;</td> <td class="paramname"><span class="paramname"><em>timeout</em></span>, </td>
145145
</tr>
146146
<tr>
147147
<td class="paramkey"></td>
@@ -162,8 +162,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#a05707757f68e2f853116cdca
162162

163163
</div>
164164
</div>
165-
<a id="a198c6443999a45a9650b5f1e06d50bf3" name="a198c6443999a45a9650b5f1e06d50bf3"></a>
166-
<h2 class="memtitle"><span class="permalink"><a href="#a198c6443999a45a9650b5f1e06d50bf3">&#9670;&#160;</a></span>AsyncInvoke() <span class="overload">[2/2]</span></h2>
165+
<a id="aca2ee254a7b9c83aaa7d4d4d973f12c0" name="aca2ee254a7b9c83aaa7d4d4d973f12c0"></a>
166+
<h2 class="memtitle"><span class="permalink"><a href="#aca2ee254a7b9c83aaa7d4d4d973f12c0">&#9670;&#160;</a></span>AsyncInvoke() <span class="overload">[2/2]</span></h2>
167167

168168
<div class="memitem">
169169
<div class="memproto">
@@ -188,7 +188,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a198c6443999a45a9650b5f1e
188188
<tr>
189189
<td class="paramkey"></td>
190190
<td></td>
191-
<td class="paramtype">const std::chrono::milliseconds &amp;</td> <td class="paramname"><span class="paramname"><em>timeout</em></span>, </td>
191+
<td class="paramtype">const <a class="el" href="namespacedmq.html#a13ee4c32c184d1339bf5dc2657948156">dmq::Duration</a> &amp;</td> <td class="paramname"><span class="paramname"><em>timeout</em></span>, </td>
192192
</tr>
193193
<tr>
194194
<td class="paramkey"></td>

‎docs/html/_async_invoke_8h.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
var _async_invoke_8h =
22
[
3-
[ "AsyncInvoke", "_async_invoke_8h.html#a05707757f68e2f853116cdcaed699d0a", null ],
4-
[ "AsyncInvoke", "_async_invoke_8h.html#a198c6443999a45a9650b5f1e06d50bf3", null ]
3+
[ "AsyncInvoke", "_async_invoke_8h.html#a99ebea3e2f28d5c5650539df12e588e7", null ],
4+
[ "AsyncInvoke", "_async_invoke_8h.html#aca2ee254a7b9c83aaa7d4d4d973f12c0", null ]
55
];

‎docs/html/_async_invoke_8h_source.html‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@
107107
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> </div>
108108
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="keyword">template</span> &lt;<span class="keyword">class </span>Func, <span class="keyword">class</span>... Args&gt;</div>
109109
<div class="foldopen" id="foldopen00024" data-start="{" data-end="}">
110-
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"><a class="line" href="_async_invoke_8h.html#a05707757f68e2f853116cdcaed699d0a"> 24</a></span><span class="keyword">auto</span> <a class="code hl_function" href="_async_invoke_8h.html#a05707757f68e2f853116cdcaed699d0a">AsyncInvoke</a>(Func func, <a class="code hl_class" href="class_thread.html">Thread</a>&amp; thread, <span class="keyword">const</span> std::chrono::milliseconds&amp; timeout, Args&amp;&amp;... args) {</div>
110+
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"><a class="line" href="_async_invoke_8h.html#a99ebea3e2f28d5c5650539df12e588e7"> 24</a></span><span class="keyword">auto</span> <a class="code hl_function" href="_async_invoke_8h.html#a99ebea3e2f28d5c5650539df12e588e7">AsyncInvoke</a>(Func func, <a class="code hl_class" href="class_thread.html">Thread</a>&amp; thread, <span class="keyword">const</span> <a class="code hl_typedef" href="namespacedmq.html#a13ee4c32c184d1339bf5dc2657948156">dmq::Duration</a>&amp; timeout, Args&amp;&amp;... args) {</div>
111111
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> <span class="comment">// Deduce return type of func</span></div>
112112
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> <span class="keyword">using </span>RetType = <span class="keyword">decltype</span>(func(std::forward&lt;Args&gt;(args)...));</div>
113113
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> </div>
@@ -140,7 +140,7 @@
140140
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> </div>
141141
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span><span class="keyword">template</span> &lt;<span class="keyword">class </span>TClass, <span class="keyword">class </span>Func, <span class="keyword">class</span>... Args&gt;</div>
142142
<div class="foldopen" id="foldopen00064" data-start="{" data-end="}">
143-
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"><a class="line" href="_async_invoke_8h.html#a198c6443999a45a9650b5f1e06d50bf3"> 64</a></span><span class="keyword">auto</span> <a class="code hl_function" href="_async_invoke_8h.html#a05707757f68e2f853116cdcaed699d0a">AsyncInvoke</a>(TClass tclass, Func func, <a class="code hl_class" href="class_thread.html">Thread</a>&amp; thread, <span class="keyword">const</span> std::chrono::milliseconds&amp; timeout, Args&amp;&amp;... args) {</div>
143+
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"><a class="line" href="_async_invoke_8h.html#aca2ee254a7b9c83aaa7d4d4d973f12c0"> 64</a></span><span class="keyword">auto</span> <a class="code hl_function" href="_async_invoke_8h.html#a99ebea3e2f28d5c5650539df12e588e7">AsyncInvoke</a>(TClass tclass, Func func, <a class="code hl_class" href="class_thread.html">Thread</a>&amp; thread, <span class="keyword">const</span> <a class="code hl_typedef" href="namespacedmq.html#a13ee4c32c184d1339bf5dc2657948156">dmq::Duration</a>&amp; timeout, Args&amp;&amp;... args) {</div>
144144
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> <span class="comment">// Deduce return type of func</span></div>
145145
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> <span class="keyword">using </span>RetType = <span class="keyword">decltype</span>((tclass-&gt;*func)(std::forward&lt;Args&gt;(args)...));</div>
146146
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> </div>
@@ -174,10 +174,11 @@
174174
</div>
175175
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span> </div>
176176
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span><span class="preprocessor">#endif</span></div>
177-
<div class="ttc" id="a_async_invoke_8h_html_a05707757f68e2f853116cdcaed699d0a"><div class="ttname"><a href="_async_invoke_8h.html#a05707757f68e2f853116cdcaed699d0a">AsyncInvoke</a></div><div class="ttdeci">auto AsyncInvoke(Func func, Thread &amp;thread, const std::chrono::milliseconds &amp;timeout, Args &amp;&amp;... args)</div><div class="ttdef"><b>Definition</b> AsyncInvoke.h:24</div></div>
177+
<div class="ttc" id="a_async_invoke_8h_html_a99ebea3e2f28d5c5650539df12e588e7"><div class="ttname"><a href="_async_invoke_8h.html#a99ebea3e2f28d5c5650539df12e588e7">AsyncInvoke</a></div><div class="ttdeci">auto AsyncInvoke(Func func, Thread &amp;thread, const dmq::Duration &amp;timeout, Args &amp;&amp;... args)</div><div class="ttdef"><b>Definition</b> AsyncInvoke.h:24</div></div>
178178
<div class="ttc" id="aclass_thread_html"><div class="ttname"><a href="class_thread.html">Thread</a></div><div class="ttdef"><b>Definition</b> freertos/Thread.h:19</div></div>
179179
<div class="ttc" id="aclass_thread_html_a2294b75a90c36b4f14e32ae8d975a0fb"><div class="ttname"><a href="class_thread.html#a2294b75a90c36b4f14e32ae8d975a0fb">Thread::GetThreadId</a></div><div class="ttdeci">TaskHandle_t GetThreadId()</div><div class="ttdoc">Get the ID of this thread instance.</div><div class="ttdef"><b>Definition</b> freertos/Thread.cpp:51</div></div>
180180
<div class="ttc" id="aclass_thread_html_aafe48fc7ef98b9e6adcf7b188a30e35a"><div class="ttname"><a href="class_thread.html#aafe48fc7ef98b9e6adcf7b188a30e35a">Thread::GetCurrentThreadId</a></div><div class="ttdeci">static TaskHandle_t GetCurrentThreadId()</div><div class="ttdoc">Get the ID of the currently executing thread.</div><div class="ttdef"><b>Definition</b> freertos/Thread.cpp:62</div></div>
181+
<div class="ttc" id="anamespacedmq_html_a13ee4c32c184d1339bf5dc2657948156"><div class="ttname"><a href="namespacedmq.html#a13ee4c32c184d1339bf5dc2657948156">dmq::Duration</a></div><div class="ttdeci">std::chrono::duration&lt; uint32_t, std::milli &gt; Duration</div><div class="ttdef"><b>Definition</b> DelegateOpt.h:11</div></div>
181182
<div class="ttc" id="anamespacedmq_html_a65e308cc5f3e37d2f7f89c72b9744ae2"><div class="ttname"><a href="namespacedmq.html#a65e308cc5f3e37d2f7f89c72b9744ae2">dmq::MakeDelegate</a></div><div class="ttdeci">auto MakeDelegate(RetType(*func)(Args... args))</div><div class="ttdoc">Creates a delegate that binds to a free function.</div><div class="ttdef"><b>Definition</b> Delegate.h:673</div></div>
182183
</div><!-- fragment --></div><!-- contents -->
183184
</div><!-- doc-content -->

‎docs/html/_delegate_8h_source.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -619,8 +619,8 @@
619619
<div class="line"><a id="l00748" name="l00748"></a><span class="lineno"> 748</span> </div>
620620
<div class="line"><a id="l00749" name="l00749"></a><span class="lineno"> 749</span><span class="preprocessor">#endif</span></div>
621621
<div class="ttc" id="a_delegate_opt_8h_html"><div class="ttname"><a href="_delegate_opt_8h.html">DelegateOpt.h</a></div><div class="ttdoc">Delegate library options header file.</div></div>
622-
<div class="ttc" id="a_delegate_opt_8h_html_a5e800c556290ed548055177c33a66f5c"><div class="ttname"><a href="_delegate_opt_8h.html#a5e800c556290ed548055177c33a66f5c">XALLOCATOR</a></div><div class="ttdeci">#define XALLOCATOR</div><div class="ttdef"><b>Definition</b> DelegateOpt.h:39</div></div>
623-
<div class="ttc" id="a_delegate_opt_8h_html_abe89b46e296c7421855410a08d6d31fe"><div class="ttname"><a href="_delegate_opt_8h.html#abe89b46e296c7421855410a08d6d31fe">BAD_ALLOC</a></div><div class="ttdeci">#define BAD_ALLOC()</div><div class="ttdef"><b>Definition</b> DelegateOpt.h:15</div></div>
622+
<div class="ttc" id="a_delegate_opt_8h_html_a5e800c556290ed548055177c33a66f5c"><div class="ttname"><a href="_delegate_opt_8h.html#a5e800c556290ed548055177c33a66f5c">XALLOCATOR</a></div><div class="ttdeci">#define XALLOCATOR</div><div class="ttdef"><b>Definition</b> DelegateOpt.h:46</div></div>
623+
<div class="ttc" id="a_delegate_opt_8h_html_abe89b46e296c7421855410a08d6d31fe"><div class="ttname"><a href="_delegate_opt_8h.html#abe89b46e296c7421855410a08d6d31fe">BAD_ALLOC</a></div><div class="ttdeci">#define BAD_ALLOC()</div><div class="ttdef"><b>Definition</b> DelegateOpt.h:22</div></div>
624624
<div class="ttc" id="aclassdmq_1_1_delegate_3_01_ret_type_07_args_8_8_8_08_4_html_ae036803e39429adf2b2b541b35be5604"><div class="ttname"><a href="classdmq_1_1_delegate_3_01_ret_type_07_args_8_8_8_08_4.html#ae036803e39429adf2b2b541b35be5604">dmq::Delegate&lt; RetType(Args...)&gt;::Clone</a></div><div class="ttdeci">virtual Delegate * Clone() const =0</div><div class="ttdoc">Clone an instance of a Delegate instance.</div></div>
625625
<div class="ttc" id="aclassdmq_1_1_delegate_3_01_ret_type_07_args_8_8_8_08_4_html_af93e05d98b9fa8997ba3163a388af7df"><div class="ttname"><a href="classdmq_1_1_delegate_3_01_ret_type_07_args_8_8_8_08_4.html#af93e05d98b9fa8997ba3163a388af7df">dmq::Delegate&lt; RetType(Args...)&gt;::operator()</a></div><div class="ttdeci">virtual RetType operator()(Args... args)=0</div><div class="ttdoc">Invoke the bound callable function stored within the delegate instance.</div></div>
626626
<div class="ttc" id="aclassdmq_1_1_delegate_base_html"><div class="ttname"><a href="classdmq_1_1_delegate_base.html">dmq::DelegateBase</a></div><div class="ttdoc">Non-template base class for all delegates.</div><div class="ttdef"><b>Definition</b> Delegate.h:30</div></div>

‎docs/html/_delegate_async_8h_source.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -837,8 +837,8 @@
837837
<div class="line"><a id="l00986" name="l00986"></a><span class="lineno"> 986</span> </div>
838838
<div class="line"><a id="l00987" name="l00987"></a><span class="lineno"> 987</span><span class="preprocessor">#endif</span></div>
839839
<div class="ttc" id="a_delegate_8h_html"><div class="ttname"><a href="_delegate_8h.html">Delegate.h</a></div><div class="ttdoc">Delegate series of classes are used to invoke a function synchronously.</div></div>
840-
<div class="ttc" id="a_delegate_opt_8h_html_a9e6c72a4d9879e662d02c096cf16ff3c"><div class="ttname"><a href="_delegate_opt_8h.html#a9e6c72a4d9879e662d02c096cf16ff3c">xlist</a></div><div class="ttdeci">std::list&lt; T, Alloc &gt; xlist</div><div class="ttdef"><b>Definition</b> DelegateOpt.h:33</div></div>
841-
<div class="ttc" id="a_delegate_opt_8h_html_abe89b46e296c7421855410a08d6d31fe"><div class="ttname"><a href="_delegate_opt_8h.html#abe89b46e296c7421855410a08d6d31fe">BAD_ALLOC</a></div><div class="ttdeci">#define BAD_ALLOC()</div><div class="ttdef"><b>Definition</b> DelegateOpt.h:15</div></div>
840+
<div class="ttc" id="a_delegate_opt_8h_html_a9e6c72a4d9879e662d02c096cf16ff3c"><div class="ttname"><a href="_delegate_opt_8h.html#a9e6c72a4d9879e662d02c096cf16ff3c">xlist</a></div><div class="ttdeci">std::list&lt; T, Alloc &gt; xlist</div><div class="ttdef"><b>Definition</b> DelegateOpt.h:40</div></div>
841+
<div class="ttc" id="a_delegate_opt_8h_html_abe89b46e296c7421855410a08d6d31fe"><div class="ttname"><a href="_delegate_opt_8h.html#abe89b46e296c7421855410a08d6d31fe">BAD_ALLOC</a></div><div class="ttdeci">#define BAD_ALLOC()</div><div class="ttdef"><b>Definition</b> DelegateOpt.h:22</div></div>
842842
<div class="ttc" id="a_i_invoker_8h_html"><div class="ttname"><a href="_i_invoker_8h.html">IInvoker.h</a></div><div class="ttdoc">Delegate inter-thread invoker base class.</div></div>
843843
<div class="ttc" id="a_i_thread_8h_html"><div class="ttname"><a href="_i_thread_8h.html">IThread.h</a></div><div class="ttdoc">A base class for a delegate enabled execution thread. Implemented by application code if asynchronous...</div></div>
844844
<div class="ttc" id="aclassdmq_1_1_delegate_async_msg_html"><div class="ttname"><a href="classdmq_1_1_delegate_async_msg.html">dmq::DelegateAsyncMsg</a></div><div class="ttdoc">Stores all function arguments suitable for non-blocking asynchronous calls. Argument data is stored i...</div><div class="ttdef"><b>Definition</b> DelegateAsync.h:82</div></div>

0 commit comments

Comments
 (0)