From c357c47be8a3f210f9eee9a05cc13f1051b036d3 Mon Sep 17 00:00:00 2001 From: Alex Gilday Date: Wed, 21 Mar 2018 13:54:09 +0000 Subject: COMPMID-1008: Fix Doxygen issues Change-Id: Ie73d8771f85d1f5b059f3a56f1bbd73c98e94a38 Reviewed-on: https://eu-gerrit-1.euhpc.arm.com/124723 Reviewed-by: Michalis Spyrou Tested-by: Jenkins --- arm_compute/core/CL/OpenCL.h | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) (limited to 'arm_compute/core/CL/OpenCL.h') diff --git a/arm_compute/core/CL/OpenCL.h b/arm_compute/core/CL/OpenCL.h index 405d5cebd7..4b4a8b807d 100644 --- a/arm_compute/core/CL/OpenCL.h +++ b/arm_compute/core/CL/OpenCL.h @@ -43,8 +43,13 @@ static const NDRange Range_128_1 = NDRange(128, 1); namespace arm_compute { +/** Check if OpenCL is available. + * + * @return True if OpenCL is available. + */ bool opencl_is_available(); +/** Class for loading OpenCL symbols. */ class CLSymbols final { private: @@ -52,8 +57,22 @@ private: void load_symbols(void *handle); public: + /** Get the static instance of CLSymbols. + * + * @return The static instance of CLSymbols. + */ static CLSymbols &get(); + /** Load symbols from the given OpenCL library path. + * + * @param[in] library Path to the OpenCL library. + * + * @return True if loading the library is successful. + */ bool load(const std::string &library); + /** Load symbols from any of the default OpenCL library names. + * + * @return True if loading any library is successful. + */ bool load_default(); #define DECLARE_FUNCTION_PTR(func_name) \ -- cgit v1.2.1