aboutsummaryrefslogtreecommitdiff
path: root/arm_compute/runtime/Scheduler.h
diff options
context:
space:
mode:
Diffstat (limited to 'arm_compute/runtime/Scheduler.h')
-rw-r--r--arm_compute/runtime/Scheduler.h11
1 files changed, 7 insertions, 4 deletions
diff --git a/arm_compute/runtime/Scheduler.h b/arm_compute/runtime/Scheduler.h
index 524622f89d..7e10461b5a 100644
--- a/arm_compute/runtime/Scheduler.h
+++ b/arm_compute/runtime/Scheduler.h
@@ -33,12 +33,13 @@ namespace arm_compute
class Scheduler
{
public:
+ /** Scheduler type */
enum class Type
{
- ST, // Single thread.
- CPP, // C++11 threads.
- OMP, // OpenMP.
- CUSTOM // Provided by the user.
+ ST, /**< Single thread. */
+ CPP, /**< C++11 threads. */
+ OMP, /**< OpenMP. */
+ CUSTOM /**< Provided by the user. */
};
/** Sets the user defined scheduler and makes it the active scheduler.
*
@@ -64,6 +65,8 @@ public:
static Type get_type();
/** Returns true if the given scheduler type is supported. False otherwise.
*
+ * @param[in] t the type of the scheduler to check.
+ *
* @return true if the given scheduler type is supported. False otherwise.
*/
static bool is_available(Type t);