[content] Fix a description for ContentManager
[platform/framework/native/content.git] / inc / FCntContentManagerUtil.h
index 0a4dd65..4c42a6a 100644 (file)
@@ -86,7 +86,7 @@ class _OSP_EXPORT_ ContentManagerUtil
 {
 public:
        /**
-        * Gets the metadata of an image from the file.
+        * Gets the metadata for an image from the file.
         *
         * @if OSPCOMPAT
         * @brief       <i> [Compatibility] </i>
@@ -102,13 +102,14 @@ public:
         * @param[in]   filePath                                        The file path
         * @exception   E_SUCCESS                                       The method is successful.
         * @exception   E_INVALID_ARG                           The specified input parameter is invalid.
-        * @remarks     If the image data is valid but meta information does not exist, the width and height are set from actual image data.
-        *                              The specific error code can be accessed using the GetLastResult() method.
+        * @remarks
+        *                              - If the image data is valid but meta information does not exist, the width and height are set from actual image data.
+        *                              - The specific error code can be accessed using the GetLastResult() method.
         */
        static Tizen::Content::ImageMetadata* GetImageMetaN(const Tizen::Base::String& filePath);
 
        /**
-        * Gets the metadata of an image from the buffer.
+        * Gets the metadata for an image from the buffer.
         *
         * @since               2.1
         *
@@ -117,13 +118,14 @@ public:
         * @param[in]   byteBuffer                                      The buffer that contains image data
         * @exception   E_SUCCESS                                       The method is successful.
         * @exception   E_INVALID_ARG                           The specified input parameter is invalid.
-        * @remarks     If the image data in the buffer is valid but meta information does not exist, the width and height are set from actual image data.
-        *                              The specific error code can be accessed using the GetLastResult() method.
+        * @remarks
+        *                              - If the image data in the buffer is valid but meta information does not exist, the width and height are set from actual image data.
+        *                              - The specific error code can be accessed using the GetLastResult() method.
         */
        static Tizen::Content::ImageMetadata* GetImageMetaN(const Tizen::Base::ByteBuffer& byteBuffer);
 
        /**
-        * Gets the metadata of an audio from the file.
+        * Gets the metadata for an audio from the file.
         *
         * @if OSPCOMPAT
         * @brief       <i> [Compatibility] </i>
@@ -139,13 +141,14 @@ public:
         * @param[in]   filePath                                        The file path
         * @exception   E_SUCCESS                                       The method is successful.
         * @exception   E_INVALID_ARG                           The specified input parameter is invalid.
-        * @remarks     If the audio data is valid but meta information does not exist, the duration is set from actual audio data.
-        *                              The specific error code can be accessed using the GetLastResult() method.
+        * @remarks
+        *                              - If the audio data is valid but meta information does not exist, the duration is set from actual audio data.
+        *                              - The specific error code can be accessed using the GetLastResult() method.
         */
        static Tizen::Content::AudioMetadata* GetAudioMetaN(const Tizen::Base::String& filePath);
 
        /**
-        * Gets the metadata of an audio from the buffer.
+        * Gets the metadata for an audio from the buffer.
         *
         * @since               2.1
         *
@@ -154,13 +157,14 @@ public:
         * @param[in]   byteBuffer                                      The buffer that contains audio data
         * @exception   E_SUCCESS                                       The method is successful.
         * @exception   E_INVALID_ARG                           The specified input parameter is invalid.
-        * @remarks     If the audio data in the buffer is valid but meta information does not exist, the duration is set from actual audio data.
-        *                              The specific error code can be accessed using the GetLastResult() method.
+        * @remarks
+        *                              - If the audio data in the buffer is valid but meta information does not exist, the duration is set from actual audio data.
+        *                              - The specific error code can be accessed using the GetLastResult() method.
         */
        static Tizen::Content::AudioMetadata* GetAudioMetaN(const Tizen::Base::ByteBuffer& byteBuffer);
 
        /**
-        * Gets the metadata of a video from the file.
+        * Gets the metadata for a video from the file.
         *
         * @if OSPCOMPAT
         * @brief       <i> [Compatibility] </i>
@@ -176,13 +180,14 @@ public:
         * @param[in]   filePath                                        The file path
         * @exception   E_SUCCESS                                       The method is successful.
         * @exception   E_INVALID_ARG                           The specified input parameter is invalid.
-        * @remarks     If the video data is valid but meta information does not exist, the duration is set from actual video data.
-        *                              The specific error code can be accessed using the GetLastResult() method.
+        * @remarks
+        *                              - If the video data is valid but meta information does not exist, the duration is set from actual video data.
+        *                              - The specific error code can be accessed using the GetLastResult() method.
         */
        static Tizen::Content::VideoMetadata* GetVideoMetaN(const Tizen::Base::String& filePath);
 
        /**
-        * Gets the metadata of a video from the buffer.
+        * Gets the metadata for a video from the buffer.
         *
         * @since               2.1
         *
@@ -191,8 +196,9 @@ public:
         * @param[in]   byteBuffer                                      The buffer that contains video data
         * @exception   E_SUCCESS                                       The method is successful.
         * @exception   E_INVALID_ARG                           The specified input parameter is invalid.
-        * @remarks     If the video data in the buffer is valid but meta information does not exist, the duration is set from actual video data.
-        *                              The specific error code can be accessed using the GetLastResult() method.
+        * @remarks
+        *                              - If the video data in the buffer is valid but meta information does not exist, the duration is set from actual video data.
+        *                              - The specific error code can be accessed using the GetLastResult() method.
         */
        static Tizen::Content::VideoMetadata* GetVideoMetaN(const Tizen::Base::ByteBuffer& byteBuffer);
 
@@ -208,15 +214,16 @@ public:
         *                       For more information, see @ref CompContentManagerUtilPage "here".
         * @endif
         *
-        * @return                      The content type
+        * @return              The content type
         * @param[in]   filePath                                                The file path
         * @exception   E_SUCCESS                                               The method is successful.
         * @exception   E_INVALID_ARG                                   The specified input parameter is invalid, or
         *                                                          the length of the specified path is @c 0 or exceeds system limitations.
         * @exception   E_FILE_NOT_FOUND                        The specified file cannot be found.
-        * @exception    E_UNSUPPORTED_FORMAT   The specified format is invalid or not supported.
-        * @remarks             The content type can be different for each device. @n
-        *                     The specific error code can be accessed using the GetLastResult() method.
+        * @exception   E_UNSUPPORTED_FORMAT    The specified format is invalid or not supported.
+        * @remarks
+        *                              - The content type can be different for each device.
+        *                              - The specific error code can be accessed using the GetLastResult() method.
         */
        static Tizen::Content::ContentType CheckContentType(const Tizen::Base::String& filePath);