commit ebfc5f096a7cb655846be8bf9a3b7ccd8f6e6bed
author Giorgio Arena <giorgio.arena@arm.com> Tue Dec 12 14:50:25 2017 +0000
committer Anthony Barbier <anthony.barbier@arm.com> Fri Nov 02 16:42:33 2018 +0000
tree d6d5aa02f79284161a224918bb550e3aaa3b6a68
parent 9d364848fb32ae226e46b3df81220d52fd6a94b2

COMPMID-556 Fix Color Convert documentation

Change-Id: Iec0728cbe33be1c006499c7892841baf584485f7
Reviewed-on: https://eu-gerrit-1.euhpc.arm.com/112908
Reviewed-by: Anthony Barbier <anthony.barbier@arm.com>
Tested-by: Anthony Barbier <anthony.barbier@arm.com>

arm_compute/runtime/CL/functions/CLColorConvert.h

diff --git a/arm_compute/runtime/CL/functions/CLColorConvert.h b/arm_compute/runtime/CL/functions/CLColorConvert.h
index 12457a0..dd7de45 100644
--- a/arm_compute/runtime/CL/functions/CLColorConvert.h
+++ b/arm_compute/runtime/CL/functions/CLColorConvert.h
@@ -41,26 +41,27 @@
 public:
     /** Initialize the function's source, destination
      *
-     * @param[in] input  The input single-planar tensor from which to convert
-     * @param[in] output The converted single-planar output tensor
+     * @param[in]  input  Source tensor. Formats supported: RGBA8888/UYVY422/YUYV422/RGB888
+     * @param[out] output Destination tensor. Formats supported: RGB888 (if the formats of @p input are RGBA8888/UYVY422/YUYV422),
+     *                                                          RGBA8888 (if the formats of @p input are UYVY422/YUYV422/RGB888/)
      */
     void configure(const ICLTensor *input, ICLTensor *output);
     /** Initialize the function's source, destination
      *
-     * @param[in] input  The multi-planar input image from which to convert
-     * @param[in] output The converted single-planar output image
+     * @param[in]  input  Multi-planar source image. Formats supported: NV12/NV21/IYUV
+     * @param[out] output Single-planar destination image. Formats supported: RGB888/RGBA8888
      */
     void configure(const ICLMultiImage *input, ICLImage *output);
     /** Initialize the function's source, destination
      *
-     * @param[in] input  The single-planar input image from which to convert
-     * @param[in] output The converted multi-planar output image
+     * @param[in]  input  Single-planar source image. Formats supported: RGB888/RGBA8888/UYVY422/YUYV422
+     * @param[out] output Multi-planar destination image. Formats supported: NV12/IYUV/YUV444 (if the formats of @p input are RGB888/RGB8888)
      */
     void configure(const ICLImage *input, ICLMultiImage *output);
     /** Initialize the function's source, destination
      *
-     * @param[in] input  The multi-planar input image from which to convert
-     * @param[in] output The converted multi-planar output image
+     * @param[in]  input  Multi-planar source image. Formats supported: NV12/NV21/IYUV
+     * @param[out] output Multi-planar destination image. Formats supported: YUV444/IYUV (if the formats of @p input are NV12/NV21)/NV12 (if the format of  @p input is IYUV)
      */
     void configure(const ICLMultiImage *input, ICLMultiImage *output);
 };