diff options
| author | Alex Gilday <alexander.gilday@arm.com> | 2018-03-21 13:54:09 +0000 |
|---|---|---|
| committer | Anthony Barbier <anthony.barbier@arm.com> | 2018-11-02 16:49:16 +0000 |
| commit | c357c47be8a3f210f9eee9a05cc13f1051b036d3 (patch) | |
| tree | a88ac857150da970a0862a3479b78c616d8aa1d3 /arm_compute/runtime/Scheduler.h | |
| parent | 724079d6fce3bf6a05cd6c7b4884b132b27e9e90 (diff) | |
| download | ComputeLibrary-c357c47be8a3f210f9eee9a05cc13f1051b036d3.tar.gz | |
COMPMID-1008: Fix Doxygen issues
Change-Id: Ie73d8771f85d1f5b059f3a56f1bbd73c98e94a38
Reviewed-on: https://eu-gerrit-1.euhpc.arm.com/124723
Reviewed-by: Michalis Spyrou <michalis.spyrou@arm.com>
Tested-by: Jenkins <bsgcomp@arm.com>
Diffstat (limited to 'arm_compute/runtime/Scheduler.h')
| -rw-r--r-- | arm_compute/runtime/Scheduler.h | 11 |
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); |