aboutsummaryrefslogtreecommitdiff
path: root/arm_compute/core/CL/CLKernelLibrary.h
diff options
context:
space:
mode:
authorAlex Gilday <alexander.gilday@arm.com>2018-03-21 13:54:09 +0000
committerAnthony Barbier <anthony.barbier@arm.com>2018-11-02 16:49:16 +0000
commitc357c47be8a3f210f9eee9a05cc13f1051b036d3 (patch)
treea88ac857150da970a0862a3479b78c616d8aa1d3 /arm_compute/core/CL/CLKernelLibrary.h
parent724079d6fce3bf6a05cd6c7b4884b132b27e9e90 (diff)
downloadComputeLibrary-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/core/CL/CLKernelLibrary.h')
-rw-r--r--arm_compute/core/CL/CLKernelLibrary.h26
1 files changed, 17 insertions, 9 deletions
diff --git a/arm_compute/core/CL/CLKernelLibrary.h b/arm_compute/core/CL/CLKernelLibrary.h
index 953b43c038..12e424fce9 100644
--- a/arm_compute/core/CL/CLKernelLibrary.h
+++ b/arm_compute/core/CL/CLKernelLibrary.h
@@ -104,11 +104,11 @@ public:
Program(const Program &) = default;
/** Default Move Constructor. */
Program(Program &&) = default;
- /** Default copy assignment operator. */
+ /** Default copy assignment operator */
Program &operator=(const Program &) = default;
- /** Default move assignment operator. */
+ /** Default move assignment operator */
Program &operator=(Program &&) = default;
- /**Returns program name.
+ /** Returns program name.
*
* @return Program's name.
*/
@@ -121,7 +121,13 @@ public:
* @return The CL program object.
*/
explicit operator cl::Program() const;
-
+ /** Build the given CL program.
+ *
+ * @param[in] program The CL program to build.
+ * @param[in] build_options Options to build the CL program.
+ *
+ * @return True if the CL program builds successfully.
+ */
static bool build(const cl::Program &program, const std::string &build_options = "");
/** Build the underlying CL program.
*
@@ -150,9 +156,9 @@ public:
Kernel(const Kernel &) = default;
/** Default Move Constructor. */
Kernel(Kernel &&) = default;
- /** Default copy assignment operator. */
+ /** Default copy assignment operator */
Kernel &operator=(const Kernel &) = default;
- /** Default move assignment operator. */
+ /** Default move assignment operator */
Kernel &operator=(Kernel &&) = default;
/** Constructor.
*
@@ -192,9 +198,9 @@ private:
CLKernelLibrary();
public:
- /** Prevent instances of this class from being copied. */
+ /** Prevent instances of this class from being copied */
CLKernelLibrary(const CLKernelLibrary &) = delete;
- /** Prevent instances of this class from being copied. */
+ /** Prevent instances of this class from being copied */
const CLKernelLibrary &operator=(const CLKernelLibrary &) = delete;
/** Access the KernelLibrary singleton.
* @return The KernelLibrary instance.
@@ -226,9 +232,11 @@ public:
{
return _kernel_path;
};
- /** Gets the source of the selected program
+ /** Gets the source of the selected program.
*
* @param[in] program_name Program name.
+ *
+ * @return Source of the selected program.
*/
std::string get_program_source(const std::string &program_name);
/** Sets the CL context used to create programs.