Skip to content

Commit 8d7344c

Browse files
tsung-wei-huangtsung-wei-huang
committed
updated docs
1 parent 8b0a7eb commit 8d7344c

168 files changed

Lines changed: 1801 additions & 716 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.

‎README.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -780,6 +780,7 @@ The folder `example/` contains several examples and is a great place to learn to
780780
+ Report bugs/issues by submitting a [GitHub issue][GitHub issues]
781781
+ Submit contributions using [pull requests][GitHub pull requests]
782782
+ Learn more about Cpp-Taskflow by reading the [documentation][wiki]
783+
+ Read and cite our [IPDPS19](docs/reference/ipdps19.pdf) paper
783784

784785
# Who is Using Cpp-Taskflow?
785786

‎docs/Cookbook.html‎

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<head>
55
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
66
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
7-
<meta name="generator" content="Doxygen 1.8.13"/>
7+
<meta name="generator" content="Doxygen 1.8.14"/>
88
<meta name="viewport" content="width=device-width, initial-scale=1"/>
99
<title>Cpp-Taskflow</title>
1010
<link href="tabs.css" rel="stylesheet" type="text/css"/>
@@ -16,13 +16,16 @@
1616
<script type="text/javascript" src="navtreedata.js"></script>
1717
<script type="text/javascript" src="navtree.js"></script>
1818
<script type="text/javascript">
19+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
1920
$(document).ready(initResizable);
20-
</script>
21+
/* @license-end */</script>
2122
<link href="search/search.css" rel="stylesheet" type="text/css"/>
2223
<script type="text/javascript" src="search/searchdata.js"></script>
2324
<script type="text/javascript" src="search/search.js"></script>
2425
<script type="text/javascript">
26+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
2527
$(document).ready(function() { init_search(); });
28+
/* @license-end */
2629
</script>
2730
<link href="doxygen.css" rel="stylesheet" type="text/css" />
2831
</head>
@@ -57,9 +60,11 @@
5760
</table>
5861
</div>
5962
<!-- end header part -->
60-
<!-- Generated by Doxygen 1.8.13 -->
63+
<!-- Generated by Doxygen 1.8.14 -->
6164
<script type="text/javascript">
65+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
6266
var searchBox = new SearchBox("searchBox", "search",false,'Search');
67+
/* @license-end */
6368
</script>
6469
</div><!-- top -->
6570
<div id="side-nav" class="ui-resizable side-nav-resizable">
@@ -73,7 +78,9 @@
7378
</div>
7479
</div>
7580
<script type="text/javascript">
81+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
7682
$(document).ready(function(){initNavTree('Cookbook.html','');});
83+
/* @license-end */
7784
</script>
7885
<div id="doc-content">
7986
<!-- window showing the filter options -->
@@ -112,7 +119,7 @@
112119
<ul>
113120
<li class="footer">Generated by
114121
<a href="http://www.doxygen.org/index.html">
115-
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
122+
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.14 </li>
116123
</ul>
117124
</div>
118125
</body>

‎docs/Doxyfile‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -832,6 +832,7 @@ INPUT = ../taskflow/taskflow.hpp \
832832
cookbook/Chapter6.dox \
833833
cookbook/Chapter7.dox \
834834
FAQ.dox \
835+
reference/reference.dox \
835836
header.html
836837

837838
# This tag can be used to specify the character encoding of the source files

‎docs/FAQ.html‎

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<head>
55
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
66
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
7-
<meta name="generator" content="Doxygen 1.8.13"/>
7+
<meta name="generator" content="Doxygen 1.8.14"/>
88
<meta name="viewport" content="width=device-width, initial-scale=1"/>
99
<title>Cpp-Taskflow</title>
1010
<link href="tabs.css" rel="stylesheet" type="text/css"/>
@@ -16,13 +16,16 @@
1616
<script type="text/javascript" src="navtreedata.js"></script>
1717
<script type="text/javascript" src="navtree.js"></script>
1818
<script type="text/javascript">
19+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
1920
$(document).ready(initResizable);
20-
</script>
21+
/* @license-end */</script>
2122
<link href="search/search.css" rel="stylesheet" type="text/css"/>
2223
<script type="text/javascript" src="search/searchdata.js"></script>
2324
<script type="text/javascript" src="search/search.js"></script>
2425
<script type="text/javascript">
26+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
2527
$(document).ready(function() { init_search(); });
28+
/* @license-end */
2629
</script>
2730
<link href="doxygen.css" rel="stylesheet" type="text/css" />
2831
</head>
@@ -57,9 +60,11 @@
5760
</table>
5861
</div>
5962
<!-- end header part -->
60-
<!-- Generated by Doxygen 1.8.13 -->
63+
<!-- Generated by Doxygen 1.8.14 -->
6164
<script type="text/javascript">
65+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
6266
var searchBox = new SearchBox("searchBox", "search",false,'Search');
67+
/* @license-end */
6368
</script>
6469
</div><!-- top -->
6570
<div id="side-nav" class="ui-resizable side-nav-resizable">
@@ -73,7 +78,9 @@
7378
</div>
7479
</div>
7580
<script type="text/javascript">
81+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
7682
$(document).ready(function(){initNavTree('FAQ.html','');});
83+
/* @license-end */
7784
</script>
7885
<div id="doc-content">
7986
<!-- window showing the filter options -->
@@ -147,7 +154,7 @@ <h2><a class="anchor" id="ProgrammingQuestions5"></a>
147154
<ul>
148155
<li class="footer">Generated by
149156
<a href="http://www.doxygen.org/index.html">
150-
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
157+
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.14 </li>
151158
</ul>
152159
</div>
153160
</body>

‎docs/Reference.html‎

Lines changed: 125 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,125 @@
1+
<!-- HTML header for doxygen 1.8.13-->
2+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3+
<html xmlns="http://www.w3.org/1999/xhtml">
4+
<head>
5+
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
6+
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
7+
<meta name="generator" content="Doxygen 1.8.14"/>
8+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
9+
<title>Cpp-Taskflow</title>
10+
<link href="tabs.css" rel="stylesheet" type="text/css"/>
11+
<link rel="icon" type="image/x-icon" href="favicon.ico" />
12+
<script type="text/javascript" src="jquery.js"></script>
13+
<script type="text/javascript" src="dynsections.js"></script>
14+
<link href="navtree.css" rel="stylesheet" type="text/css"/>
15+
<script type="text/javascript" src="resize.js"></script>
16+
<script type="text/javascript" src="navtreedata.js"></script>
17+
<script type="text/javascript" src="navtree.js"></script>
18+
<script type="text/javascript">
19+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
20+
$(document).ready(initResizable);
21+
/* @license-end */</script>
22+
<link href="search/search.css" rel="stylesheet" type="text/css"/>
23+
<script type="text/javascript" src="search/searchdata.js"></script>
24+
<script type="text/javascript" src="search/search.js"></script>
25+
<script type="text/javascript">
26+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
27+
$(document).ready(function() { init_search(); });
28+
/* @license-end */
29+
</script>
30+
<link href="doxygen.css" rel="stylesheet" type="text/css" />
31+
</head>
32+
<body>
33+
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
34+
<div id="titlearea">
35+
<table cellspacing="0" cellpadding="0">
36+
<tbody>
37+
<tr style="height: 56px;">
38+
<td id="projectalign" style="padding-left: 0.5em;">
39+
<div id="projectname"><a href="https://github.com/cpp-taskflow/cpp-taskflow">Cpp-Taskflow</a>
40+
&#160;<span id="projectnumber">2.1.0</span>
41+
</div>
42+
</td>
43+
<td> <div id="MSearchBox" class="MSearchBoxInactive">
44+
<span class="left">
45+
<img id="MSearchSelect" src="search/mag_sel.png"
46+
onmouseover="return searchBox.OnSearchSelectShow()"
47+
onmouseout="return searchBox.OnSearchSelectHide()"
48+
alt=""/>
49+
<input type="text" id="MSearchField" value="Search" accesskey="S"
50+
onfocus="searchBox.OnSearchFieldFocus(true)"
51+
onblur="searchBox.OnSearchFieldFocus(false)"
52+
onkeyup="searchBox.OnSearchFieldChange(event)"/>
53+
</span><span class="right">
54+
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
55+
</span>
56+
</div>
57+
</td>
58+
</tr>
59+
</tbody>
60+
</table>
61+
</div>
62+
<!-- end header part -->
63+
<!-- Generated by Doxygen 1.8.14 -->
64+
<script type="text/javascript">
65+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
66+
var searchBox = new SearchBox("searchBox", "search",false,'Search');
67+
/* @license-end */
68+
</script>
69+
</div><!-- top -->
70+
<div id="side-nav" class="ui-resizable side-nav-resizable">
71+
<div id="nav-tree">
72+
<div id="nav-tree-contents">
73+
<div id="nav-sync" class="sync"></div>
74+
</div>
75+
</div>
76+
<div id="splitbar" style="-moz-user-select:none;"
77+
class="ui-resizable-handle">
78+
</div>
79+
</div>
80+
<script type="text/javascript">
81+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
82+
$(document).ready(function(){initNavTree('Reference.html','');});
83+
/* @license-end */
84+
</script>
85+
<div id="doc-content">
86+
<!-- window showing the filter options -->
87+
<div id="MSearchSelectWindow"
88+
onmouseover="return searchBox.OnSearchSelectShow()"
89+
onmouseout="return searchBox.OnSearchSelectHide()"
90+
onkeydown="return searchBox.OnSearchSelectKey(event)">
91+
</div>
92+
93+
<!-- iframe showing the search results (closed by default) -->
94+
<div id="MSearchResultsWindow">
95+
<iframe src="javascript:void(0)" frameborder="0"
96+
name="MSearchResults" id="MSearchResults">
97+
</iframe>
98+
</div>
99+
100+
<div class="header">
101+
<div class="headertitle">
102+
<div class="title">Reference </div> </div>
103+
</div><!--header-->
104+
<div class="contents">
105+
<div class="textblock"><p>This page summarizes a list of publication related to Cpp-Taskflow. Please cite the article(s) accordingly.</p>
106+
<h1><a class="anchor" id="RefConference"></a>
107+
Conference</h1>
108+
<ol>
109+
<li>
110+
T.-W. Huang, C.-X. Lin, G. Guo, and Martin D. F. Wong, "Cpp-Taskflow: Fast Task-based Parallel Programming using Modern C++," <em>IEEE International Parallel and Distributed Processing Symposium (IPDPS)</em>, Rio de Janeiro, Brazil, 2019. </li>
111+
</ol>
112+
<h1><a class="anchor" id="RefJournal"></a>
113+
Journal</h1>
114+
</div></div><!-- contents -->
115+
</div><!-- doc-content -->
116+
<!-- start footer part -->
117+
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
118+
<ul>
119+
<li class="footer">Generated by
120+
<a href="http://www.doxygen.org/index.html">
121+
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.14 </li>
122+
</ul>
123+
</div>
124+
</body>
125+
</html>

‎docs/Releases.html‎

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<head>
55
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
66
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
7-
<meta name="generator" content="Doxygen 1.8.13"/>
7+
<meta name="generator" content="Doxygen 1.8.14"/>
88
<meta name="viewport" content="width=device-width, initial-scale=1"/>
99
<title>Cpp-Taskflow</title>
1010
<link href="tabs.css" rel="stylesheet" type="text/css"/>
@@ -16,13 +16,16 @@
1616
<script type="text/javascript" src="navtreedata.js"></script>
1717
<script type="text/javascript" src="navtree.js"></script>
1818
<script type="text/javascript">
19+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
1920
$(document).ready(initResizable);
20-
</script>
21+
/* @license-end */</script>
2122
<link href="search/search.css" rel="stylesheet" type="text/css"/>
2223
<script type="text/javascript" src="search/searchdata.js"></script>
2324
<script type="text/javascript" src="search/search.js"></script>
2425
<script type="text/javascript">
26+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
2527
$(document).ready(function() { init_search(); });
28+
/* @license-end */
2629
</script>
2730
<link href="doxygen.css" rel="stylesheet" type="text/css" />
2831
</head>
@@ -57,9 +60,11 @@
5760
</table>
5861
</div>
5962
<!-- end header part -->
60-
<!-- Generated by Doxygen 1.8.13 -->
63+
<!-- Generated by Doxygen 1.8.14 -->
6164
<script type="text/javascript">
65+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
6266
var searchBox = new SearchBox("searchBox", "search",false,'Search');
67+
/* @license-end */
6368
</script>
6469
</div><!-- top -->
6570
<div id="side-nav" class="ui-resizable side-nav-resizable">
@@ -73,7 +78,9 @@
7378
</div>
7479
</div>
7580
<script type="text/javascript">
81+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
7682
$(document).ready(function(){initNavTree('Releases.html','');});
83+
/* @license-end */
7784
</script>
7885
<div id="doc-content">
7986
<!-- window showing the filter options -->
@@ -107,7 +114,7 @@
107114
<ul>
108115
<li class="footer">Generated by
109116
<a href="http://www.doxygen.org/index.html">
110-
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
117+
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.14 </li>
111118
</ul>
112119
</div>
113120
</body>

‎docs/annotated.html‎

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<head>
55
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
66
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
7-
<meta name="generator" content="Doxygen 1.8.13"/>
7+
<meta name="generator" content="Doxygen 1.8.14"/>
88
<meta name="viewport" content="width=device-width, initial-scale=1"/>
99
<title>Cpp-Taskflow</title>
1010
<link href="tabs.css" rel="stylesheet" type="text/css"/>
@@ -16,13 +16,16 @@
1616
<script type="text/javascript" src="navtreedata.js"></script>
1717
<script type="text/javascript" src="navtree.js"></script>
1818
<script type="text/javascript">
19+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
1920
$(document).ready(initResizable);
20-
</script>
21+
/* @license-end */</script>
2122
<link href="search/search.css" rel="stylesheet" type="text/css"/>
2223
<script type="text/javascript" src="search/searchdata.js"></script>
2324
<script type="text/javascript" src="search/search.js"></script>
2425
<script type="text/javascript">
26+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
2527
$(document).ready(function() { init_search(); });
28+
/* @license-end */
2629
</script>
2730
<link href="doxygen.css" rel="stylesheet" type="text/css" />
2831
</head>
@@ -57,9 +60,11 @@
5760
</table>
5861
</div>
5962
<!-- end header part -->
60-
<!-- Generated by Doxygen 1.8.13 -->
63+
<!-- Generated by Doxygen 1.8.14 -->
6164
<script type="text/javascript">
65+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
6266
var searchBox = new SearchBox("searchBox", "search",false,'Search');
67+
/* @license-end */
6368
</script>
6469
</div><!-- top -->
6570
<div id="side-nav" class="ui-resizable side-nav-resizable">
@@ -73,7 +78,9 @@
7378
</div>
7479
</div>
7580
<script type="text/javascript">
81+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
7682
$(document).ready(function(){initNavTree('annotated.html','');});
83+
/* @license-end */
7784
</script>
7885
<div id="doc-content">
7986
<!-- window showing the filter options -->
@@ -118,7 +125,7 @@
118125
<ul>
119126
<li class="footer">Generated by
120127
<a href="http://www.doxygen.org/index.html">
121-
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
128+
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.14 </li>
122129
</ul>
123130
</div>
124131
</body>

0 commit comments

Comments
 (0)