[content] Reflection of inspected header files

Change-Id: I5c5be736ba17b53dbb292e380dbb3c2ae0fb840f
Signed-off-by: Seokpil Park <seokpil.park@samsung.com>

diff --git a/inc/FCntAudioMetadata.h b/inc/FCntAudioMetadata.h
index 03fb89b..a2be24e 100644 (file)
--- a/inc/FCntAudioMetadata.h
+++ b/inc/FCntAudioMetadata.h
@@ -188,52 +188,52 @@ public:
        Tizen::Base::String GetComment(void) const;
 
        /**
-        * Gets the description of the audio file.
+        * Gets the description of an audio file.
         *
         * @since               2.1
         *
-        * @return              The description of the audio file
+        * @return              The description of an audio file
         */
        Tizen::Base::String GetDescription(void) const;
 
        /**
-        * Gets the track number of the audio file.
+        * Gets the track number of an audio file.
         *
         * @since               2.0
         *
-        * @return              The track number of the audio file
+        * @return              The track number of an audio file
         */
        int GetTrack(void) const;
 
        /**
-        * Gets the genre information of the audio file.
+        * Gets the genre information of an audio file.
         *
         * @since               2.0
         *
-        * @return              The genre information of the audio file
+        * @return              The genre information of an audio file
         */
        Tizen::Base::String GetGenre(void) const;
 
        /**
-        * Gets the composer information of the audio file.
+        * Gets the composer information of an audio file.
         *
         * @since               2.0
         *
-        * @return              The composer information of the audio file
+        * @return              The composer information of an audio file
         */
        Tizen::Base::String GetComposer(void) const;
 
        /**
-        * Gets the copyright information of the audio file.
+        * Gets the copyright information of an audio file.
         *
         * @since               2.0
         *
-        * @return              The copyright information of the audio file
+        * @return              The copyright information of an audio file
         */
        Tizen::Base::String GetCopyright(void) const;
 
        /**
-        * Gets the duration of the audio file.
+        * Gets the duration of an audio file.
         *
         * @since               2.0
         *
@@ -242,16 +242,16 @@ public:
        long GetDuration(void) const;
 
        /**
-        * Gets the year information of the audio file.
+        * Gets the year information of an audio file.
         *
         * @since               2.0
         *
-        * @return              The year information of the audio file
+        * @return              The year information of an audio file
         */
        int GetYear(void) const;
 
        /**
-        * Gets the track information of the audio file.
+        * Gets the track information of an audio file.
         *
         * @since               2.0
         *
@@ -262,27 +262,27 @@ public:
        Tizen::Base::String GetTrackInfo(void) const;
 
        /**
-        * Gets the recording date of the audio file.
+        * Gets the recording date of an audio file.
         *
         * @since               2.0
         *
-        * @return              The recording date of the audio file
+        * @return              The recording date of an audio file
         */
        Tizen::Base::String GetRecordingDate(void) const;
 
        /**
-        * Gets the number of channels of the audio file.
+        * Gets the number of channels of an audio file.
         *
         * @since               2.0
         *
-        * @return              The number of channels of the audio file
+        * @return              The number of channels of an audio file
         * @remarks     A monophonic stream has one channel and a stereophonic stream has two channels. @n
         *                                      Valid values are either @c 1 or @c 2.
         */
        int GetChannelCount(void) const;
 
        /**
-        * Gets the thumbnail of the audio file.
+        * Gets the thumbnail of an audio file.
         *
         * @since                       2.0
         *
@@ -296,7 +296,7 @@ public:
        Tizen::Graphics::Bitmap* GetThumbnailN(void) const;
 
        /**
-        * Gets the album art of the audio file.
+        * Gets the album art of an audio file.
         *
         * @since                       2.0
         *

diff --git a/inc/FCntContentManager.h b/inc/FCntContentManager.h
index ef31aa5..16046f9 100644 (file)
--- a/inc/FCntContentManager.h
+++ b/inc/FCntContentManager.h
@@ -432,7 +432,7 @@ public:
        result DeleteContent(const ContentId& contentId);
 
        /**
-        * Adds a listener to receive the database change notification
+        * Adds a listener to receive the database change notification.
         *
         * @since                       2.1
         *
@@ -445,7 +445,7 @@ public:
        result AddContentUpdateEventListener(IContentUpdateEventListener& listener);
 
        /**
-        * Removes a listener
+        * Removes a listener.
         *
         * @since           2.1
         *
@@ -459,7 +459,7 @@ public:
 
 
        /**
-        * Requests to scan a file
+        * Requests to scan a file.
         *
         * @since                       2.1
         * @privlevel           public
@@ -467,16 +467,16 @@ public:
         *
         * @return              An error code
         * @param[in]   contentPath                     The content path
-        * @exception   E_SUCCESS                               The method is successful.
-        * @exception   E_INVALID_ARG                   The specified input parameter is invalid.
+        * @exception   E_SUCCESS                       The method is successful.
+        * @exception   E_INVALID_ARG           The specified input parameter is invalid.
         * @exception   E_SERVICE_BUSY          The database is busy.
         * @exception   E_PRIVILEGE_DENIED      The application does not have the privilege to call this method.
-        * @exception   E_SYSTEM                                The method cannot proceed due to a severe system error.
+        * @exception   E_SYSTEM                        The method cannot proceed due to a severe system error.
         */
        static result ScanFile(const Tizen::Base::String& contentPath);
 
        /**
-        * Requests to scan a directory
+        * Requests to scan a directory.
         *
         * @since                       2.1
         * @privlevel           public
@@ -484,14 +484,14 @@ public:
         *
         * @return                      An error code
         * @param[in]           directoryPath                   The directory path
-        * @param[in]           recursive                               Set to @c true in order to scan recursively sub directories, @n
-        *                                       else @c false
+        * @param[in]           recursive                               Set to @c true in order to recursively scan sub directories, @n
+        *                                          else @c false
         * @param[in]           pListener                               The scan event listener
-        * @param[out]  reqId                                   The request ID
+        * @param[out]          reqId                                   The request ID
         * @exception           E_SUCCESS                               The method is successful.
         * @exception           E_INVALID_ARG                   The specified input parameter is invalid.
-        * @exception           E_SERVICE_BUSY          The database is busy.
-        * @exception           E_PRIVILEGE_DENIED      The application does not have the privilege to call this method.
+        * @exception           E_SERVICE_BUSY                  The database is busy.
+        * @exception           E_PRIVILEGE_DENIED              The application does not have the privilege to call this method.
         * @exception           E_SYSTEM                                The method cannot proceed due to a severe system error.
         * @remark                      Platform does not have the ownership of the listener.
         */

diff --git a/inc/FCntContentManagerUtil.h b/inc/FCntContentManagerUtil.h
index 0a4dd65..9ad61ea 100644 (file)
--- a/inc/FCntContentManagerUtil.h
+++ b/inc/FCntContentManagerUtil.h
@@ -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>
@@ -108,7 +108,7 @@ public:
        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
         *
@@ -123,7 +123,7 @@ public:
        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>
@@ -145,7 +145,7 @@ public:
        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
         *
@@ -160,7 +160,7 @@ public:
        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>
@@ -182,7 +182,7 @@ public:
        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
         *

diff --git a/inc/FCntDownloadManager.h b/inc/FCntDownloadManager.h
index 77fe3ac..4ba2d6b 100644 (file)
--- a/inc/FCntDownloadManager.h
+++ b/inc/FCntDownloadManager.h
@@ -170,7 +170,7 @@ public:
        * @exception    E_SUCCESS           The method is successful.
        * @exception    E_INVALID_ARG           There is no download request for the specified @c reqId.
        * @exception    E_INVALID_OPERATION     The current download state prohibits the execution of this operation. @n
-       *                                                                       The download state of the request ID is not paused or failed.
+       *                                                                       The download state for the specified request ID is either not paused or has failed.
        * @exception    E_SYSTEM            The method cannot proceed due to a severe system error.
        */
        result Resume(RequestId reqId);
@@ -223,7 +223,7 @@ public:
        * @exception    E_SUCCESS           The method is successful.
        * @exception    E_INVALID_ARG           There is no download request for the specified @c reqId.
        * @exception    E_INVALID_OPERATION     The current download state prohibits the execution of this operation. @n
-       *                                                                       The download operation is not started.
+       *                                                                       The download operation has not yet started.
        * @exception    E_SYSTEM            The method cannot proceed due to a severe system error.
        */
        result GetMimeType(RequestId reqId, Tizen::Base::String& mimeType) const;

diff --git a/inc/FCntIContentScanListener.h b/inc/FCntIContentScanListener.h
index 37df100..0c0f020 100644 (file)
--- a/inc/FCntIContentScanListener.h
+++ b/inc/FCntIContentScanListener.h
@@ -57,9 +57,9 @@ public:
         * @param[in]           reqId                           The request ID returned by ContentManager::ScanDirectory()
         * @param[in]           scanPath                        The scan path.
         * @param[in]           r                                       The error of scan operation.
-        *                                                                              The following exception is given through this parameter.
+        *                                                                              The following exceptions are given through this parameter.
         * @exception           E_SUCCESS                       The method is successful
-        * @exception           E_SERVICE_BUSY  The database is busy.
+        * @exception           E_SERVICE_BUSY      The database is busy.
         * @exception           E_SYSTEM                        The method cannot proceed due to a severe system error.
         */
        virtual void OnContentScanCompleted(RequestId reqId, const Tizen::Base::String& scanPath, result r) = 0;

diff --git a/inc/FCntVideoMetadata.h b/inc/FCntVideoMetadata.h
index b91fd70..f8fd6c7 100644 (file)
--- a/inc/FCntVideoMetadata.h
+++ b/inc/FCntVideoMetadata.h
@@ -176,25 +176,25 @@ public:
        Tizen::Base::String GetGenre(void) const;
 
        /**
-        * Gets the comment of the video file.
+        * Gets a comment of a video file.
         *
         * @since               2.1
         *
-        * @return              The comment of the video file
+        * @return              A comment of a video file
         */
        Tizen::Base::String GetComment(void) const;
 
        /**
-        * Gets the description of the video file.
+        * Gets the description of a video file.
         *
         * @since               2.1
         *
-        * @return              The description of the video file
+        * @return              The description of a video file
         */
        Tizen::Base::String GetDescription(void) const;
 
        /**
-        * Gets the album art of the video.
+        * Gets the album art of a video.
         *
         * @since                       2.0
         *