From fcbaf6fc46929d7eb36d171f0cd42786dbd563a5 Mon Sep 17 00:00:00 2001 From: Seokpil Park Date: Sat, 13 Apr 2013 13:11:45 +0900 Subject: [PATCH] [content] Updates examined documents Change-Id: I30408e0e267b23fc837e08c31133616d8f36f96d Signed-off-by: Seokpil Park --- inc/FCntAudioContentInfo.h | 12 ++++++------ inc/FCntAudioMetadata.h | 6 +++--- inc/FCntContentDirectory.h | 8 ++++---- inc/FCntContentManager.h | 17 ++++++++--------- inc/FCntContentManagerUtil.h | 22 ++++++++++++---------- inc/FCntContentSearch.h | 26 ++++++++++++-------------- inc/FCntContentTransfer.h | 13 +++++++------ inc/FCntDownloadManager.h | 5 +++-- inc/FCntIContentScanListener.h | 4 ++-- inc/FCntIContentTransferListener.h | 3 ++- inc/FCntIContentUpdateEventListener.h | 26 +++++++++++++------------- inc/FCntImageContentInfo.h | 7 +++---- inc/FCntOtherContentInfo.h | 7 +++---- inc/FCntTypes.h | 10 +++++----- inc/FCntVideoContentInfo.h | 7 +++---- inc/FContent.h | 4 ++-- 16 files changed, 88 insertions(+), 89 deletions(-) diff --git a/inc/FCntAudioContentInfo.h b/inc/FCntAudioContentInfo.h index b71c750..6532010 100644 --- a/inc/FCntAudioContentInfo.h +++ b/inc/FCntAudioContentInfo.h @@ -76,11 +76,10 @@ class _OSP_EXPORT_ AudioContentInfo { public: /** - * The object is not fully constructed after this constructor is called. For full construction, the Construct() method must be called right after calling this constructor. + * The object is not fully constructed after this constructor is called. @n + * For full construction, the Construct() method must be called right after calling this constructor. * * @since 2.0 - * - * @remarks After creating an instance of this class, the Construct() method must be called explicitly to initialize this instance. */ AudioContentInfo(void); @@ -112,7 +111,7 @@ public: * @exception E_IO An I/O error has occurred. * @exception E_SYSTEM An internal error has occurred. * @remarks The @c pContentPath should start with directory path returned by either Tizen::System::Environment::GetMediaPath() or Tizen::System::Environment::GetExternalStoragePath(). @n - * If @c pContentPath is @c null, use ContentManager::CreateContent(const Tizen::Base::ByteBuffer&, const Tizen::Base::String&, const ContentInfo*) + * If @c pContentPath is @c null, use ContentManager::CreateContent(const Tizen::Base::ByteBuffer&, const Tizen::Base::String&, const ContentInfo*) @n * or ContentManager::CreateContent(const Tizen::Base::String&, const Tizen::Base::String&, bool, const ContentInfo*). */ result Construct(const Tizen::Base::String* pContentPath); @@ -159,8 +158,9 @@ public: * @exception E_INVALID_ARG The specified input parameter is invalid. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_IO An I/O error has occurred. - * @remarks The content path must start with @c '/Media' or @c '/Storagecard/Media'. @n - * The thumbnail path must start with @c '/Home', @c '/Media', or @c '/Storagecard/Media'. @n + * @remarks + * - The content path must start with @c '/Media' or @c '/Storagecard/Media'. + * - The thumbnail path must start with @c '/Home', @c '/Media', or @c '/Storagecard/Media'. @n * The permitted format for a thumbnail image is Bitmap (bmp). * @endif */ diff --git a/inc/FCntAudioMetadata.h b/inc/FCntAudioMetadata.h index 294f9fb..b3561bb 100644 --- a/inc/FCntAudioMetadata.h +++ b/inc/FCntAudioMetadata.h @@ -156,7 +156,7 @@ public: * * @since 2.0 * - * @return The frequency in hertz (hz) + * @return The frequency in hertz (Hz) */ int GetFrequency(void) const; @@ -306,8 +306,8 @@ public: * @exception E_DATA_NOT_FOUND The album art does not exist. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @remarks - * - GetThumbnailN() returns the thumbnail image that is resized to 80x60 pixels. @n - * GetAlbumArtN() returns the original album art that is embedded in the content metadata. + * - GetThumbnailN() returns the thumbnail image that is resized to 80x60 pixels. + * - GetAlbumArtN() returns the original album art that is embedded in the content metadata. * - The specific error code can be accessed using the GetLastResult() method. */ Tizen::Graphics::Bitmap* GetAlbumArtN(void) const; diff --git a/inc/FCntContentDirectory.h b/inc/FCntContentDirectory.h index dabc3c4..7bf21e4 100644 --- a/inc/FCntContentDirectory.h +++ b/inc/FCntContentDirectory.h @@ -128,8 +128,8 @@ public: * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_SYSTEM The method cannot connect to the database. * @remarks This method is used to access only one type of content. @n - * If you want to access more than one type of content, use Construct(const Tizen::Base::Collection::IListT&). - * The allowed types are CONTENT_TYPE_OTHER, CONTENT_TYPE_IMAGE, CONTENT_TYPE_AUDIO, and CONTENT_TYPE_VIDEO. + * If you want to access more than one type of content, use Construct(const Tizen::Base::Collection::IListT&). @n + * The allowed types are @c CONTENT_TYPE_OTHER, @c CONTENT_TYPE_IMAGE, @c CONTENT_TYPE_AUDIO, and @c CONTENT_TYPE_VIDEO. */ result Construct(ContentType contentType); @@ -147,8 +147,8 @@ public: * @remarks This method is used to access more than one type of content. @n * If you want to access only one type of content, use Construct(ContentType). @n * Total count of @c contentTypeList should not be greater than @c 4. @n - * Any combination with CONTENT_TYPE_ALL is a invalid argument. @n - * The allowed types are CONTENT_TYPE_OTHER, CONTENT_TYPE_IMAGE, CONTENT_TYPE_AUDIO, and CONTENT_TYPE_VIDEO. + * Any combination with @c CONTENT_TYPE_ALL is a invalid argument. @n + * The allowed types are @c CONTENT_TYPE_OTHER, @c CONTENT_TYPE_IMAGE, @c CONTENT_TYPE_AUDIO, and @c CONTENT_TYPE_VIDEO. */ result Construct(const Tizen::Base::Collection::IListT& contentTypeList); diff --git a/inc/FCntContentManager.h b/inc/FCntContentManager.h index 3d6ab6e..0c8cf33 100644 --- a/inc/FCntContentManager.h +++ b/inc/FCntContentManager.h @@ -132,11 +132,10 @@ class _OSP_EXPORT_ ContentManager public: /** - * The object is not fully constructed after this constructor is called. For full construction, the Construct() method must be called right after calling this constructor. + * The object is not fully constructed after this constructor is called. @n + * For full construction, the Construct() method must be called right after calling this constructor. * * @since 2.0 - * - * @remarks After creating an instance of this class, the Construct() method must be called explicitly to initialize this instance. */ ContentManager(void); @@ -178,7 +177,7 @@ public: * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. * @exception E_SERVICE_BUSY The database is busy. * @remarks - * - If the E_UNSUPPORTED_FORMAT exception is received from ContentManagerUtil::CheckContentType(), + * - If the @c E_UNSUPPORTED_FORMAT exception is received from ContentManagerUtil::CheckContentType(), * the file can be created as a content only using the OtherContentInfo class. * - The specific error code can be accessed using the GetLastResult() method. */ @@ -259,8 +258,8 @@ public: * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. * @exception E_SERVICE_BUSY The database is busy. * @remarks - * - The source path should start with the directory path returned by either Tizen::App::App::GetAppRootPath() or Tizen::System::Environment::GetExternalStoragePath(). @n - * The destination path should start with the directory path returned by either Tizen::System::Environment::GetMediaPath() or Tizen::System::Environment::GetExternalStoragePath(). + * - The source path should start with the directory path returned by either Tizen::App::App::GetAppRootPath() or Tizen::System::Environment::GetExternalStoragePath(). + * - The destination path should start with the directory path returned by either Tizen::System::Environment::GetMediaPath() or Tizen::System::Environment::GetExternalStoragePath(). * - The specific error code can be accessed using the GetLastResult() method. */ ContentId CreateContent(const Tizen::Base::String& sourcePath, const Tizen::Base::String& destinationPath, bool deleteSource, const ContentInfo* pContentInfo = null); @@ -353,7 +352,7 @@ public: * @since 2.1 * * @return An error code - * @param[in] listener The event listener + * @param[in] listener The event listener to add * @exception E_SUCCESS The method is successful. * @exception E_OBJ_ALREADY_EXIST The listener has already been added. * @exception E_SYSTEM The method cannot proceed due to a severe system error. @@ -368,7 +367,7 @@ public: * @since 2.1 * * @return An error code - * @param[in] listener The event listener + * @param[in] listener The event listener to remove * @exception E_SUCCESS The method is successful. * @exception E_OBJ_NOT_FOUND The listener is not found. * @exception E_SYSTEM The method cannot proceed due to a severe system error. @@ -411,7 +410,7 @@ public: * @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. + * @remarks Platform does not have the ownership of the listener. */ static result ScanDirectory(const Tizen::Base::String& directoryPath, bool recursive, IContentScanListener* pListener, RequestId& reqId); diff --git a/inc/FCntContentManagerUtil.h b/inc/FCntContentManagerUtil.h index 4c42a6a..b0d740f 100644 --- a/inc/FCntContentManagerUtil.h +++ b/inc/FCntContentManagerUtil.h @@ -103,7 +103,7 @@ public: * @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. + * - If the image data is valid but meta information does not exist, the width and height are set from the actual image data. * - The specific error code can be accessed using the GetLastResult() method. */ static Tizen::Content::ImageMetadata* GetImageMetaN(const Tizen::Base::String& filePath); @@ -119,7 +119,7 @@ public: * @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. + * - If the image data in the buffer is valid but meta information does not exist, the width and height are set from the actual image data. * - The specific error code can be accessed using the GetLastResult() method. */ static Tizen::Content::ImageMetadata* GetImageMetaN(const Tizen::Base::ByteBuffer& byteBuffer); @@ -142,7 +142,7 @@ public: * @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. + * - If the audio data is valid but meta information does not exist, the duration is set from the actual audio data. * - The specific error code can be accessed using the GetLastResult() method. */ static Tizen::Content::AudioMetadata* GetAudioMetaN(const Tizen::Base::String& filePath); @@ -158,7 +158,7 @@ public: * @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. + * - If the audio data in the buffer is valid but meta information does not exist, the duration is set from the actual audio data. * - The specific error code can be accessed using the GetLastResult() method. */ static Tizen::Content::AudioMetadata* GetAudioMetaN(const Tizen::Base::ByteBuffer& byteBuffer); @@ -181,7 +181,7 @@ public: * @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. + * - If the video data is valid but meta information does not exist, the duration is set from the actual video data. * - The specific error code can be accessed using the GetLastResult() method. */ static Tizen::Content::VideoMetadata* GetVideoMetaN(const Tizen::Base::String& filePath); @@ -197,7 +197,7 @@ public: * @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. + * - If the video data in the buffer is valid but meta information does not exist, the duration is set from the actual video data. * - The specific error code can be accessed using the GetLastResult() method. */ static Tizen::Content::VideoMetadata* GetVideoMetaN(const Tizen::Base::ByteBuffer& byteBuffer); @@ -253,8 +253,9 @@ public: * - An unexpected device failure has occurred as the media ejected suddenly. @n * - File corruption is detected. @n * - The volume or quota is no more available. - * @remarks The source file in the system region cannot be copied. @n - * The destination file path must start with @c '/Media' or @c '/Storagecard/Media'. + * @remarks + * - The source file in the system region cannot be copied. + * - The destination file path must start with @c '/Media' or @c '/Storagecard/Media'. * @endif */ static result CopyToMediaDirectory(const Tizen::Base::String& srcFilePath, const Tizen::Base::String& destFilePath); @@ -285,8 +286,9 @@ public: * - An unexpected device failure has occurred as the media ejected suddenly. @n * - File corruption is detected. @n * - The volume or quota is no more available. - * @remarks The source file in the system region cannot be copied. @n - * The destination file path must start with @c '/Media' or @c '/Storagecard/Media'. + * @remarks + * - The source file in the system region cannot be copied. + * - The destination file path must start with @c '/Media' or @c '/Storagecard/Media'. * @endif */ static result MoveToMediaDirectory(const Tizen::Base::String& srcFilePath, const Tizen::Base::String& destFilePath); diff --git a/inc/FCntContentSearch.h b/inc/FCntContentSearch.h index f7601fb..916c771 100644 --- a/inc/FCntContentSearch.h +++ b/inc/FCntContentSearch.h @@ -44,7 +44,7 @@ class _ContentSearchImpl; * @since 2.0 * * The %ContentSearch class provides methods to search content based on conditions and to retrieve the results for a specific - * column. It enables searching for content stored on the Tizen device. The local content is stored in the form of database columns. + * column. It enables searching for content stored on the %Tizen device. The local content is stored in the form of database columns. * * For more information on the database columns and their corresponding content types, see Content Search on the Device. * @@ -94,12 +94,10 @@ class _OSP_EXPORT_ ContentSearch public: /** - * The object is not fully constructed after this constructor is called. For full construction, the Construct() method must be called right after calling this constructor. + * The object is not fully constructed after this constructor is called. @n + * For full construction, the Construct() method must be called right after calling this constructor. * * @since 2.0 - * - * @remarks After creating an instance of this class, one of the Construct() methods must be called explicitly to initialize this instance. - * @see Construct() */ ContentSearch(void); @@ -122,7 +120,7 @@ public: * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_SYSTEM A system error has occurred. * - * @remarks To search a specific type, use the content type as CONTENT_TYPE_OTHER, CONTENT_TYPE_IMAGE, CONTENT_TYPE_AUDIO, or CONTENT_TYPE_VIDEO. + * @remarks To search a specific type, use the content type as @c CONTENT_TYPE_OTHER, @c CONTENT_TYPE_IMAGE, @c CONTENT_TYPE_AUDIO, or @c CONTENT_TYPE_VIDEO. * * The following example demonstrates how to use the %Construct() method. * @@ -167,15 +165,15 @@ public: * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_INVALID_ARG Either of the following conditions has occurred: @n * - The specified @c column is either invalid or empty. @n - * - The content is searched with @c type set as CONTENT_TYPE_UNKNOWN. @n + * - The content is searched with @c type set as ::CONTENT_TYPE_UNKNOWN. @n * - The length of the specified @c whereExpr parameter exceeds 512 characters. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. * @exception E_SYSTEM A system error has occurred. * @remarks * - The specific error code can be accessed using the GetLastResult() method. * - The return value must be deleted. - * - ContentType supports CONTENT_TYPE_OTHER, CONTENT_TYPE_IMAGE, CONTENT_TYPE_AUDIO, and CONTENT_TYPE_VIDEO. - * If %ContentType in Construct() uses CONTENT_TYPE_UNKNOWN or an invalid value, E_INVALID_ARG occurs. + * - ContentType supports ::CONTENT_TYPE_OTHER, ::CONTENT_TYPE_IMAGE, ::CONTENT_TYPE_AUDIO, and ::CONTENT_TYPE_VIDEO. @n + * If %ContentType in Construct() uses ::CONTENT_TYPE_UNKNOWN or an invalid value, @c E_INVALID_ARG occurs. * * The following example demonstrates how to use the %SearchN() method. * @@ -233,15 +231,15 @@ public: * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_INVALID_ARG The specified @c column is either invalid or empty, or - * the content is searched with @c type set as CONTENT_TYPE_UNKNOWN. + * the content is searched with @c type set as ::CONTENT_TYPE_UNKNOWN. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. * @exception E_SYSTEM A system error has occurred. * @remarks * - The specific error code can be accessed using the GetLastResult() method. * - The return value must be deleted. @n * The result of GetValueListN() returns a distinct value. - * - ContentType supports CONTENT_TYPE_OTHER, CONTENT_TYPE_IMAGE, CONTENT_TYPE_AUDIO, and CONTENT_TYPE_VIDEO. - * If %ContentType in Construct() uses CONTENT_TYPE_UNKNOWN or an invalid value, E_INVALID_ARG occurs. + * - ContentType supports ::CONTENT_TYPE_OTHER, ::CONTENT_TYPE_IMAGE, ::CONTENT_TYPE_AUDIO, and ::CONTENT_TYPE_VIDEO. @n + * If %ContentType in Construct() uses ::CONTENT_TYPE_UNKNOWN or an invalid value, @c E_INVALID_ARG occurs. * * The following example demonstrates how to use the %GetValueListN() method. * @@ -303,8 +301,8 @@ public: * - The specific error code can be accessed using the GetLastResult() method. * - The return value must be deleted. @n * The result of GetValueListN() returns a distinct value. - * - ContentType supports CONTENT_TYPE_OTHER, CONTENT_TYPE_IMAGE, CONTENT_TYPE_AUDIO, and CONTENT_TYPE_VIDEO. - * If %ContentType in Construct() uses CONTENT_TYPE_UNKNOWN or an invalid value, E_INVALID_ARG occurs. + * - ContentType supports ::CONTENT_TYPE_OTHER, ::CONTENT_TYPE_IMAGE, ::CONTENT_TYPE_AUDIO, and ::CONTENT_TYPE_VIDEO. @n + * If %ContentType in Construct() uses ::CONTENT_TYPE_UNKNOWN or an invalid value, @c E_INVALID_ARG occurs. * * The following example demonstrates how to use the %GetValueListN() method. * diff --git a/inc/FCntContentTransfer.h b/inc/FCntContentTransfer.h index 04f7dd2..00cde39 100644 --- a/inc/FCntContentTransfer.h +++ b/inc/FCntContentTransfer.h @@ -119,7 +119,8 @@ class _OSP_EXPORT_ ContentTransfer { public: /** - * The object is not fully constructed after this constructor is called. For full construction, the Construct(IContentTransferListener&) method must be called right after calling this constructor. + * The object is not fully constructed after this constructor is called. @n + * For full construction, the Construct(IContentTransferListener&) method must be called right after calling this constructor. * * @brief [Deprecated] * @deprecated This class is deprecated. Instead of using this class, use DownloadManager class. @@ -141,7 +142,7 @@ public: /** * Initializes this instance of %ContentTransfer with the specified parameter. @n - * This method should be called after every instance of %ContentTransfer is constructed. + * The %Construct() method should be called after every instance of %ContentTransfer is constructed. * * @brief [Deprecated] * @deprecated This class is deprecated. Instead of using this class, use DownloadManager class. @@ -157,7 +158,7 @@ public: /** * Downloads a content file from the content provider's server. @n - * The @c filesize parameter is used to check the limitation of the local volume. If this parameter is set to @c 0, this method will not check the volume. @n + * The @c filesize parameter is used to check the limitation of the local volume. If this parameter is set to @c 0, the %Download() method will not check the volume. @n * An application should set the full destination path for the downloaded contents. When the content is downloaded to one of the following paths, this method internally registers the content using ContentManager. * - /Media/ * - /Storagecard/Media/ @n @@ -202,7 +203,7 @@ public: * An application should set the destination path for the downloaded contents. * The path of the downloaded file should use Tizen::System::Environment::GetMediaPath() or Tizen::System::Environment::GetExternalStoragePath(). * - * When the content is downloaded to the path using Tizen::System::Environment::GetMediaPath() or Tizen::System::Environment::GetExternalStoragePath(), this method internally registers the content in the content database. @n + * When the content is downloaded to the path using Tizen::System::Environment::GetMediaPath() or Tizen::System::Environment::GetExternalStoragePath(), the %Download() method internally registers the content in the content database. @n * When the download is completed, the application is notified using the IContentTransferListener::OnContentDownloadCompleted() method. @n * When the data is being downloaded, the application is notified of the progress using the IContentTransferListener::OnContentTransferInProgress() method. * @@ -268,7 +269,7 @@ public: /** * Downloads a content file to a buffer from the content provider's servers. @n - * This method does not register the content. @n + * The %DownloadToBuffer() method does not register the content. @n * When the download is completed, the application is notified using the IContentTransferListener::OnContentDownloadToBufferCompleted() method. @n * When the data is being downloaded, the application is notified of the progress using the IContentTransferListener::OnContentTransferInProgress() method. * @@ -299,7 +300,7 @@ public: /** * Downloads a content file to a buffer from the content provider's servers. @n - * This method does not register the content. @n + * The %DownloadToBuffer() method does not register the content. @n * When the download is completed, the application is notified using the IContentTransferListener::OnContentDownloadToBufferCompleted() method. @n * When the data is being downloaded, the application is notified of the progress using the IContentTransferListener::OnContentTransferInProgress() method. * diff --git a/inc/FCntDownloadManager.h b/inc/FCntDownloadManager.h index 329e8cf..88246bc 100644 --- a/inc/FCntDownloadManager.h +++ b/inc/FCntDownloadManager.h @@ -198,8 +198,9 @@ public: * @param[in] reqId The request ID returned by Start() * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG There is no download request for the specified @c reqId. - * @remarks The specific error code can be accessed using the GetLastResult() method. - * @remarks The download request information will be available at least 24 hours after IDownloadListener::OnDownloadCompleted() is called. + * @remarks + * - The specific error code can be accessed using the GetLastResult() method. + * - The download request information will be available at least 24 hours after IDownloadListener::OnDownloadCompleted() is called. */ DownloadRequest* GetDownloadRequestN(RequestId reqId) const; diff --git a/inc/FCntIContentScanListener.h b/inc/FCntIContentScanListener.h index 0c0f020..0758c31 100644 --- a/inc/FCntIContentScanListener.h +++ b/inc/FCntIContentScanListener.h @@ -55,8 +55,8 @@ public: * @since 2.1 * * @param[in] reqId The request ID returned by ContentManager::ScanDirectory() - * @param[in] scanPath The scan path. - * @param[in] r The error of scan operation. + * @param[in] scanPath The scan path + * @param[in] r The error of scan operation @n * The following exceptions are given through this parameter. * @exception E_SUCCESS The method is successful * @exception E_SERVICE_BUSY The database is busy. diff --git a/inc/FCntIContentTransferListener.h b/inc/FCntIContentTransferListener.h index 53c614b..bc90894 100644 --- a/inc/FCntIContentTransferListener.h +++ b/inc/FCntIContentTransferListener.h @@ -50,7 +50,8 @@ class _OSP_EXPORT_ IContentTransferListener { public: /** - * This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes are called when the destructor of this interface is called. + * This polymorphic destructor should be overridden if required. @n + * This way, the destructors of the derived classes are called when the destructor of this interface is called. * * @brief [Deprecated] * @deprecated This class is deprecated. Instead of using this class, use DownloadManager class. diff --git a/inc/FCntIContentUpdateEventListener.h b/inc/FCntIContentUpdateEventListener.h index 483173d..c6e4a67 100644 --- a/inc/FCntIContentUpdateEventListener.h +++ b/inc/FCntIContentUpdateEventListener.h @@ -56,9 +56,9 @@ public: * * @param[in] contentId The content ID * @param[in] contentType The content type - * @param[in] r An error code - * The following exception is given through this parameter. - * @exception E_SUCCESS The method is successful + * @param[in] r An error code @n + * The following exceptions are given through this parameter. + * @exception E_SUCCESS The method is successful. * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ virtual void OnContentFileCreated(ContentId contentId, ContentType contentType, result r) = 0; @@ -70,23 +70,23 @@ public: * * @param[in] contentId The content ID * @param[in] contentType The content type - * @param[in] r An error code - * The following exception is given through this parameter. - * @exception E_SUCCESS The method is successful + * @param[in] r An error code @n + * The following exceptions are given through this parameter. + * @exception E_SUCCESS The method is successful. * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ virtual void OnContentFileUpdated(ContentId contentId, ContentType contentType, result r) = 0; /** - * Called when the content is deleted.. + * Called when the content is deleted. * * @since 2.1 * * @param[in] contentId The content ID * @param[in] contentType The content type - * @param[in] r An error code - * The following exception is given through this parameter. - * @exception E_SUCCESS The method is successful + * @param[in] r An error code @n + * The following exceptions are given through this parameter. + * @exception E_SUCCESS The method is successful. * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ virtual void OnContentFileDeleted(ContentId contentId, ContentType contentType, result r) = 0; @@ -97,9 +97,9 @@ public: * @since 2.1 * * @param[in] directoryPath The directory path - * @param[in] r An error code - * The following exception is given through this parameter. - * @exception E_SUCCESS The method is successful + * @param[in] r An error code @n + * The following exceptions are given through this parameter. + * @exception E_SUCCESS The method is successful. * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ virtual void OnContentDirectoryScanCompleted(const Tizen::Base::String& directoryPath, result r) = 0; diff --git a/inc/FCntImageContentInfo.h b/inc/FCntImageContentInfo.h index b305877..2dcc332 100644 --- a/inc/FCntImageContentInfo.h +++ b/inc/FCntImageContentInfo.h @@ -76,11 +76,10 @@ class _OSP_EXPORT_ ImageContentInfo { public: /** - * The object is not fully constructed after this constructor is called. For full construction, the Construct() method must be called right after calling this constructor. + * The object is not fully constructed after this constructor is called. @n + * For full construction, the Construct() method must be called right after calling this constructor. * * @since 2.0 - * - * @remarks After creating an instance of this class, the Construct() method must be called explicitly to initialize this instance. */ ImageContentInfo(void); @@ -113,7 +112,7 @@ public: * @exception E_SYSTEM An internal error has occurred. * @remarks * - The @c pContentPath should start with directory path returned by either Tizen::System::Environment::GetMediaPath() or Tizen::System::Environment::GetExternalStoragePath(). @n - * If @c pContentPath is @c null, use ContentManager::CreateContent(const Tizen::Base::ByteBuffer&, const Tizen::Base::String&, const ContentInfo*) + * If @c pContentPath is @c null, use ContentManager::CreateContent(const Tizen::Base::ByteBuffer&, const Tizen::Base::String&, const ContentInfo*) @n * or ContentManager::CreateContent(const Tizen::Base::String&, const Tizen::Base::String&, bool, const ContentInfo*). * - If the content has coordinates as metadata, they are automatically set. */ diff --git a/inc/FCntOtherContentInfo.h b/inc/FCntOtherContentInfo.h index ce63f12..b267331 100644 --- a/inc/FCntOtherContentInfo.h +++ b/inc/FCntOtherContentInfo.h @@ -77,11 +77,10 @@ class _OSP_EXPORT_ OtherContentInfo { public: /** - * The object is not fully constructed after this constructor is called. For full construction, the Construct() method must be called right after calling this constructor. + * The object is not fully constructed after this constructor is called. @n + * For full construction, the Construct() method must be called right after calling this constructor. * * @since 2.0 - * - * @remarks After creating an instance of this class, the Construct() method must be called explicitly to initialize this instance. */ OtherContentInfo(void); @@ -113,7 +112,7 @@ public: * @exception E_IO An I/O error has occurred. * @exception E_SYSTEM An internal error has occurred. * @remarks The @c pContentPath should start with directory path returned by either Tizen::System::Environment::GetMediaPath() or Tizen::System::Environment::GetExternalStoragePath(). @n - * If @c pContentPath is @c null, use ContentManager::CreateContent(const Tizen::Base::ByteBuffer&, const Tizen::Base::String&, const ContentInfo*) + * If @c pContentPath is @c null, use ContentManager::CreateContent(const Tizen::Base::ByteBuffer&, const Tizen::Base::String&, const ContentInfo*) @n * or ContentManager::CreateContent(const Tizen::Base::String&, const Tizen::Base::String&, bool, const ContentInfo*). */ result Construct(const Tizen::Base::String* pContentPath); diff --git a/inc/FCntTypes.h b/inc/FCntTypes.h index f6ca091..e8e3d72 100644 --- a/inc/FCntTypes.h +++ b/inc/FCntTypes.h @@ -16,9 +16,9 @@ // /** * @file FCntTypes.h - * @brief This is the header file for the definitions of constants and enumerators in the Tizen::Content namespace. + * @brief This is the header file for the definitions of constants and enumerators in the Content namespace. * - * This header file contains definitions for the constants and enumerators in the Tizen::Content namespace. + * This header file contains definitions for the constants and enumerators in the Content namespace. */ #ifndef _FCNT_TYPES_H_ @@ -57,14 +57,14 @@ enum ContentType CONTENT_TYPE_IMAGE, /**< An Image */ CONTENT_TYPE_AUDIO, /**< An Audio */ CONTENT_TYPE_VIDEO, /**< A Video */ - CONTENT_TYPE_ALL, /**< @if OSPDEPREC The content type: all types @endif */ /**< @if OSPDEPREC @deprecated This enumeration field is deprecated as unified search will not be supported. @endif */ + CONTENT_TYPE_ALL, /**< @if OSPDEPREC The content type: all types @endif */ /**< @if OSPDEPREC @deprecated This enum field is deprecated as unified search will not be supported. @endif */ CONTENT_TYPE_UNKNOWN /**< An Unknown type */ }; /** * @enum ImageOrientationType * - * Defines the orientation type of an image + * Defines the orientation type of an image. * * @since 2.0 */ @@ -108,7 +108,7 @@ enum DownloadState DOWNLOAD_STATE_PAUSED, /**< The download request is in a paused state by user request */ DOWNLOAD_STATE_CANCELLED, /**< The download request is cancelled by user request */ DOWNLOAD_STATE_COMPLETED, /**< The download request is in a completed state */ - DOWNLOAD_STATE_FAILED /**< The download request failed */ + DOWNLOAD_STATE_FAILED /**< The download request has failed */ }; _OSP_EXPORT_ extern const wchar_t OSP_HOME[]; diff --git a/inc/FCntVideoContentInfo.h b/inc/FCntVideoContentInfo.h index d89d081..b53f270 100644 --- a/inc/FCntVideoContentInfo.h +++ b/inc/FCntVideoContentInfo.h @@ -76,11 +76,10 @@ class _OSP_EXPORT_ VideoContentInfo { public: /** - * The object is not fully constructed after this constructor is called. For full construction, the Construct() method must be called right after calling this constructor. + * The object is not fully constructed after this constructor is called. @n + * For full construction, the Construct() method must be called right after calling this constructor. * * @since 2.0 - * - * @remarks After creating an instance of this class, the Construct() method must be called explicitly to initialize this instance. */ VideoContentInfo(void); @@ -112,7 +111,7 @@ public: * @exception E_IO An I/O error has occurred. * @exception E_SYSTEM An internal error has occurred. * @remarks The @c pContentPath should start with directory path returned by either Tizen::System::Environment::GetMediaPath() or Tizen::System::Environment::GetExternalStoragePath(). @n - * If @c pContentPath is @c null, use ContentManager::CreateContent(const Tizen::Base::ByteBuffer&, const Tizen::Base::String&, const ContentInfo*) + * If @c pContentPath is @c null, use ContentManager::CreateContent(const Tizen::Base::ByteBuffer&, const Tizen::Base::String&, const ContentInfo*) @n * or ContentManager::CreateContent(const Tizen::Base::String&, const Tizen::Base::String&, bool, const ContentInfo*). */ result Construct(const Tizen::Base::String* pContentPath); diff --git a/inc/FContent.h b/inc/FContent.h index 679ba5b..f1131f7 100644 --- a/inc/FContent.h +++ b/inc/FContent.h @@ -16,9 +16,9 @@ // /** * @file FContent.h - * @brief This is the header file for the %Tizen::Content namespace. + * @brief This is the header file for the %Content namespace. * - * This header file contains the declarations and descriptions of the %Tizen::Content namespace. + * This header file contains the declarations and descriptions of the %Content namespace. */ #ifndef _FCNT_H_ -- 2.7.4