Updating Sphinx docs - branch (html)

STEllAR-GROUP · Jul 13, 2024 · 648ed3b · 648ed3b
1 parent 613b6dc
commit 648ed3b
Show file tree

Hide file tree

Showing 1,004 changed files with 38,424 additions and 185,851 deletions.
diff --git a/branches/master/html/_downloads/01237b2a90614802ab4171dda000dc11/accumulator.cpp b/branches/master/html/_downloads/01237b2a90614802ab4171dda000dc11/accumulator.cpp
diff --git a/branches/master/html/_downloads/1bbb2fb52e13275836c343488653ecb9/accumulator.hpp b/branches/master/html/_downloads/1bbb2fb52e13275836c343488653ecb9/accumulator.hpp
diff --git a/branches/master/html/_downloads/c70f93157efd61eeeb069064b66f0c36/accumulator.hpp b/branches/master/html/_downloads/c70f93157efd61eeeb069064b66f0c36/accumulator.hpp
diff --git a/branches/master/html/_sources/api/public_distributed_api.rst.txt b/branches/master/html/_sources/api/public_distributed_api.rst.txt
@@ -181,7 +181,7 @@ Member functions
 .. _public_distr_api_header_async:
 
 ``hpx/async.hpp``
-===================
+=================
 
 The header :hpx-header:`libs/full/async_distributed/include,hpx/async.hpp`
 includes distributed implementations of :cpp:func:`hpx::async`,
@@ -204,3 +204,69 @@ Functions
    +-------------------------------------------------------+
    | :ref:`modules_hpx/async_distributed/dataflow.hpp_api` |
    +-------------------------------------------------------+
+
+.. _public_distr_api_header_components:
+
+``hpx/components.hpp``
+======================
+
+The header :hpx-header:`libs/full/include/include,hpx/include/components.hpp`
+includes the components implementation. A component in `hpx` is a C++ class
+which can be created remotely and for which its member functions can be invoked
+remotely as well. More information about how components can be defined,
+created, and used can be found in :ref:`components`. :ref:`examples_accumulator`
+includes examples on the accumulator, template accumulator and template function
+accumulator.
+
+Macros
+------
+
+.. table:: `hpx` macros of header ``hpx/components.hpp``
+
+   +----------------------------------------------+
+   | Macro                                        |
+   +==============================================+
+   | :c:macro:`HPX_DEFINE_COMPONENT_ACTION`       |
+   +----------------------------------------------+
+   | :c:macro:`HPX_REGISTER_ACTION_DECLARATION`   |
+   +----------------------------------------------+
+   | :c:macro:`HPX_REGISTER_ACTION`               |
+   +----------------------------------------------+
+   | :c:macro:`HPX_REGISTER_COMMANDLINE_MODULE`   |
+   +----------------------------------------------+
+   | :c:macro:`HPX_REGISTER_COMPONENT`            |
+   +----------------------------------------------+
+   | :c:macro:`HPX_REGISTER_COMPONENT_MODULE`     |
+   +----------------------------------------------+
+   | :c:macro:`HPX_REGISTER_STARTUP_MODULE`       |
+   +----------------------------------------------+
+
+Classes
+-------
+
+.. table:: `hpx` classes of header ``hpx/components.hpp``
+
+   +----------------------------------------------------------+
+   | Class                                                    |
+   +==========================================================+
+   | :cpp:class:`hpx::components::client`                     |
+   +----------------------------------------------------------+
+   | :cpp:class:`hpx::components::client_base`                |
+   +----------------------------------------------------------+
+   | :cpp:class:`hpx::components::component`                  |
+   +----------------------------------------------------------+
+   | :cpp:class:`hpx::components::component_base`             |
+   +----------------------------------------------------------+
+   | :cpp:class:`hpx::components::component_commandline_base` |
+   +----------------------------------------------------------+
+
+Functions
+---------
+
+.. table:: `hpx` functions of header ``hpx/components.hpp``
+
+   +----------------------------------------------------------+
+   | Function                                                 |
+   +==========================================================+
+   | :cpp:func:`hpx::new_`                                    |
+   +----------------------------------------------------------+