Doxygen update according to multiple @remarks idiom

Change-Id: Idd9b0d7be49a14403b205d7f687218cf26d8998b
Signed-off-by: JungYumin <y_m.jung@samsung.com>

diff --git a/inc/FMediaImage.h b/inc/FMediaImage.h
index b30885b..aa23d37 100644 (file)
--- a/inc/FMediaImage.h
+++ b/inc/FMediaImage.h
@@ -273,11 +273,12 @@ public:
        * @exception    E_UNSUPPORTED_FORMAT    The specified format is not supported.
        * @exception    E_OBJ_NOT_FOUND                 The specified image buffer cannot be found.
        * @exception    E_OUT_OF_MEMORY                 The memory is insufficient.
-       * @remarks              The specific error code can be accessed using the GetLastResult() method.
-       * @remarks              This method retains the aspect ratio of the original image.
-       * @remarks              It’s a high probability that the out-of-memory exception occurs. Check the exception as possible if it is E_OUT_OF_MEMORY.
-       *                               Refer to <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.htm">Exception Check</a> and handle the out-of-memory.
-       * @remarks              This method returns auto scaled bitmap to support logical coordinate system, so the actual dimension of the returned bitmap can be vary depending on the physical dimension of target device.
+       * @remarks
+       *                         - The specific error code can be accessed using the GetLastResult() method.
+       *                         - This method retains the aspect ratio of the original image.
+       *                         - It’s a high probability that the out-of-memory exception occurs. Check the exception as possible if it is E_OUT_OF_MEMORY.
+       *                           Refer to <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.htm">Exception Check</a> and handle the out-of-memory.
+       *                         - This method returns auto scaled bitmap to support logical coordinate system, so the actual dimension of the returned bitmap can be vary depending on the physical dimension of target device.
        */
        Tizen::Graphics::Bitmap* DecodeN(const Tizen::Base::ByteBuffer& srcImageBuf, Tizen::Graphics::BitmapPixelFormat pixelFormat, float destWidth, float destHeight) const;
 
@@ -299,11 +300,12 @@ public:
        * @exception    E_UNSUPPORTED_FORMAT    The specified format is not supported.
        * @exception    E_OUT_OF_MEMORY                 The memory is insufficient.
        * @exception    E_FILE_NOT_FOUND                The specified file cannot be found or accessed.
-       * @remarks              The specific error code can be accessed using the GetLastResult() method.
-       * @remarks              This method retains the aspect ratio of the original image.
-       * @remarks              It’s a high probability that the out-of-memory exception occurs. Check the exception as possible if it is E_OUT_OF_MEMORY.
-       *                               Refer to <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.htm">Exception Check</a> and handle the out-of-memory.
-       * @remarks              This method returns auto scaled bitmap to support logical coordinate system, so the actual dimension of the returned bitmap can be vary depending on the physical dimension of target device.
+       * @remarks
+       *                         - The specific error code can be accessed using the GetLastResult() method.
+       *                         - This method retains the aspect ratio of the original image.
+       *                         - It’s a high probability that the out-of-memory exception occurs. Check the exception as possible if it is E_OUT_OF_MEMORY.
+       *                           Refer to <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.htm">Exception Check</a> and handle the out-of-memory.
+       *                         - This method returns auto scaled bitmap to support logical coordinate system, so the actual dimension of the returned bitmap can be vary depending on the physical dimension of target device.
        */
        Tizen::Graphics::Bitmap* DecodeN(const Tizen::Base::String& srcImagePath, Tizen::Graphics::BitmapPixelFormat pixelFormat, float destWidth, float destHeight) const;
 

diff --git a/inc/FMediaImageBuffer.h b/inc/FMediaImageBuffer.h
index 9e905e6..d55936b 100644 (file)
--- a/inc/FMediaImageBuffer.h
+++ b/inc/FMediaImageBuffer.h
@@ -187,11 +187,12 @@ public:
        * @exception  E_UNSUPPORTED_FORMAT  The specified format is not supported.
        * @exception  E_OUT_OF_MEMORY       The memory is insufficient.
        * @exception  E_FILE_NOT_FOUND      The specified file cannot be found or accessed.
-       * @remarks    There is a high probability for an occurrence of an out-of-memory exception.
+       * @remarks
+       *           - There is a high probability for an occurrence of an out-of-memory exception.
        *             If possible, check whether the exception is E_OUT_OF_MEMORY or not. @n
        *             For more information on how to handle the out-of-memory exception, refer 
        *             <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.htm">here</a>.
-       * @remarks    This method does not retain the aspect ratio of the original image.
+       *           - This method does not retain the aspect ratio of the original image.
        */
        result Construct(const Tizen::Base::String &srcImagePath, int destWidth, int destHeight, ImageScalingMethod scalingMethod);
 
@@ -209,11 +210,12 @@ public:
        * @exception  E_INVALID_ARG         A specified input parameter is invalid.
        * @exception  E_UNSUPPORTED_FORMAT  The specified format is not supported.
        * @exception  E_OUT_OF_MEMORY       The memory is insufficient.
-       * @remarks    There is a high probability for an occurrence of an out-of-memory exception.
+       * @remarks
+       *           - There is a high probability for an occurrence of an out-of-memory exception.
        *             If possible, check whether the exception is E_OUT_OF_MEMORY or not. @n
        *             For more information on how to handle the out-of-memory exception, refer
        *             <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.htm">here</a>.
-       * @remarks    This method does not retain the aspect ratio of the original image.
+       *           - This method does not retain the aspect ratio of the original image.
        */
        result Construct(const Tizen::Base::ByteBuffer &srcImageBuf, int destWidth, int destHeight, ImageScalingMethod scalingMethod);
 
@@ -348,8 +350,9 @@ public:
        * @exception  E_INVALID_ARG         A specified input parameter is invalid.
        * @exception  E_UNSUPPORTED_FORMAT  The specified format is not supported.
        * @exception  E_OUT_OF_MEMORY       The memory is insufficient.
-       * @remarks    The specific error code can be accessed using the GetLastResult() method.
-       * @remarks    This method returns auto scaled bitmap to support logical coordinate system,
+       * @remarks
+       *           - The specific error code can be accessed using the GetLastResult() method.
+       *           - This method returns auto scaled bitmap to support logical coordinate system,
        *             so the actual dimension of the returned bitmap can be vary depending on the physical dimension of target device.
        */
        Tizen::Graphics::Bitmap* GetBitmapN(Tizen::Graphics::BitmapPixelFormat pixelFormat, float destWidth, float destHeight) const;
@@ -394,8 +397,9 @@ public:
        * @exception  E_INVALID_DATA        The current data is invalid for this operation. @n
        *                                   This will happen when the width or height is not even value,
        *                                   and the requested pixel format is sub-sampled pixel format like @c MEDIA_PIXEL_FORMAT_YUV420P.
-       * @remarks    The specific error code can be accessed using the GetLastResult() method.
-       * @remarks    There is a high probability for an occurrence of an out-of-memory exception. If possible, check whether the exception is @c E_OUT_OF_MEMORY or not.
+       * @remarks
+       *           - The specific error code can be accessed using the GetLastResult() method.
+       *           - There is a high probability for an occurrence of an out-of-memory exception. If possible, check whether the exception is @c E_OUT_OF_MEMORY or not.
        *             For more information on how to handle the out-of-memory exception, refer <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.htm">here</a>.
        */
        ImageBuffer* ConvertPixelFormatN(MediaPixelFormat pixelFormat) const;
@@ -415,8 +419,9 @@ public:
        * @exception  E_INVALID_DATA        The current data is invalid for this operation. @n
        *                                   This will happen when the current pixel format is sub-sampled pixel format like @c MEDIA_PIXEL_FORMAT_YUV420P
        *                                   and the requested @c width or @c height is not even value.
-       * @remarks    The specific error code can be accessed using the GetLastResult() method.
-       * @remarks    There is a high probability for an occurrence of an out-of-memory exception. If possible, check whether the exception is @c E_OUT_OF_MEMORY or not.
+       * @remarks
+       *           - The specific error code can be accessed using the GetLastResult() method.
+       *           - There is a high probability for an occurrence of an out-of-memory exception. If possible, check whether the exception is @c E_OUT_OF_MEMORY or not.
        *             For more information on how to handle the out-of-memory exception, refer <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.htm">here</a>.
        */
        ImageBuffer* ResizeN(int width, int height) const;
@@ -431,8 +436,9 @@ public:
        * @exception  E_SUCCESS             The method is successful.
        * @exception  E_INVALID_ARG         The specified input parameter is invalid.
        * @exception  E_OUT_OF_MEMORY       The memory is insufficient.
-       * @remarks    The specific error code can be accessed using the GetLastResult() method.
-       * @remarks    There is a high probability for an occurrence of an out-of-memory exception. If possible, check whether the exception is @c E_OUT_OF_MEMORY or not.
+       * @remarks
+       *           - The specific error code can be accessed using the GetLastResult() method.
+       *           - There is a high probability for an occurrence of an out-of-memory exception. If possible, check whether the exception is @c E_OUT_OF_MEMORY or not.
        *             For more information on how to handle the out-of-memory exception, refer <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.htm">here</a>.
        */
        ImageBuffer* FlipN(ImageFlipType flipType) const;
@@ -450,8 +456,9 @@ public:
        *                                   This will happen when the current pixel format is sub-sampled pixel format like @c MEDIA_PIXEL_FORMAT_YUYV422
        *                                   and the height is odd value and the requested rotation type is @c IMAGE_ROTATION_90 or @c IMAGE_ROTATION_270.
        * @exception  E_OUT_OF_MEMORY    The memory is insufficient.
-       * @remarks    The specific error code can be accessed using the GetLastResult() method.
-       * @remarks    There is a high probability for an occurrence of an out-of-memory exception. If possible, check whether the exception is @c E_OUT_OF_MEMORY or not.
+       * @remarks
+       *           - The specific error code can be accessed using the GetLastResult() method.
+       *           - There is a high probability for an occurrence of an out-of-memory exception. If possible, check whether the exception is @c E_OUT_OF_MEMORY or not.
        *             For more information on how to handle the out-of-memory exception, refer <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.htm">here</a>.
        */
        ImageBuffer* RotateN(ImageRotationType rotateType) const;
@@ -471,9 +478,10 @@ public:
        * @exception  E_INVALID_DATA        The current data is invalid for this operation. @n
        *                                   This will happen when the current pixel format is sub-sampled pixel format like @c MEDIA_PIXEL_FORMAT_YUV420P
        *                                   and the requested @c x, @c y, @c width, or @c height is not even value.
-       * @remarks    The specific error code can be accessed using the GetLastResult() method.
-       * @remarks    There is a high probability for an occurrence of an out-of-memory exception. If possible, check whether the exception is @c E_OUT_OF_MEMORY or not.
-       *              For more information on how to handle the out-of-memory exception, refer <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.htm">here</a>.
+       * @remarks
+       *           - The specific error code can be accessed using the GetLastResult() method.
+       *           - There is a high probability for an occurrence of an out-of-memory exception. If possible, check whether the exception is @c E_OUT_OF_MEMORY or not.
+       *             For more information on how to handle the out-of-memory exception, refer <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.htm">here</a>.
        */
        ImageBuffer* CropN(int x, int y, int width, int height) const;