Skip to content

Commit e37009d

Browse files
gilzoidegilzoide
committed
Add docs
1 parent e686c62 commit e37009d

143 files changed

Lines changed: 13305 additions & 0 deletions

File tree

Some content is hidden

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

‎docs/annotated.html‎

Lines changed: 138 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,138 @@
1+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2+
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
3+
<head>
4+
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5+
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
6+
<meta name="generator" content="Doxygen 1.13.2"/>
7+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
8+
<title>Dispatch Queue: Class List</title>
9+
<link href="tabs.css" rel="stylesheet" type="text/css"/>
10+
<script type="text/javascript" src="jquery.js"></script>
11+
<script type="text/javascript" src="dynsections.js"></script>
12+
<script type="text/javascript" src="clipboard.js"></script>
13+
<link href="navtree.css" rel="stylesheet" type="text/css"/>
14+
<script type="text/javascript" src="navtreedata.js"></script>
15+
<script type="text/javascript" src="navtree.js"></script>
16+
<script type="text/javascript" src="resize.js"></script>
17+
<script type="text/javascript" src="cookie.js"></script>
18+
<link href="search/search.css" rel="stylesheet" type="text/css"/>
19+
<script type="text/javascript" src="search/searchdata.js"></script>
20+
<script type="text/javascript" src="search/search.js"></script>
21+
<script type="text/javascript">
22+
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
23+
$(function() { init_search(); });
24+
/* @license-end */
25+
</script>
26+
<link href="doxygen.css" rel="stylesheet" type="text/css" />
27+
</head>
28+
<body>
29+
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
30+
<div id="titlearea">
31+
<table cellspacing="0" cellpadding="0">
32+
<tbody>
33+
<tr id="projectrow">
34+
<td id="projectalign">
35+
<div id="projectname">Dispatch Queue
36+
</div>
37+
<div id="projectbrief">Dispatch Queue / Thread Pool implementation for C++11 with built-in C++20 coroutine support</div>
38+
</td>
39+
<td> <div id="MSearchBox" class="MSearchBoxInactive">
40+
<span class="left">
41+
<span id="MSearchSelect" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
42+
<input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
43+
onfocus="searchBox.OnSearchFieldFocus(true)"
44+
onblur="searchBox.OnSearchFieldFocus(false)"
45+
onkeyup="searchBox.OnSearchFieldChange(event)"/>
46+
</span><span class="right">
47+
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
48+
</span>
49+
</div>
50+
</td>
51+
</tr>
52+
</tbody>
53+
</table>
54+
</div>
55+
<!-- end header part -->
56+
<!-- Generated by Doxygen 1.13.2 -->
57+
<script type="text/javascript">
58+
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
59+
var searchBox = new SearchBox("searchBox", "search/",'.html');
60+
/* @license-end */
61+
</script>
62+
<script type="text/javascript">
63+
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
64+
$(function() { codefold.init(0); });
65+
/* @license-end */
66+
</script>
67+
</div><!-- top -->
68+
<div id="side-nav" class="ui-resizable side-nav-resizable">
69+
<div id="nav-tree">
70+
<div id="nav-tree-contents">
71+
<div id="nav-sync" class="sync"></div>
72+
</div>
73+
</div>
74+
<div id="splitbar" style="-moz-user-select:none;"
75+
class="ui-resizable-handle">
76+
</div>
77+
</div>
78+
<script type="text/javascript">
79+
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
80+
$(function(){initNavTree('annotated.html',''); initResizable(true); });
81+
/* @license-end */
82+
</script>
83+
<div id="doc-content">
84+
<!-- window showing the filter options -->
85+
<div id="MSearchSelectWindow"
86+
onmouseover="return searchBox.OnSearchSelectShow()"
87+
onmouseout="return searchBox.OnSearchSelectHide()"
88+
onkeydown="return searchBox.OnSearchSelectKey(event)">
89+
</div>
90+
91+
<!-- iframe showing the search results (closed by default) -->
92+
<div id="MSearchResultsWindow">
93+
<div id="MSearchResults">
94+
<div class="SRPage">
95+
<div id="SRIndex">
96+
<div id="SRResults"></div>
97+
<div class="SRStatus" id="Loading">Loading...</div>
98+
<div class="SRStatus" id="Searching">Searching...</div>
99+
<div class="SRStatus" id="NoMatches">No Matches</div>
100+
</div>
101+
</div>
102+
</div>
103+
</div>
104+
105+
<div class="header">
106+
<div class="headertitle"><div class="title">Class List</div></div>
107+
</div><!--header-->
108+
<div class="contents">
109+
<div class="textblock">Here are the classes, structs, unions and interfaces with brief descriptions:</div><div class="directory">
110+
<div class="levels">[detail level <span onclick="javascript:dynsection.toggleLevel(1);">1</span><span onclick="javascript:dynsection.toggleLevel(2);">2</span><span onclick="javascript:dynsection.toggleLevel(3);">3</span><span onclick="javascript:dynsection.toggleLevel(4);">4</span>]</div><table class="directory">
111+
<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="dynsection.toggleFolder('0_')">&#9660;</span><span class="icona"><span class="icon">N</span></span><b>dispatch_queue</b></td><td class="desc"></td></tr>
112+
<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="dynsection.toggleFolder('0_0_')">&#9660;</span><span class="icona"><span class="icon">N</span></span><b>detail</b></td><td class="desc"></td></tr>
113+
<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="structdispatch__queue_1_1detail_1_1is__instance__of.html" target="_self">is_instance_of</a></td><td class="desc"></td></tr>
114+
<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="structdispatch__queue_1_1detail_1_1is__instance__of_3_01_u_3_01_vs_8_8_8_01_4_00_01_u_01_4.html" target="_self">is_instance_of&lt; U&lt; Vs... &gt;, U &gt;</a></td><td class="desc"></td></tr>
115+
<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="classdispatch__queue_1_1detail_1_1pending__task__queue.html" target="_self">pending_task_queue</a></td><td class="desc"></td></tr>
116+
<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="classdispatch__queue_1_1detail_1_1promise.html" target="_self">promise</a></td><td class="desc"></td></tr>
117+
<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="classdispatch__queue_1_1detail_1_1promise_3_01void_01_4.html" target="_self">promise&lt; void &gt;</a></td><td class="desc"></td></tr>
118+
<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="classdispatch__queue_1_1detail_1_1task__future.html" target="_self">task_future</a></td><td class="desc"></td></tr>
119+
<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="classdispatch__queue_1_1detail_1_1task__future_3_01void_01_4.html" target="_self">task_future&lt; void &gt;</a></td><td class="desc"></td></tr>
120+
<tr id="row_0_0_7_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span id="arr_0_0_7_" class="arrow" onclick="dynsection.toggleFolder('0_0_7_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classdispatch__queue_1_1detail_1_1task__future__base.html" target="_self">task_future_base</a></td><td class="desc"></td></tr>
121+
<tr id="row_0_0_7_0_" class="even"><td class="entry"><span style="width:64px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structdispatch__queue_1_1detail_1_1task__future__base_1_1private__construct.html" target="_self">private_construct</a></td><td class="desc"></td></tr>
122+
<tr id="row_0_0_8_" 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="classdispatch__queue_1_1detail_1_1worker__pool.html" target="_self">worker_pool</a></td><td class="desc"></td></tr>
123+
<tr id="row_0_1_" 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="classdispatch__queue_1_1dispatch__queue.html" target="_self">dispatch_queue</a></td><td class="desc"></td></tr>
124+
<tr id="row_0_2_" 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="classdispatch__queue_1_1task.html" target="_self">task</a></td><td class="desc"></td></tr>
125+
<tr id="row_1_" class="even"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_1_" class="arrow" onclick="dynsection.toggleFolder('1_')">&#9660;</span><span class="icona"><span class="icon">N</span></span><b>std</b></td><td class="desc"></td></tr>
126+
<tr id="row_1_0_" 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="structstd_1_1coroutine__traits_3_01dispatch__queue_1_1task_3_01_t_01_4_00_01_args_8_8_8_01_4.html" target="_self">coroutine_traits&lt; dispatch_queue::task&lt; T &gt;, Args... &gt;</a></td><td class="desc"></td></tr>
127+
</table>
128+
</div><!-- directory -->
129+
</div><!-- contents -->
130+
</div><!-- doc-content -->
131+
<!-- start footer part -->
132+
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
133+
<ul>
134+
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.13.2 </li>
135+
</ul>
136+
</div>
137+
</body>
138+
</html>

‎docs/annotated_dup.js‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
var annotated_dup =
2+
[
3+
[ "dispatch_queue", null, [
4+
[ "detail", null, [
5+
[ "is_instance_of", "structdispatch__queue_1_1detail_1_1is__instance__of.html", null ],
6+
[ "is_instance_of< U< Vs... >, U >", "structdispatch__queue_1_1detail_1_1is__instance__of_3_01_u_3_01_vs_8_8_8_01_4_00_01_u_01_4.html", null ],
7+
[ "pending_task_queue", "classdispatch__queue_1_1detail_1_1pending__task__queue.html", null ],
8+
[ "promise", "classdispatch__queue_1_1detail_1_1promise.html", null ],
9+
[ "promise< void >", "classdispatch__queue_1_1detail_1_1promise_3_01void_01_4.html", null ],
10+
[ "task_future", "classdispatch__queue_1_1detail_1_1task__future.html", null ],
11+
[ "task_future< void >", "classdispatch__queue_1_1detail_1_1task__future_3_01void_01_4.html", null ],
12+
[ "task_future_base", "classdispatch__queue_1_1detail_1_1task__future__base.html", "classdispatch__queue_1_1detail_1_1task__future__base" ],
13+
[ "worker_pool", "classdispatch__queue_1_1detail_1_1worker__pool.html", null ]
14+
] ],
15+
[ "dispatch_queue", "classdispatch__queue_1_1dispatch__queue.html", "classdispatch__queue_1_1dispatch__queue" ],
16+
[ "task", "classdispatch__queue_1_1task.html", "classdispatch__queue_1_1task" ]
17+
] ],
18+
[ "std", null, [
19+
[ "coroutine_traits< dispatch_queue::task< T >, Args... >", "structstd_1_1coroutine__traits_3_01dispatch__queue_1_1task_3_01_t_01_4_00_01_args_8_8_8_01_4.html", null ]
20+
] ]
21+
];

‎docs/bc_s.png‎

676 Bytes
Loading

‎docs/bc_sd.png‎

635 Bytes
Loading

‎docs/classdispatch__queue_1_1detail_1_1pending__task__queue-members.html‎

Lines changed: 127 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,127 @@
1+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2+
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
3+
<head>
4+
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5+
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
6+
<meta name="generator" content="Doxygen 1.13.2"/>
7+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
8+
<title>Dispatch Queue: Member List</title>
9+
<link href="tabs.css" rel="stylesheet" type="text/css"/>
10+
<script type="text/javascript" src="jquery.js"></script>
11+
<script type="text/javascript" src="dynsections.js"></script>
12+
<script type="text/javascript" src="clipboard.js"></script>
13+
<link href="navtree.css" rel="stylesheet" type="text/css"/>
14+
<script type="text/javascript" src="navtreedata.js"></script>
15+
<script type="text/javascript" src="navtree.js"></script>
16+
<script type="text/javascript" src="resize.js"></script>
17+
<script type="text/javascript" src="cookie.js"></script>
18+
<link href="search/search.css" rel="stylesheet" type="text/css"/>
19+
<script type="text/javascript" src="search/searchdata.js"></script>
20+
<script type="text/javascript" src="search/search.js"></script>
21+
<script type="text/javascript">
22+
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
23+
$(function() { init_search(); });
24+
/* @license-end */
25+
</script>
26+
<link href="doxygen.css" rel="stylesheet" type="text/css" />
27+
</head>
28+
<body>
29+
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
30+
<div id="titlearea">
31+
<table cellspacing="0" cellpadding="0">
32+
<tbody>
33+
<tr id="projectrow">
34+
<td id="projectalign">
35+
<div id="projectname">Dispatch Queue
36+
</div>
37+
<div id="projectbrief">Dispatch Queue / Thread Pool implementation for C++11 with built-in C++20 coroutine support</div>
38+
</td>
39+
<td> <div id="MSearchBox" class="MSearchBoxInactive">
40+
<span class="left">
41+
<span id="MSearchSelect" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
42+
<input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
43+
onfocus="searchBox.OnSearchFieldFocus(true)"
44+
onblur="searchBox.OnSearchFieldFocus(false)"
45+
onkeyup="searchBox.OnSearchFieldChange(event)"/>
46+
</span><span class="right">
47+
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
48+
</span>
49+
</div>
50+
</td>
51+
</tr>
52+
</tbody>
53+
</table>
54+
</div>
55+
<!-- end header part -->
56+
<!-- Generated by Doxygen 1.13.2 -->
57+
<script type="text/javascript">
58+
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
59+
var searchBox = new SearchBox("searchBox", "search/",'.html');
60+
/* @license-end */
61+
</script>
62+
<script type="text/javascript">
63+
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
64+
$(function() { codefold.init(0); });
65+
/* @license-end */
66+
</script>
67+
</div><!-- top -->
68+
<div id="side-nav" class="ui-resizable side-nav-resizable">
69+
<div id="nav-tree">
70+
<div id="nav-tree-contents">
71+
<div id="nav-sync" class="sync"></div>
72+
</div>
73+
</div>
74+
<div id="splitbar" style="-moz-user-select:none;"
75+
class="ui-resizable-handle">
76+
</div>
77+
</div>
78+
<script type="text/javascript">
79+
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
80+
$(function(){initNavTree('classdispatch__queue_1_1detail_1_1pending__task__queue.html',''); initResizable(true); });
81+
/* @license-end */
82+
</script>
83+
<div id="doc-content">
84+
<!-- window showing the filter options -->
85+
<div id="MSearchSelectWindow"
86+
onmouseover="return searchBox.OnSearchSelectShow()"
87+
onmouseout="return searchBox.OnSearchSelectHide()"
88+
onkeydown="return searchBox.OnSearchSelectKey(event)">
89+
</div>
90+
91+
<!-- iframe showing the search results (closed by default) -->
92+
<div id="MSearchResultsWindow">
93+
<div id="MSearchResults">
94+
<div class="SRPage">
95+
<div id="SRIndex">
96+
<div id="SRResults"></div>
97+
<div class="SRStatus" id="Loading">Loading...</div>
98+
<div class="SRStatus" id="Searching">Searching...</div>
99+
<div class="SRStatus" id="NoMatches">No Matches</div>
100+
</div>
101+
</div>
102+
</div>
103+
</div>
104+
105+
<div class="header">
106+
<div class="headertitle"><div class="title">dispatch_queue::detail::pending_task_queue Member List</div></div>
107+
</div><!--header-->
108+
<div class="contents">
109+
110+
<p>This is the complete list of members for <a class="el" href="classdispatch__queue_1_1detail_1_1pending__task__queue.html">dispatch_queue::detail::pending_task_queue</a>, including all inherited members.</p>
111+
<table class="directory">
112+
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>clear</b>() (defined in <a class="el" href="classdispatch__queue_1_1detail_1_1pending__task__queue.html">dispatch_queue::detail::pending_task_queue</a>)</td><td class="entry"><a class="el" href="classdispatch__queue_1_1detail_1_1pending__task__queue.html">dispatch_queue::detail::pending_task_queue</a></td><td class="entry"></td></tr>
113+
<tr bgcolor="#f0f0f0" class="odd"><td class="entry"><b>empty</b>() const (defined in <a class="el" href="classdispatch__queue_1_1detail_1_1pending__task__queue.html">dispatch_queue::detail::pending_task_queue</a>)</td><td class="entry"><a class="el" href="classdispatch__queue_1_1detail_1_1pending__task__queue.html">dispatch_queue::detail::pending_task_queue</a></td><td class="entry"></td></tr>
114+
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>pop_main_loop_tasks</b>() (defined in <a class="el" href="classdispatch__queue_1_1detail_1_1pending__task__queue.html">dispatch_queue::detail::pending_task_queue</a>)</td><td class="entry"><a class="el" href="classdispatch__queue_1_1detail_1_1pending__task__queue.html">dispatch_queue::detail::pending_task_queue</a></td><td class="entry"></td></tr>
115+
<tr bgcolor="#f0f0f0" class="odd"><td class="entry"><b>push</b>(pending_task &amp;&amp;task, bool run_on_main_loop) (defined in <a class="el" href="classdispatch__queue_1_1detail_1_1pending__task__queue.html">dispatch_queue::detail::pending_task_queue</a>)</td><td class="entry"><a class="el" href="classdispatch__queue_1_1detail_1_1pending__task__queue.html">dispatch_queue::detail::pending_task_queue</a></td><td class="entry"></td></tr>
116+
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>size</b>() const (defined in <a class="el" href="classdispatch__queue_1_1detail_1_1pending__task__queue.html">dispatch_queue::detail::pending_task_queue</a>)</td><td class="entry"><a class="el" href="classdispatch__queue_1_1detail_1_1pending__task__queue.html">dispatch_queue::detail::pending_task_queue</a></td><td class="entry"></td></tr>
117+
<tr bgcolor="#f0f0f0" class="odd"><td class="entry"><b>try_pop</b>(pending_task &amp;task) (defined in <a class="el" href="classdispatch__queue_1_1detail_1_1pending__task__queue.html">dispatch_queue::detail::pending_task_queue</a>)</td><td class="entry"><a class="el" href="classdispatch__queue_1_1detail_1_1pending__task__queue.html">dispatch_queue::detail::pending_task_queue</a></td><td class="entry"></td></tr>
118+
</table></div><!-- contents -->
119+
</div><!-- doc-content -->
120+
<!-- start footer part -->
121+
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
122+
<ul>
123+
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.13.2 </li>
124+
</ul>
125+
</div>
126+
</body>
127+
</html>

0 commit comments

Comments
 (0)