Skip to content

Commit

Permalink
(Commit by workflow script) Update generated documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions committed Jan 10, 2025
1 parent 7dd8886 commit 1d7f8c7
Show file tree
Hide file tree
Showing 1,095 changed files with 14,063 additions and 13,509 deletions.
25 changes: 13 additions & 12 deletions doc/flow_doc/generated/html_full/annotated.html
Original file line number Diff line number Diff line change
Expand Up @@ -184,23 +184,24 @@
<tr id="row_1_6_9_"><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="classflow_1_1util_1_1Duration__units__beautified.html" target="_self">Duration_units_beautified</a></td><td class="desc">Internally used class that enables some of the activities of <a class="el" href="namespaceflow_1_1util.html#a0955a29930075ac1fe393896c089b911" title="Sets certain chrono-related formatting on the given ostream that results in a consistent,...">beautify_chrono_ostream()</a> API </td></tr>
<tr id="row_1_6_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="classflow_1_1util_1_1Linked__hash__map.html" target="_self">Linked_hash_map</a></td><td class="desc">An object of this class is a map that combines the lookup speed of a <code>boost::unordered_map&lt;&gt;</code> and ordering and iterator stability capabilities of an <code>std::list&lt;&gt;</code> </td></tr>
<tr id="row_1_6_11_"><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="classflow_1_1util_1_1Linked__hash__set.html" target="_self">Linked_hash_set</a></td><td class="desc">An object of this class is a set that combines the lookup speed of an <code>unordered_set&lt;&gt;</code> and ordering and iterator stability capabilities of an <code>std::list&lt;&gt;</code> </td></tr>
<tr id="row_1_6_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="classflow_1_1util_1_1Null__interface.html" target="_self">Null_interface</a></td><td class="desc">An empty interface, consisting of nothing but a default <code>virtual</code> destructor, intended as a boiler-plate-reducing base for any other (presumably <code>virtual</code>-method-having) class that would otherwise require a default <code>virtual</code> destructor </td></tr>
<tr id="row_1_6_13_"><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="classflow_1_1util_1_1Rnd__gen__uniform__range.html" target="_self">Rnd_gen_uniform_range</a></td><td class="desc">Simple, non-thread-safe uniform-range random number generator </td></tr>
<tr id="row_1_6_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="classflow_1_1util_1_1Rnd__gen__uniform__range__base.html" target="_self">Rnd_gen_uniform_range_base</a></td><td class="desc">Base class for <a class="el" href="classflow_1_1util_1_1Rnd__gen__uniform__range.html" title="Simple, non-thread-safe uniform-range random number generator.">Rnd_gen_uniform_range</a> and <a class="el" href="classflow_1_1util_1_1Rnd__gen__uniform__range__mt.html" title="Identical to Rnd_gen_uniform_range but safe for concurrent RNG given a single object.">Rnd_gen_uniform_range_mt</a> for various aliases and similar, so template arguments need not be involved </td></tr>
<tr id="row_1_6_15_"><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="classflow_1_1util_1_1Rnd__gen__uniform__range__mt.html" target="_self">Rnd_gen_uniform_range_mt</a></td><td class="desc">Identical to <a class="el" href="classflow_1_1util_1_1Rnd__gen__uniform__range.html" title="Simple, non-thread-safe uniform-range random number generator.">Rnd_gen_uniform_range</a> but safe for concurrent RNG given a single object </td></tr>
<tr id="row_1_6_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="structflow_1_1util_1_1Scheduled__task__handle__state.html" target="_self">Scheduled_task_handle_state</a></td><td class="desc">Internal-use data store used by <code>schedule[d]_task_*()</code>, each object containing the state relevant to a single call to either <a class="el" href="namespaceflow_1_1util.html#a74d4a66fb00055be4e1bd6ee98e04667" title="Schedule the given function to execute in a certain amount of time: A handy wrapper around Timer (asi...">schedule_task_from_now()</a> or <a class="el" href="namespaceflow_1_1util.html#aad8c8f7335eb892350dc386cb4be397e" title="Identical to schedule_task_from_now() except the time is specified in absolute terms.">schedule_task_at()</a> </td></tr>
<tr id="row_1_6_17_"><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="classflow_1_1util_1_1Scoped__setter.html" target="_self">Scoped_setter</a></td><td class="desc">A simple RAII-pattern class template that, at construction, sets the specified location in memory to a specified value, memorizing the previous contents; and at destruction restores the value </td></tr>
<tr id="row_1_6_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="classflow_1_1util_1_1Shared__ptr__alias__holder.html" target="_self">Shared_ptr_alias_holder</a></td><td class="desc">Convenience class template that endows the given subclass <code>T</code> with nested aliases <code>Ptr</code> and <code>Const_ptr</code> aliased to <code>shared_ptr&lt;T&gt;</code> and <code>shared_ptr&lt;const T&gt;</code> respectively </td></tr>
<tr id="row_1_6_19_"><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="classflow_1_1util_1_1String__ostream.html" target="_self">String_ostream</a></td><td class="desc">Similar to <code>ostringstream</code> but allows fast read-only access directly into the <code>std::string</code> being written; and some limited write access to that string </td></tr>
<tr id="row_1_6_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="classflow_1_1util_1_1Unique__id__holder.html" target="_self">Unique_id_holder</a></td><td class="desc">Each object of this class stores (at construction) and returns (on demand) a numeric ID unique from all other objects of the same class ever constructed, across all time from program start to end </td></tr>
<tr id="row_1_7_"><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="classflow_1_1Function.html" target="_self">Function</a></td><td class="desc"></td></tr>
<tr id="row_1_8_" 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="classflow_1_1Function_3_01Result_07Args_8_8_8_08_4.html" target="_self">Function&lt; Result(Args...)&gt;</a></td><td class="desc">Intended as the polymorphic function wrapper of choice for Flow, internally and externally; to be used instead of <code>std::function</code> or <code>boost::function</code> </td></tr>
<tr id="row_1_6_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="structflow_1_1util_1_1Noncopyable.html" target="_self">Noncopyable</a></td><td class="desc">Useful as a no-unique-address private member to make a type noncopyable while keeping that type an aggregate (can be direct-initialized) </td></tr>
<tr id="row_1_6_13_"><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="classflow_1_1util_1_1Null__interface.html" target="_self">Null_interface</a></td><td class="desc">An empty interface, consisting of nothing but a default <code>virtual</code> destructor, intended as a boiler-plate-reducing base for any other (presumably <code>virtual</code>-method-having) class that would otherwise require a default <code>virtual</code> destructor </td></tr>
<tr id="row_1_6_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="classflow_1_1util_1_1Rnd__gen__uniform__range.html" target="_self">Rnd_gen_uniform_range</a></td><td class="desc">Simple, non-thread-safe uniform-range random number generator </td></tr>
<tr id="row_1_6_15_"><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="classflow_1_1util_1_1Rnd__gen__uniform__range__base.html" target="_self">Rnd_gen_uniform_range_base</a></td><td class="desc">Base class for <a class="el" href="classflow_1_1util_1_1Rnd__gen__uniform__range.html" title="Simple, non-thread-safe uniform-range random number generator.">Rnd_gen_uniform_range</a> and <a class="el" href="classflow_1_1util_1_1Rnd__gen__uniform__range__mt.html" title="Identical to Rnd_gen_uniform_range but safe for concurrent RNG given a single object.">Rnd_gen_uniform_range_mt</a> for various aliases and similar, so template arguments need not be involved </td></tr>
<tr id="row_1_6_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="classflow_1_1util_1_1Rnd__gen__uniform__range__mt.html" target="_self">Rnd_gen_uniform_range_mt</a></td><td class="desc">Identical to <a class="el" href="classflow_1_1util_1_1Rnd__gen__uniform__range.html" title="Simple, non-thread-safe uniform-range random number generator.">Rnd_gen_uniform_range</a> but safe for concurrent RNG given a single object </td></tr>
<tr id="row_1_6_17_"><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="structflow_1_1util_1_1Scheduled__task__handle__state.html" target="_self">Scheduled_task_handle_state</a></td><td class="desc">Internal-use data store used by <code>schedule[d]_task_*()</code>, each object containing the state relevant to a single call to either <a class="el" href="namespaceflow_1_1util.html#a74d4a66fb00055be4e1bd6ee98e04667" title="Schedule the given function to execute in a certain amount of time: A handy wrapper around Timer (asi...">schedule_task_from_now()</a> or <a class="el" href="namespaceflow_1_1util.html#aad8c8f7335eb892350dc386cb4be397e" title="Identical to schedule_task_from_now() except the time is specified in absolute terms.">schedule_task_at()</a> </td></tr>
<tr id="row_1_6_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="classflow_1_1util_1_1Scoped__setter.html" target="_self">Scoped_setter</a></td><td class="desc">A simple RAII-pattern class template that, at construction, sets the specified location in memory to a specified value, memorizing the previous contents; and at destruction restores the value </td></tr>
<tr id="row_1_6_19_"><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="classflow_1_1util_1_1Shared__ptr__alias__holder.html" target="_self">Shared_ptr_alias_holder</a></td><td class="desc">Convenience class template that endows the given subclass <code>T</code> with nested aliases <code>Ptr</code> and <code>Const_ptr</code> aliased to <code>shared_ptr&lt;T&gt;</code> and <code>shared_ptr&lt;const T&gt;</code> respectively </td></tr>
<tr id="row_1_6_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="classflow_1_1util_1_1String__ostream.html" target="_self">String_ostream</a></td><td class="desc">Similar to <code>ostringstream</code> but allows fast read-only access directly into the <code>std::string</code> being written; and some limited write access to that string </td></tr>
<tr id="row_1_6_21_"><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="classflow_1_1util_1_1Unique__id__holder.html" target="_self">Unique_id_holder</a></td><td class="desc">Each object of this class stores (at construction) and returns (on demand) a numeric ID unique from all other objects of the same class ever constructed, across all time from program start to end </td></tr>
<tr id="row_1_7_" 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="classflow_1_1Function.html" target="_self">Function</a></td><td class="desc"></td></tr>
<tr id="row_1_8_"><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="classflow_1_1Function_3_01Result_07Args_8_8_8_08_4.html" target="_self">Function&lt; Result(Args...)&gt;</a></td><td class="desc">Intended as the polymorphic function wrapper of choice for Flow, internally and externally; to be used instead of <code>std::function</code> or <code>boost::function</code> </td></tr>
</table>
</div><!-- directory -->
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Dec 11 2024 04:03:16 for Flow by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
Generated on Fri Jan 10 2025 20:12:45 for Flow by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
</small></address>
</body>
</html>
2 changes: 1 addition & 1 deletion doc/flow_doc/generated/html_full/asio_2node_8cpp.html
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Dec 11 2024 04:03:15 for Flow by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
Generated on Fri Jan 10 2025 20:12:44 for Flow by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
</small></address>
</body>
</html>
4 changes: 2 additions & 2 deletions doc/flow_doc/generated/html_full/asio_2node_8cpp_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -138,12 +138,12 @@
<div class="ttc" id="anamespaceflow_1_1net__flow_1_1asio_html"><div class="ttname"><a href="namespaceflow_1_1net__flow_1_1asio.html">flow::net_flow::asio</a></div><div class="ttdoc">Contains classes that add boost.asio integration to the main Flow-protocol classes such as net_flow::...</div><div class="ttdef"><b>Definition:</b> <a href="asio_2node_8cpp_source.html#l00024">node.cpp:25</a></div></div>
<div class="ttc" id="anamespaceflow_1_1util_html_adf23368210219716b6fd22d15b765cb6"><div class="ttname"><a href="namespaceflow_1_1util.html#adf23368210219716b6fd22d15b765cb6">flow::util::Task_engine</a></div><div class="ttdeci">boost::asio::io_service Task_engine</div><div class="ttdoc">Short-hand for boost.asio event service, the central class of boost.asio.</div><div class="ttdef"><b>Definition:</b> <a href="util__fwd_8hpp_source.html#l00135">util_fwd.hpp:135</a></div></div>
<div class="ttc" id="anamespaceflow_1_1util_html_af1b28edb7bad743c1c77f6b982cc3196"><div class="ttname"><a href="namespaceflow_1_1util.html#af1b28edb7bad743c1c77f6b982cc3196">flow::util::Udp_endpoint</a></div><div class="ttdeci">boost::asio::ip::udp::endpoint Udp_endpoint</div><div class="ttdoc">Short-hand for the UDP endpoint (IP/port) type.</div><div class="ttdef"><b>Definition:</b> <a href="util__fwd_8hpp_source.html#l00208">util_fwd.hpp:208</a></div></div>
<div class="ttc" id="anamespaceflow_html_a29eaaa9d0fac4ce87d8b969222dbed09"><div class="ttname"><a href="namespaceflow.html#a29eaaa9d0fac4ce87d8b969222dbed09">flow::Error_code</a></div><div class="ttdeci">boost::system::error_code Error_code</div><div class="ttdoc">Short-hand for a boost.system error code (which basically encapsulates an integer/enum error code and...</div><div class="ttdef"><b>Definition:</b> <a href="common_8hpp_source.html#l00503">common.hpp:503</a></div></div>
<div class="ttc" id="anamespaceflow_html_a29eaaa9d0fac4ce87d8b969222dbed09"><div class="ttname"><a href="namespaceflow.html#a29eaaa9d0fac4ce87d8b969222dbed09">flow::Error_code</a></div><div class="ttdeci">boost::system::error_code Error_code</div><div class="ttdoc">Short-hand for a boost.system error code (which basically encapsulates an integer/enum error code and...</div><div class="ttdef"><b>Definition:</b> <a href="common_8hpp_source.html#l00508">common.hpp:508</a></div></div>
<div class="ttc" id="astructflow_1_1net__flow_1_1Node__options_html"><div class="ttname"><a href="structflow_1_1net__flow_1_1Node__options.html">flow::net_flow::Node_options</a></div><div class="ttdoc">A set of low-level options affecting a single Flow Node, including Peer_socket objects and other obje...</div><div class="ttdef"><b>Definition:</b> <a href="options_8hpp_source.html#l00448">options.hpp:449</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Dec 11 2024 04:03:15 for Flow by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
Generated on Fri Jan 10 2025 20:12:44 for Flow by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
</small></address>
</body>
</html>
2 changes: 1 addition & 1 deletion doc/flow_doc/generated/html_full/asio_2node_8hpp.html
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Dec 11 2024 04:03:15 for Flow by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
Generated on Fri Jan 10 2025 20:12:44 for Flow by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
</small></address>
</body>
</html>
Loading

0 comments on commit 1d7f8c7

Please sign in to comment.