Skip to content

Commit

Permalink
Updating docs
Browse files Browse the repository at this point in the history
  • Loading branch information
StellarBot committed Jan 2, 2018
1 parent 1e60b6a commit 2115ef9
Show file tree
Hide file tree
Showing 745 changed files with 6,329 additions and 5,299 deletions.
3 changes: 2 additions & 1 deletion docs/html/HPX_DECLARE_PLAIN_ACTION.html
View file
Expand Up @@ -28,7 +28,8 @@ <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="re
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright &#169; 2011-2017 The STE||AR Group (http://stellar-group.org)<p>
<td align="right"><div class="copyright-footer">Copyright &#169; 2011-2018 The STE||AR Group
(http://stellar-group.org)<p>
Distributed under the Boost Software License, Version 1.0. (See accompanying
file <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">LICENSE_1_0.txt</a>
or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
Expand Down
5 changes: 3 additions & 2 deletions docs/html/HPX_DEFINE_COMPONENT_ACTION.html
View file
Expand Up @@ -26,7 +26,7 @@ <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="re

</span>HPX_DEFINE_COMPONENT_ACTION(...)</pre></div>
<div class="refsect1">
<a name="idm140562001364128"></a><h2>Description</h2>
<a name="idm140330173370928"></a><h2>Description</h2>
<p>The macro <span class="emphasis"><em>HPX_DEFINE_COMPONENT_ACTION</em></span> can be used to register a member function of a component as an action type named <span class="emphasis"><em>action_type</em></span>.</p>
<p>The parameter <span class="emphasis"><em>component</em></span> is the type of the component exposing the member function <span class="emphasis"><em>func</em></span> which should be associated with the newly defined action type. The parameter <code class="computeroutput">action_type</code> is the name of the action type to register with HPX.</p>
<p><b>Example:&#160;</b></p>
Expand Down Expand Up @@ -66,7 +66,8 @@ <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="re
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright &#169; 2011-2017 The STE||AR Group (http://stellar-group.org)<p>
<td align="right"><div class="copyright-footer">Copyright &#169; 2011-2018 The STE||AR Group
(http://stellar-group.org)<p>
Distributed under the Boost Software License, Version 1.0. (See accompanying
file <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">LICENSE_1_0.txt</a>
or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
Expand Down
5 changes: 3 additions & 2 deletions docs/html/HPX_DEFINE_PLAIN_ACTION.html
View file
Expand Up @@ -26,7 +26,7 @@ <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="re

</span>HPX_DEFINE_PLAIN_ACTION(...)</pre></div>
<div class="refsect1">
<a name="idm140562001304000"></a><h2>Description</h2>
<a name="idm140330173310912"></a><h2>Description</h2>
<p><b>Example:&#160;</b></p>
<p>
</p>
Expand Down Expand Up @@ -59,7 +59,8 @@ <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="re
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright &#169; 2011-2017 The STE||AR Group (http://stellar-group.org)<p>
<td align="right"><div class="copyright-footer">Copyright &#169; 2011-2018 The STE||AR Group
(http://stellar-group.org)<p>
Distributed under the Boost Software License, Version 1.0. (See accompanying
file <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">LICENSE_1_0.txt</a>
or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
Expand Down
5 changes: 3 additions & 2 deletions docs/html/HPX_PLAIN_ACTION.html
View file
Expand Up @@ -26,7 +26,7 @@ <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="re

</span>HPX_PLAIN_ACTION(...)</pre></div>
<div class="refsect1">
<a name="idm140562001267152"></a><h2>Description</h2>
<a name="idm140330173274064"></a><h2>Description</h2>
<p>The macro <span class="emphasis"><em>HPX_PLAIN_ACTION</em></span> can be used to define a plain action (e.g. an action encapsulating a global or free function) based on the given function <span class="emphasis"><em>func</em></span>. It defines the action type <span class="emphasis"><em>name</em></span> representing the given function. This macro additionally registers the newly define action type with HPX.</p>
<p>The parameter <code class="computeroutput">func</code> is a global or free (non-member) function which should be encapsulated into a plain action. The parameter <code class="computeroutput">name</code> is the name of the action type defined by this macro.</p>
<p><b>Example:&#160;</b></p>
Expand Down Expand Up @@ -62,7 +62,8 @@ <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="re
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright &#169; 2011-2017 The STE||AR Group (http://stellar-group.org)<p>
<td align="right"><div class="copyright-footer">Copyright &#169; 2011-2018 The STE||AR Group
(http://stellar-group.org)<p>
Distributed under the Boost Software License, Version 1.0. (See accompanying
file <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">LICENSE_1_0.txt</a>
or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
Expand Down
5 changes: 3 additions & 2 deletions docs/html/HPX_PLAIN_ACTION_ID.html
View file
Expand Up @@ -26,7 +26,7 @@ <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="re

</span>HPX_PLAIN_ACTION_ID(func, name, id)</pre></div>
<div class="refsect1">
<a name="idm140562001228160"></a><h2>Description</h2>
<a name="idm140330173235072"></a><h2>Description</h2>
<p>The macro <span class="emphasis"><em>HPX_PLAIN_ACTION_ID</em></span> can be used to define a plain action (e.g. an action encapsulating a global or free function) based on the given function <span class="emphasis"><em>func</em></span>. It defines the action type <span class="emphasis"><em>actionname</em></span> representing the given function. The parameter <span class="emphasis"><em>actionid</em></span> </p>
<p>The parameter <span class="emphasis"><em>actionid</em></span> specifies an unique integer value which will be used to represent the action during serialization.</p>
<p>The parameter <code class="computeroutput">func</code> is a global or free (non-member) function which should be encapsulated into a plain action. The parameter <code class="computeroutput">name</code> is the name of the action type defined by this macro.</p>
Expand Down Expand Up @@ -63,7 +63,8 @@ <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="re
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright &#169; 2011-2017 The STE||AR Group (http://stellar-group.org)<p>
<td align="right"><div class="copyright-footer">Copyright &#169; 2011-2018 The STE||AR Group
(http://stellar-group.org)<p>
Distributed under the Boost Software License, Version 1.0. (See accompanying
file <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">LICENSE_1_0.txt</a>
or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
Expand Down
5 changes: 3 additions & 2 deletions docs/html/HPX_REGISTER_ACTION.html
View file
Expand Up @@ -26,7 +26,7 @@ <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="re

</span>HPX_REGISTER_ACTION(...)</pre></div>
<div class="refsect1">
<a name="idm140562001389920"></a><h2>Description</h2>
<a name="idm140330173396704"></a><h2>Description</h2>
<p>The macro <span class="emphasis"><em>HPX_REGISTER_ACTION</em></span> can be used to define all the boilerplate code which is required for proper functioning of component actions in the context of HPX.</p>
<p>The parameter <span class="emphasis"><em>action</em></span> is the type of the action to define the boilerplate for.</p>
<p>This macro can be invoked with an optional second parameter. This parameter specifies a unique name of the action to be used for serialization purposes. The second parameter has to be specified if the first parameter is not usable as a plain (non-qualified) C++ identifier, i.e. the first parameter contains special characters which cannot be part of a C++ identifier, such as '&lt;', '&gt;', or ':'.</p>
Expand All @@ -46,7 +46,8 @@ <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="re
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright &#169; 2011-2017 The STE||AR Group (http://stellar-group.org)<p>
<td align="right"><div class="copyright-footer">Copyright &#169; 2011-2018 The STE||AR Group
(http://stellar-group.org)<p>
Distributed under the Boost Software License, Version 1.0. (See accompanying
file <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">LICENSE_1_0.txt</a>
or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
Expand Down
5 changes: 3 additions & 2 deletions docs/html/HPX_REGISTER_ACTION_DECLARATION.html
View file
Expand Up @@ -26,7 +26,7 @@ <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="re

</span>HPX_REGISTER_ACTION_DECLARATION(...)</pre></div>
<div class="refsect1">
<a name="idm140562001449536"></a><h2>Description</h2>
<a name="idm140330173456160"></a><h2>Description</h2>
<p>The macro <span class="emphasis"><em>HPX_REGISTER_ACTION_DECLARATION</em></span> can be used to declare all the boilerplate code which is required for proper functioning of component actions in the context of HPX.</p>
<p>The parameter <span class="emphasis"><em>action</em></span> is the type of the action to declare the boilerplate for.</p>
<p>This macro can be invoked with an optional second parameter. This parameter specifies a unique name of the action to be used for serialization purposes. The second parameter has to be specified if the first parameter is not usable as a plain (non-qualified) C++ identifier, i.e. the first parameter contains special characters which cannot be part of a C++ identifier, such as '&lt;', '&gt;', or ':'.</p>
Expand Down Expand Up @@ -68,7 +68,8 @@ <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="re
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright &#169; 2011-2017 The STE||AR Group (http://stellar-group.org)<p>
<td align="right"><div class="copyright-footer">Copyright &#169; 2011-2018 The STE||AR Group
(http://stellar-group.org)<p>
Distributed under the Boost Software License, Version 1.0. (See accompanying
file <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">LICENSE_1_0.txt</a>
or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
Expand Down
5 changes: 3 additions & 2 deletions docs/html/HPX_REGISTER_ACTION_ID.html
View file
Expand Up @@ -26,7 +26,7 @@ <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="re

</span>HPX_REGISTER_ACTION_ID(action, actionname, actionid)</pre></div>
<div class="refsect1">
<a name="idm140562001379360"></a><h2>Description</h2>
<a name="idm140330173386144"></a><h2>Description</h2>
<p>The macro <span class="emphasis"><em>HPX_REGISTER_ACTION</em></span> can be used to define all the boilerplate code which is required for proper functioning of component actions in the context of HPX.</p>
<p>The parameter <span class="emphasis"><em>action</em></span> is the type of the action to define the boilerplate for.</p>
<p>The parameter <span class="emphasis"><em>actionname</em></span> specifies an unique name of the action to be used for serialization purposes. The second parameter has to be usable as a plain (non-qualified) C++ identifier, it should not contain special characters which cannot be part of a C++ identifier, such as '&lt;', '&gt;', or ':'.</p>
Expand All @@ -47,7 +47,8 @@ <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="re
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright &#169; 2011-2017 The STE||AR Group (http://stellar-group.org)<p>
<td align="right"><div class="copyright-footer">Copyright &#169; 2011-2018 The STE||AR Group
(http://stellar-group.org)<p>
Distributed under the Boost Software License, Version 1.0. (See accompanying
file <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">LICENSE_1_0.txt</a>
or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
Expand Down
5 changes: 3 additions & 2 deletions docs/html/HPX_REGISTER_COMPONENT.html
View file
Expand Up @@ -26,7 +26,7 @@ <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="re

</span>HPX_REGISTER_COMPONENT(type, name, mode)</pre></div>
<div class="refsect1">
<a name="idm140562000060224"></a><h2>Description</h2>
<a name="idm140330172066528"></a><h2>Description</h2>
<p>This macro is used create and to register a minimal component factory for a component type which allows it to be remotely created using the <span class="emphasis"><em>hpx::new_&lt;&gt;</em></span> function.</p>
<p>This macro can be invoked with one, two or three arguments</p>
<p>
Expand Down Expand Up @@ -64,7 +64,8 @@ <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="re
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright &#169; 2011-2017 The STE||AR Group (http://stellar-group.org)<p>
<td align="right"><div class="copyright-footer">Copyright &#169; 2011-2018 The STE||AR Group
(http://stellar-group.org)<p>
Distributed under the Boost Software License, Version 1.0. (See accompanying
file <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">LICENSE_1_0.txt</a>
or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
Expand Down
5 changes: 3 additions & 2 deletions docs/html/HPX_REGISTER_GATHER.html
View file
Expand Up @@ -26,7 +26,7 @@ <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="re

</span>HPX_REGISTER_GATHER(type, name)</pre></div>
<div class="refsect1">
<a name="idm140562018926384"></a><h2>Description</h2>
<a name="idm140330190936048"></a><h2>Description</h2>
<p>The macro <span class="emphasis"><em>HPX_REGISTER_GATHER</em></span> can be used to define all facilities necessary for a (possibly remote) gather operation.</p>
<p>The parameter <span class="emphasis"><em>type</em></span> specifies for which data type the gather operations should be enabled.</p>
<p>The (optional) parameter <span class="emphasis"><em>name</em></span> should be a unique C-style identifier which will be internally used to identify a particular gather operation. If this defaults to <span class="emphasis"><em>&lt;type&gt;_gather</em></span> if not specified.</p>
Expand All @@ -43,7 +43,8 @@ <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="re
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright &#169; 2011-2017 The STE||AR Group (http://stellar-group.org)<p>
<td align="right"><div class="copyright-footer">Copyright &#169; 2011-2018 The STE||AR Group
(http://stellar-group.org)<p>
Distributed under the Boost Software License, Version 1.0. (See accompanying
file <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">LICENSE_1_0.txt</a>
or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
Expand Down
11 changes: 6 additions & 5 deletions docs/html/HPX_REGISTER_GATHER_DECLARATION.html
View file
Expand Up @@ -6,14 +6,14 @@
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="HPX 1.1.0">
<link rel="up" href="header/hpx/lcos/gather_hpp.html" title="Header &lt;hpx/lcos/gather.hpp&gt;">
<link rel="prev" href="hpx/lcos/gather__idm140506787290976.html" title="Function template gather_there">
<link rel="prev" href="hpx/lcos/gather__idm140014914348272.html" title="Function template gather_there">
<link rel="next" href="HPX_REGISTER_GATHER.html" title="Macro HPX_REGISTER_GATHER">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="HPX" width="531" height="105" src="images/hpx_1_1_0_draft.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="hpx/lcos/gather__idm140506787290976.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="header/hpx/lcos/gather_hpp.html"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="HPX_REGISTER_GATHER.html"><img src="images/next.png" alt="Next"></a>
<a accesskey="p" href="hpx/lcos/gather__idm140014914348272.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="header/hpx/lcos/gather_hpp.html"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="HPX_REGISTER_GATHER.html"><img src="images/next.png" alt="Next"></a>
</div>
<div class="refentry">
<a name="HPX_REGISTER_GATHER_DECLARATION"></a><div class="titlepage"></div>
Expand All @@ -26,7 +26,7 @@ <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="re

</span>HPX_REGISTER_GATHER_DECLARATION(type, name)</pre></div>
<div class="refsect1">
<a name="idm140562018936576"></a><h2>Description</h2>
<a name="idm140330190946240"></a><h2>Description</h2>
<p>The macro <span class="emphasis"><em>HPX_REGISTER_GATHER_DECLARATION</em></span> can be used to declare all facilities necessary for a (possibly remote) gather operation.</p>
<p>The parameter <span class="emphasis"><em>type</em></span> specifies for which data type the gather operations should be enabled.</p>
<p>The (optional) parameter <span class="emphasis"><em>name</em></span> should be a unique C-style identifier which will be internally used to identify a particular gather operation. If this defaults to <span class="emphasis"><em>&lt;type&gt;_gather</em></span> if not specified.</p>
Expand All @@ -43,7 +43,8 @@ <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="re
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright &#169; 2011-2017 The STE||AR Group (http://stellar-group.org)<p>
<td align="right"><div class="copyright-footer">Copyright &#169; 2011-2018 The STE||AR Group
(http://stellar-group.org)<p>
Distributed under the Boost Software License, Version 1.0. (See accompanying
file <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">LICENSE_1_0.txt</a>
or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
Expand All @@ -52,7 +53,7 @@ <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="re
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="hpx/lcos/gather__idm140506787290976.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="header/hpx/lcos/gather_hpp.html"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="HPX_REGISTER_GATHER.html"><img src="images/next.png" alt="Next"></a>
<a accesskey="p" href="hpx/lcos/gather__idm140014914348272.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="header/hpx/lcos/gather_hpp.html"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="HPX_REGISTER_GATHER.html"><img src="images/next.png" alt="Next"></a>
</div>
</body>
</html>

0 comments on commit 2115ef9

Please sign in to comment.