diff --git a/base_cpp/include/embb/base/core_set.h b/base_cpp/include/embb/base/core_set.h index f5d9fec..9682c0d 100644 --- a/base_cpp/include/embb/base/core_set.h +++ b/base_cpp/include/embb/base/core_set.h @@ -186,6 +186,8 @@ class CoreSet { /** * Provides access to internal representation to use it with C API. + * + * \return A reference to the internal embb_core_set_t structure. */ embb_core_set_t const & GetInternal() const { return rep_; } diff --git a/doc/reference/Doxyfile.in b/doc/reference/Doxyfile.in index f429d66..45b37c5 100644 --- a/doc/reference/Doxyfile.in +++ b/doc/reference/Doxyfile.in @@ -148,7 +148,8 @@ INPUT = "@CMAKE_SOURCE_DIR@/doc/reference/embb.dox" \ "@CMAKE_SOURCE_DIR@/containers_cpp/include" \ "@CMAKE_SOURCE_DIR@/dataflow_cpp/include" \ "@CMAKE_SOURCE_DIR@/algorithms_cpp/include" \ - "@CMAKE_SOURCE_DIR@/mtapi_cpp_ext/include" \ + "@CMAKE_SOURCE_DIR@/tasks_cpp/include" \ + "@CMAKE_SOURCE_DIR@/mtapi_cpp/include" \ "@CMAKE_SOURCE_DIR@/base_cpp/include" \ "@CMAKE_SOURCE_DIR@/mtapi_c/include" \ "@CMAKE_SOURCE_DIR@/base_c/include" diff --git a/mtapi_cpp/include/embb/mtapi/action.h b/mtapi_cpp/include/embb/mtapi/action.h index 182dbd8..fb2a738 100644 --- a/mtapi_cpp/include/embb/mtapi/action.h +++ b/mtapi_cpp/include/embb/mtapi/action.h @@ -37,7 +37,7 @@ namespace mtapi { /** * Holds the actual worker function used to execute a Task. * - * \ingroup CPP_MTAPI_EXT + * \ingroup CPP_MTAPI */ class Action { public: diff --git a/mtapi_cpp/include/embb/mtapi/action_attributes.h b/mtapi_cpp/include/embb/mtapi/action_attributes.h index 6382cb9..0a63ad3 100644 --- a/mtapi_cpp/include/embb/mtapi/action_attributes.h +++ b/mtapi_cpp/include/embb/mtapi/action_attributes.h @@ -37,7 +37,7 @@ namespace mtapi { /** * Contains attributes of an Action. * - * \ingroup CPP_MTAPI_EXT + * \ingroup CPP_MTAPI */ class ActionAttributes { public: diff --git a/mtapi_cpp/include/embb/mtapi/affinity.h b/mtapi_cpp/include/embb/mtapi/affinity.h index 8127246..fbb3f86 100644 --- a/mtapi_cpp/include/embb/mtapi/affinity.h +++ b/mtapi_cpp/include/embb/mtapi/affinity.h @@ -36,7 +36,7 @@ namespace mtapi { /** * Describes the affinity of an Action or Task to a worker thread of a Node. * - * \ingroup CPP_MTAPI_EXT + * \ingroup CPP_MTAPI */ class Affinity { public: diff --git a/mtapi_cpp/include/embb/mtapi/group.h b/mtapi_cpp/include/embb/mtapi/group.h index 510ee2e..eef630c 100644 --- a/mtapi_cpp/include/embb/mtapi/group.h +++ b/mtapi_cpp/include/embb/mtapi/group.h @@ -47,7 +47,7 @@ namespace mtapi { * Represents a facility to wait for multiple related * \link Task Tasks\endlink. * - * \ingroup CPP_MTAPI_EXT + * \ingroup CPP_MTAPI */ class Group { public: diff --git a/mtapi_cpp/include/embb/mtapi/group_attributes.h b/mtapi_cpp/include/embb/mtapi/group_attributes.h index 6d1eed7..68b1f83 100644 --- a/mtapi_cpp/include/embb/mtapi/group_attributes.h +++ b/mtapi_cpp/include/embb/mtapi/group_attributes.h @@ -36,7 +36,7 @@ namespace mtapi { /** * Contains attributes of a Group. * - * \ingroup CPP_MTAPI_EXT + * \ingroup CPP_MTAPI */ class GroupAttributes { public: diff --git a/mtapi_cpp/include/embb/mtapi/job.h b/mtapi_cpp/include/embb/mtapi/job.h index c89f8b6..dc91061 100644 --- a/mtapi_cpp/include/embb/mtapi/job.h +++ b/mtapi_cpp/include/embb/mtapi/job.h @@ -36,7 +36,7 @@ namespace mtapi { /** * Represents a collection of Actions. * - * \ingroup CPP_MTAPI_EXT + * \ingroup CPP_MTAPI */ class Job { public: diff --git a/mtapi_cpp/include/embb/mtapi/mtapi.h b/mtapi_cpp/include/embb/mtapi/mtapi.h index 6e863ec..8ceb6e9 100644 --- a/mtapi_cpp/include/embb/mtapi/mtapi.h +++ b/mtapi_cpp/include/embb/mtapi/mtapi.h @@ -28,7 +28,7 @@ #define EMBB_MTAPI_MTAPI_H_ /** - * \defgroup CPP_MTAPI_EXT MTAPI EXT + * \defgroup CPP_MTAPI MTAPI * C++ wrapper around C implementation of MTAPI. * For a description of the basic concepts, see the * \ref C_MTAPI "C implementation of MTAPI". diff --git a/mtapi_cpp/include/embb/mtapi/node.h b/mtapi_cpp/include/embb/mtapi/node.h index 4980149..b451e09 100644 --- a/mtapi_cpp/include/embb/mtapi/node.h +++ b/mtapi_cpp/include/embb/mtapi/node.h @@ -48,7 +48,7 @@ namespace mtapi { /** * A singleton representing the MTAPI runtime. * - * \ingroup CPP_MTAPI_EXT + * \ingroup CPP_MTAPI */ class Node { public: diff --git a/mtapi_cpp/include/embb/mtapi/node_attributes.h b/mtapi_cpp/include/embb/mtapi/node_attributes.h index cd4a218..36d9489 100644 --- a/mtapi_cpp/include/embb/mtapi/node_attributes.h +++ b/mtapi_cpp/include/embb/mtapi/node_attributes.h @@ -37,7 +37,7 @@ namespace mtapi { /** * Contains attributes of a Node. * - * \ingroup CPP_MTAPI_EXT + * \ingroup CPP_MTAPI */ class NodeAttributes { public: @@ -69,7 +69,15 @@ public: attributes_ = other.attributes_; } - NodeAttributes & SetCoreAffinity(embb::base::CoreSet const & cores) { + /** + * Sets the core affinity of the Node. This also determines the number of + * worker threads. + * + * \returns Reference to this object. + */ + NodeAttributes & SetCoreAffinity( + embb::base::CoreSet const & cores /**< The cores to use. */ + ) { mtapi_status_t status; mtapi_nodeattr_set(&attributes_, MTAPI_NODE_CORE_AFFINITY, &cores.GetInternal(), sizeof(embb_core_set_t), &status); @@ -77,7 +85,14 @@ public: return *this; } - NodeAttributes & SetMaxTasks(mtapi_uint_t value) { + /** + * Sets the maximum number of concurrently active tasks. + * + * \returns Reference to this object. + */ + NodeAttributes & SetMaxTasks( + mtapi_uint_t value /**< The value to set. */ + ) { mtapi_status_t status; mtapi_nodeattr_set(&attributes_, MTAPI_NODE_MAX_TASKS, &value, sizeof(value), &status); @@ -85,7 +100,14 @@ public: return *this; } - NodeAttributes & SetMaxActions(mtapi_uint_t value) { + /** + * Sets the maximum number of actions. + * + * \returns Reference to this object. + */ + NodeAttributes & SetMaxActions( + mtapi_uint_t value /**< The value to set. */ + ) { mtapi_status_t status; mtapi_nodeattr_set(&attributes_, MTAPI_NODE_MAX_ACTIONS, &value, sizeof(value), &status); @@ -93,7 +115,14 @@ public: return *this; } - NodeAttributes & SetMaxGroups(mtapi_uint_t value) { + /** + * Sets the maximum number of groups. + * + * \returns Reference to this object. + */ + NodeAttributes & SetMaxGroups( + mtapi_uint_t value /**< The value to set. */ + ) { mtapi_status_t status; mtapi_nodeattr_set(&attributes_, MTAPI_NODE_MAX_GROUPS, &value, sizeof(value), &status); @@ -101,7 +130,14 @@ public: return *this; } - NodeAttributes & SetMaxQueues(mtapi_uint_t value) { + /** + * Sets the maximum number of queues. + * + * \returns Reference to this object. + */ + NodeAttributes & SetMaxQueues( + mtapi_uint_t value /**< The value to set. */ + ) { mtapi_status_t status; mtapi_nodeattr_set(&attributes_, MTAPI_NODE_MAX_QUEUES, &value, sizeof(value), &status); @@ -109,7 +145,14 @@ public: return *this; } - NodeAttributes & SetQueueLimit(mtapi_uint_t value) { + /** + * Sets the default limit (capacity) of all queues. + * + * \returns Reference to this object. + */ + NodeAttributes & SetQueueLimit( + mtapi_uint_t value /**< The value to set. */ + ) { mtapi_status_t status; mtapi_nodeattr_set(&attributes_, MTAPI_NODE_QUEUE_LIMIT, &value, sizeof(value), &status); @@ -117,7 +160,14 @@ public: return *this; } - NodeAttributes & SetMaxJobs(mtapi_uint_t value) { + /** + * Sets the maximum number of available jobs. + * + * \returns Reference to this object. + */ + NodeAttributes & SetMaxJobs( + mtapi_uint_t value /**< The value to set. */ + ) { mtapi_status_t status; mtapi_nodeattr_set(&attributes_, MTAPI_NODE_MAX_JOBS, &value, sizeof(value), &status); @@ -125,7 +175,14 @@ public: return *this; } - NodeAttributes & SetMaxActionsPerJob(mtapi_uint_t value) { + /** + * Sets the maximum number of actions per job. + * + * \returns Reference to this object. + */ + NodeAttributes & SetMaxActionsPerJob( + mtapi_uint_t value /**< The value to set. */ + ) { mtapi_status_t status; mtapi_nodeattr_set(&attributes_, MTAPI_NODE_MAX_ACTIONS_PER_JOB, &value, sizeof(value), &status); @@ -133,7 +190,15 @@ public: return *this; } - NodeAttributes & SetMaxPriorities(mtapi_uint_t value) { + /** + * Sets the maximum number of available priorities. The priority values + * will range from 0 to \c value - 1 with 0 being the highest priority. + * + * \returns Reference to this object. + */ + NodeAttributes & SetMaxPriorities( + mtapi_uint_t value /**< The value to set. */ + ) { mtapi_status_t status; mtapi_nodeattr_set(&attributes_, MTAPI_NODE_MAX_PRIORITIES, &value, sizeof(value), &status); diff --git a/mtapi_cpp/include/embb/mtapi/queue.h b/mtapi_cpp/include/embb/mtapi/queue.h index 5a406ed..f332e59 100644 --- a/mtapi_cpp/include/embb/mtapi/queue.h +++ b/mtapi_cpp/include/embb/mtapi/queue.h @@ -47,7 +47,7 @@ namespace mtapi { /** * Allows for stream processing, either ordered or unordered. * - * \ingroup CPP_MTAPI_EXT + * \ingroup CPP_MTAPI */ class Queue { public: diff --git a/mtapi_cpp/include/embb/mtapi/queue_attributes.h b/mtapi_cpp/include/embb/mtapi/queue_attributes.h index 7b8039e..3df364f 100644 --- a/mtapi_cpp/include/embb/mtapi/queue_attributes.h +++ b/mtapi_cpp/include/embb/mtapi/queue_attributes.h @@ -36,7 +36,7 @@ namespace mtapi { /** * Contains attributes of a Queue. * - * \ingroup CPP_MTAPI_EXT + * \ingroup CPP_MTAPI */ class QueueAttributes { public: diff --git a/mtapi_cpp/include/embb/mtapi/status_exception.h b/mtapi_cpp/include/embb/mtapi/status_exception.h index 52e3d20..3c727a9 100644 --- a/mtapi_cpp/include/embb/mtapi/status_exception.h +++ b/mtapi_cpp/include/embb/mtapi/status_exception.h @@ -36,7 +36,7 @@ namespace mtapi { * Represents an MTAPI error state and is thrown by almost all mtapi_cpp * methods. * - * \ingroup CPP_MTAPI_EXT + * \ingroup CPP_MTAPI */ class StatusException : public embb::base::Exception { public: diff --git a/mtapi_cpp/include/embb/mtapi/task.h b/mtapi_cpp/include/embb/mtapi/task.h index 36bd23a..5c91579 100644 --- a/mtapi_cpp/include/embb/mtapi/task.h +++ b/mtapi_cpp/include/embb/mtapi/task.h @@ -36,7 +36,7 @@ namespace mtapi { /** * A Task represents a running Action of a specific Job. * - * \ingroup CPP_MTAPI_EXT + * \ingroup CPP_MTAPI */ class Task { public: diff --git a/mtapi_cpp/include/embb/mtapi/task_attributes.h b/mtapi_cpp/include/embb/mtapi/task_attributes.h index a009181..1842a93 100644 --- a/mtapi_cpp/include/embb/mtapi/task_attributes.h +++ b/mtapi_cpp/include/embb/mtapi/task_attributes.h @@ -36,7 +36,7 @@ namespace mtapi { /** * Contains attributes of a Task. * - * \ingroup CPP_MTAPI_EXT + * \ingroup CPP_MTAPI */ class TaskAttributes { public: diff --git a/mtapi_cpp/include/embb/mtapi/task_context.h b/mtapi_cpp/include/embb/mtapi/task_context.h index ebdbec6..489587f 100644 --- a/mtapi_cpp/include/embb/mtapi/task_context.h +++ b/mtapi_cpp/include/embb/mtapi/task_context.h @@ -36,7 +36,7 @@ namespace mtapi { /** * Provides information about the status of the currently running Task. * - * \ingroup CPP_MTAPI_EXT + * \ingroup CPP_MTAPI */ class TaskContext { public: diff --git a/tasks_cpp/include/embb/tasks/action.h b/tasks_cpp/include/embb/tasks/action.h index 69b6132..34c22db 100644 --- a/tasks_cpp/include/embb/tasks/action.h +++ b/tasks_cpp/include/embb/tasks/action.h @@ -37,7 +37,7 @@ namespace tasks { /** * A function to be spawned as a Task. * - * \ingroup CPP_MTAPI + * \ingroup CPP_TASKS */ class Action { public: