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/CL/CLArray.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/CL/CLArray.h')
-rw-r--r-- | arm_compute/runtime/CL/CLArray.h | 37 |
1 files changed, 25 insertions, 12 deletions
diff --git a/arm_compute/runtime/CL/CLArray.h b/arm_compute/runtime/CL/CLArray.h index dda26e2e89..01c6d8df3d 100644 --- a/arm_compute/runtime/CL/CLArray.h +++ b/arm_compute/runtime/CL/CLArray.h @@ -1,5 +1,5 @@ /* - * Copyright (c) 2016, 2017 ARM Limited. + * Copyright (c) 2016-2018 ARM Limited. * * SPDX-License-Identifier: MIT * @@ -46,7 +46,9 @@ public: CLArray(const CLArray &) = delete; /** Prevent instances of this class from being copied (As this class contains pointers) */ CLArray &operator=(const CLArray &) = delete; - CLArray(CLArray &&) = default; + /** Allow instances of this class to be move constructed */ + CLArray(CLArray &&) = default; + /** Allow instances of this class to be moved */ CLArray &operator=(CLArray &&) = default; /** Constructor: initializes an array which can contain up to max_num_points values * @@ -101,16 +103,27 @@ private: cl::Buffer _buffer; }; -using CLKeyPointArray = CLArray<KeyPoint>; -using CLCoordinates2DArray = CLArray<Coordinates2D>; +/** OpenCL Array of Key Points. */ +using CLKeyPointArray = CLArray<KeyPoint>; +/** OpenCL Array of 2D Coordinates. */ +using CLCoordinates2DArray = CLArray<Coordinates2D>; +/** OpenCL Array of Detection Windows. */ using CLDetectionWindowArray = CLArray<DetectionWindow>; -using CLROIArray = CLArray<ROI>; -using CLSize2DArray = CLArray<Size2D>; -using CLUInt8Array = CLArray<cl_uchar>; -using CLUInt16Array = CLArray<cl_ushort>; -using CLUInt32Array = CLArray<cl_uint>; -using CLInt16Array = CLArray<cl_short>; -using CLInt32Array = CLArray<cl_int>; -using CLFloatArray = CLArray<cl_float>; +/** OpenCL Array of ROIs. */ +using CLROIArray = CLArray<ROI>; +/** OpenCL Array of 2D Sizes. */ +using CLSize2DArray = CLArray<Size2D>; +/** OpenCL Array of uint8s. */ +using CLUInt8Array = CLArray<cl_uchar>; +/** OpenCL Array of uint16s. */ +using CLUInt16Array = CLArray<cl_ushort>; +/** OpenCL Array of uint32s. */ +using CLUInt32Array = CLArray<cl_uint>; +/** OpenCL Array of int16s. */ +using CLInt16Array = CLArray<cl_short>; +/** OpenCL Array of int32s. */ +using CLInt32Array = CLArray<cl_int>; +/** OpenCL Array of floats. */ +using CLFloatArray = CLArray<cl_float>; } #endif /* __ARM_COMPUTE_CLARRAY_H__ */ |