Doxygen update according to multiple @remarks idiom

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

diff --git a/inc/FMediaAudioDecoder.h b/inc/FMediaAudioDecoder.h
index dc1ca3d..c522d87 100644 (file)
--- a/inc/FMediaAudioDecoder.h
+++ b/inc/FMediaAudioDecoder.h
@@ -281,8 +281,9 @@ public:
        *             else @c null if an exception occurs
        * @exception  E_SUCCESS             The method is successful.
        * @exception  E_OUT_OF_MEMORY       The memory is insufficient.
-       * @remarks    The specific error code can be accessed using the GetLastResult() method.
-       * @remarks    The return value must be deleted by the caller.
+       * @remarks
+       *                       - The specific error code can be accessed using the GetLastResult() method.
+       *                       - The return value must be deleted by the caller.
        */
        static Tizen::Base::Collection::IListT<CodecType>* GetSupportedCodecListN(void);
 

diff --git a/inc/FMediaAudioEncoder.h b/inc/FMediaAudioEncoder.h
index 6f8b494..cd55842 100644 (file)
--- a/inc/FMediaAudioEncoder.h
+++ b/inc/FMediaAudioEncoder.h
@@ -186,8 +186,9 @@ public:
        *             else @c null if an exception occurs
        * @exception  E_SUCCESS             The method is successful.
        * @exception  E_OUT_OF_MEMORY       The memory is insufficient.
-       * @remarks    The specific error code can be accessed using the GetLastResult() method.
-       * @remarks    The return value must be deleted by the caller.
+       * @remarks
+       *                       - The specific error code can be accessed using the GetLastResult() method.
+       *                       - The return value must be deleted by the caller.
        */
        static Tizen::Base::Collection::IListT<CodecType>* GetSupportedCodecListN(void);
 

diff --git a/inc/FMediaVideoDecoder.h b/inc/FMediaVideoDecoder.h
index eae9e6e..7829f51 100644 (file)
--- a/inc/FMediaVideoDecoder.h
+++ b/inc/FMediaVideoDecoder.h
@@ -180,21 +180,22 @@ public:
         *      @exception      E_INVALID_ARG                   The specified @c srcBuf or @c dstBuf is invalid.
         *      @exception      E_UNSUPPORTED_FORMAT    The input data is not in a supported format.
         *      @exception      E_OUT_OF_MEMORY                 The destination buffer has insufficient memory.
-        *  @exception    E_DIMENSION_CHANGED           The dimension of video stream has changed.
+        *  @exception  E_DIMENSION_CHANGED             The dimension of video stream has changed.
         *      @exception  E_SYSTEM                            A system error has occurred.
-        *      @remarks        The destination buffer must have sufficient free space to store the decoded frame data.
-        *      @remarks        The decoder starts the decoding of the frame from the current position of the source buffer,
+        *      @remarks
+        *                        - The destination buffer must have sufficient free space to store the decoded frame data.
+        *                        - The decoder starts the decoding of the frame from the current position of the source buffer,
         *                              and moves the position of the source buffer to the end of the consumed data.
         *                              The decoder also fills the destination buffer with the decoded frame from the current position of the destination buffer,
         *                              and moves the position of the destination buffer to the end of the decoded frame.
-        *  @remarks    When the first decoding begins, the @c E_DIMENSION_CHANGED exception can occur.
-        *                        An exception can also occur when the dimension of the video frame in the bitstream has changed.
-        *                        An application should increase the size of @c dstBuf if the @c dstBuf cannot hold the video frame with new dimensions.
-        *                        The video frame can be received even if the result is @c E_DIMENSION_CHANGED.
-        *                        The application should check the @c position of the destination buffer and the value of @c gotFrame
-        *                        when the result is @c E_DIMENSION_CHANGED.
-        * @remarks     The H.264 video decoder returns data with the width and height in multiples of 16.
-        *                              The application should detect the width and height of the frame and crop the decoder's output data if the original dimension is not a multiple of @c 16.
+        *                        - When the first decoding begins, the @c E_DIMENSION_CHANGED exception can occur.
+        *                              An exception can also occur when the dimension of the video frame in the bitstream has changed.
+        *                              An application should increase the size of @c dstBuf if the @c dstBuf cannot hold the video frame with new dimensions.
+        *                              The video frame can be received even if the result is @c E_DIMENSION_CHANGED.
+        *                              The application should check the @c position of the destination buffer and the value of @c gotFrame
+        *                              when the result is @c E_DIMENSION_CHANGED.
+        *                        - The H.264 video decoder returns data with the width and height in multiples of 16.
+        *                              The application should detect the width and height of the frame and crop the decoder's output data if the original dimension is not a multiple of @c 16.
         *      @see Probe()
         */
        result Decode(Tizen::Base::ByteBuffer& srcBuf, Tizen::Base::ByteBuffer& dstBuf, bool& gotFrame);
@@ -257,8 +258,9 @@ public:
         *      @exception      E_OUT_OF_MEMORY          The memory is insufficient.
         *      @exception      E_OBJ_NOT_FOUND                 This instance does not support any property.
         *      @exception      E_SYSTEM                                A system error has occurred.
-        *      @remarks        The specific error code can be accessed using the GetLastResult() method.
-        *      @remarks        The return value must be deleted.
+        *      @remarks
+        *                        - The specific error code can be accessed using the GetLastResult() method.
+        *                        - The return value must be deleted.
         */
        Tizen::Base::Collection::IListT<MediaPropertyType>* GetSupportedPropertyListN(void) const;
 
@@ -285,8 +287,9 @@ public:
         *             else @c null if an exception occurs
         * @exception  E_SUCCESS             The method is successful.
         * @exception  E_OUT_OF_MEMORY       The memory is insufficient.
-        * @remarks    The specific error code can be accessed using the GetLastResult() method.
-        * @remarks    The return value must be deleted by the caller.
+        * @remarks
+        *                       - The specific error code can be accessed using the GetLastResult() method.
+        *                       - The return value must be deleted by the caller.
         */
        static Tizen::Base::Collection::IListT<CodecType>* GetSupportedCodecListN(void);
 

diff --git a/inc/FMediaVideoEncoder.h b/inc/FMediaVideoEncoder.h
index 8464e79..597b437 100644 (file)
--- a/inc/FMediaVideoEncoder.h
+++ b/inc/FMediaVideoEncoder.h
@@ -144,11 +144,12 @@ public:
         *      @exception      E_INVALID_ARG           A specified input parameter has invalid data.
         *      @exception      E_OUT_OF_MEMORY         The memory is insufficient. 
         *      @exception      E_SYSTEM                        A system error has occurred.
-        *      @remarks        The key type of the specified option is Tizen::Base::Integer and the value type varies depending
-        *                        on the key type.
+        *      @remarks
+        *                        - The key type of the specified option is Tizen::Base::Integer and the value type varies depending
+        *                              on the key type.
         *                              The unsupported keys in @c pOption are ignored.
         *                              If specified @c pOption has an invalid value, @c E_INVALID_ARG is returned.
-        *  @remarks The supported codec types can vary depending on the device model or platform version.
+        *                        - The supported codec types can vary depending on the device model or platform version.
         */
        result Construct(CodecType type, const Tizen::Base::Collection::HashMap* pOption = null);
 
@@ -165,8 +166,9 @@ public:
         *      @exception      E_INVALID_ARG                   The specified source or destination buffer is invalid or has insufficient memory.
         *      @exception      E_OUT_OF_MEMORY                 The memory is insufficient.
         *      @exception      E_SYSTEM                                A system error has occurred.
-        *      @remarks        The destination buffer must have sufficient free space to store the encoded frame data.
-        *      @remarks        The position of the source buffer is moved to the end of the consumed data and the position of the destination buffer is moved to the end of the written data.
+        *      @remarks
+        *                        - The destination buffer must have sufficient free space to store the encoded frame data.
+        *                        - The position of the source buffer is moved to the end of the consumed data and the position of the destination buffer is moved to the end of the written data.
         */
        result Encode(Tizen::Base::ByteBuffer& srcBuf, Tizen::Base::ByteBuffer& dstBuf);
 
@@ -256,8 +258,9 @@ public:
         *             else @c null if an exception occurs
         * @exception  E_SUCCESS             The method is successful.
         * @exception  E_OUT_OF_MEMORY       The memory is insufficient.
-        * @remarks    The specific error code can be accessed using the GetLastResult() method.
-        * @remarks    The return value must be deleted by the caller.
+        * @remarks
+        *                       - The specific error code can be accessed using the GetLastResult() method.
+        *                       - The return value must be deleted by the caller.
         */
        static Tizen::Base::Collection::IListT<CodecType>* GetSupportedCodecListN(void);
 

diff --git a/inc/FMediaVideoFrameExtractor.h b/inc/FMediaVideoFrameExtractor.h
index e623627..f1ec832 100644 (file)
--- a/inc/FMediaVideoFrameExtractor.h
+++ b/inc/FMediaVideoFrameExtractor.h
@@ -150,10 +150,11 @@ public:
         * @exception  E_OUT_OF_MEMORY       The memory is insufficient.
         * @exception  E_OPERATION_FAILED    Video frame at given position is not found or extraction is failed.
         * @exception  E_UNSUPPORTED_FORMAT  The specified pixel format is not supported.
-        * @remarks    The specific error code can be accessed using the GetLastResult() method.
-        * @remarks    The extracted frame may not be exact frame of given timestamp,
+        * @remarks
+        *           - The specific error code can be accessed using the GetLastResult() method.
+        *           - The extracted frame may not be exact frame of given timestamp,
         *             so that the same frame can be returned even if the timestamp is different.
-        * @remarks    Frames near the end of contents may not be extracted if no key-frame is found after timestamp.
+        *           - Frames near the end of contents may not be extracted if no key-frame is found after timestamp.
         */
        ImageBuffer* GetFrameN(long timestamp);
 
@@ -172,10 +173,11 @@ public:
         * @exception  E_OUT_OF_MEMORY       The memory is insufficient.
         * @exception  E_OPERATION_FAILED    Video frame at given position is not found or extraction is failed.
         * @exception  E_UNSUPPORTED_FORMAT  The specified pixel format is not supported.
-        * @remarks    The specific error code can be accessed using the GetLastResult() method.
-        * @remarks    The extracted frame may not be exact frame of given timestamp,
+        * @remarks
+        *           - The specific error code can be accessed using the GetLastResult() method.
+        *           - The extracted frame may not be exact frame of given timestamp,
         *             so that the same frame can be returned even if the timestamp is different.
-        * @remarks    Frames near the end of contents may not be extracted if no key-frame is found after timestamp.
+        *           - Frames near the end of contents may not be extracted if no key-frame is found after timestamp.
         */
        static ImageBuffer* GetFrameN(const Tizen::Base::String& path, MediaPixelFormat pixelFormat, long timestamp);