From 0d1f758512072ece988b2786ce8ecbe83b8ae2b9 Mon Sep 17 00:00:00 2001 From: Seokpil Park Date: Thu, 28 Mar 2013 13:25:37 +0900 Subject: [PATCH] [content] Change remarks description Change-Id: I53bfe67bfd93ef0d4051fdd1641d94efa947a307 Signed-off-by: Seokpil Park --- inc/FCntAudioMetadata.h | 12 +++++++----- inc/FCntContentManager.h | 19 +++++++++++-------- inc/FCntContentManagerUtil.h | 39 +++++++++++++++++++++++---------------- inc/FCntContentSearch.h | 31 +++++++++++++++++-------------- inc/FCntContentTransfer.h | 10 ++++++---- inc/FCntImageContentInfo.h | 16 +++++++++------- inc/FCntOtherContentInfo.h | 7 ++++--- inc/FCntVideoContentInfo.h | 7 ++++--- 8 files changed, 81 insertions(+), 60 deletions(-) diff --git a/inc/FCntAudioMetadata.h b/inc/FCntAudioMetadata.h index a2be24e..294f9fb 100644 --- a/inc/FCntAudioMetadata.h +++ b/inc/FCntAudioMetadata.h @@ -290,8 +290,9 @@ public: * @exception E_SUCCESS The method is successful. * @exception E_DATA_NOT_FOUND The thumbnail image does not exist. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @remarks This method returns the thumbnail image that is resized to 80x60 pixels. @n - * The specific error code can be accessed using the GetLastResult() method. + * @remarks + * - This method returns the thumbnail image that is resized to 80x60 pixels. + * - The specific error code can be accessed using the GetLastResult() method. */ Tizen::Graphics::Bitmap* GetThumbnailN(void) const; @@ -304,9 +305,10 @@ public: * @exception E_SUCCESS The method is successful. * @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. @n - * The specific error code can be accessed using the GetLastResult() method. + * @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. + * - The specific error code can be accessed using the GetLastResult() method. */ Tizen::Graphics::Bitmap* GetAlbumArtN(void) const; diff --git a/inc/FCntContentManager.h b/inc/FCntContentManager.h index 7d2246a..275b14f 100644 --- a/inc/FCntContentManager.h +++ b/inc/FCntContentManager.h @@ -177,9 +177,10 @@ public: * @exception E_SYSTEM A system error has occurred. * @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(), - * the file can be created as a content only using the OtherContentInfo class. @n - * The specific error code can be accessed using the GetLastResult() method. + * @remarks + * - If the 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. */ ContentId CreateContent(const ContentInfo& contentInfo); @@ -215,8 +216,9 @@ public: * @exception E_SYSTEM A system error has occurred. * @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 destination path should start with the directory path returned by either Tizen::System::Environment::GetMediaPath() or Tizen::System::Environment::GetExternalStoragePath(). @n - * The specific error code can be accessed using the GetLastResult() method. + * @remarks + * - 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::ByteBuffer& byteBuffer, const Tizen::Base::String& destinationPath, const ContentInfo* pContentInfo = null); @@ -256,9 +258,10 @@ public: * @exception E_SYSTEM A system error has occurred. * @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(). @n - * The specific error code can be accessed using the GetLastResult() method. + * @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 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); diff --git a/inc/FCntContentManagerUtil.h b/inc/FCntContentManagerUtil.h index 9ad61ea..4c42a6a 100644 --- a/inc/FCntContentManagerUtil.h +++ b/inc/FCntContentManagerUtil.h @@ -102,8 +102,9 @@ 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); @@ -117,8 +118,9 @@ 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); @@ -139,8 +141,9 @@ 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); @@ -154,8 +157,9 @@ 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); @@ -176,8 +180,9 @@ 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); @@ -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); diff --git a/inc/FCntContentSearch.h b/inc/FCntContentSearch.h index cf831da..f7601fb 100644 --- a/inc/FCntContentSearch.h +++ b/inc/FCntContentSearch.h @@ -171,10 +171,11 @@ public: * - 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. - * @remarks The return value must be deleted. @n - * 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. + * @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. * * The following example demonstrates how to use the %SearchN() method. * @@ -235,11 +236,12 @@ public: * 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. - * @remarks The return value must be deleted. @n - * The result of GetValueListN() returns a distinct value. @n - * 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. + * @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. * * The following example demonstrates how to use the %GetValueListN() method. * @@ -297,11 +299,12 @@ public: * @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. * @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. - * @remarks The return value must be deleted. @n - * The result of GetValueListN() returns a distinct value. @n - * 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. + * @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. * * The following example demonstrates how to use the %GetValueListN() method. * diff --git a/inc/FCntContentTransfer.h b/inc/FCntContentTransfer.h index 2596c64..b63a585 100644 --- a/inc/FCntContentTransfer.h +++ b/inc/FCntContentTransfer.h @@ -237,8 +237,9 @@ public: * @exception E_IN_PROGRESS A previous request is in progress. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_SYSTEM A system error has occurred. - * @remarks The @c progressInterval is the interval of the progress for each download request. If the value of the @c progressInterval is @c 0, the @c progressInterval uses the value set by the ContentTransfer::SetProgressIntervalByPercent(int). The @c progressInterval is a percentage value between @c 0 and @c 100. - * The @c timeout is the value of the response timeout for each download request. If the value of the @c timeout is @c 0, the value for the @c timeout uses the value set by the ContentTransfer::SetDefaultTimeout(int). + * @remarks + * - The @c progressInterval is the interval of the progress for each download request. If the value of the @c progressInterval is @c 0, the @c progressInterval uses the value set by the ContentTransfer::SetProgressIntervalByPercent(int). The @c progressInterval is a percentage value between @c 0 and @c 100. + * - The @c timeout is the value of the response timeout for each download request. If the value of the @c timeout is @c 0, the value for the @c timeout uses the value set by the ContentTransfer::SetDefaultTimeout(int). * @see IContentTransferListener::OnContentDownloadCompleted() * @see IContentTransferListener::OnContentTransferInProgress() */ @@ -317,8 +318,9 @@ public: * @exception E_ILLEGAL_ACCESS Access is denied due to insufficient permission. * @exception E_IN_PROGRESS A previous request is in progress. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @remarks The @c progressInterval is the interval of the progress for each download request. If the value of the @c progressInterval is @c 0, the @c progressInterval uses the value set by the ContentTransfer::SetProgressIntervalByPercent(int). The @c progressInterval is a percentage value between @c 0 and @c 100. - * The @c timeout is the value of the response timeout for each download request. If the value of the @c timeout is @c 0, the value for the @c timeout uses the value set by the ContentTransfer::SetDefaultTimeout(int). + * @remarks + * - The @c progressInterval is the interval of the progress for each download request. If the value of the @c progressInterval is @c 0, the @c progressInterval uses the value set by the ContentTransfer::SetProgressIntervalByPercent(int). The @c progressInterval is a percentage value between @c 0 and @c 100. + * - The @c timeout is the value of the response timeout for each download request. If the value of the @c timeout is @c 0, the value for the @c timeout uses the value set by the ContentTransfer::SetDefaultTimeout(int). * @see IContentTransferListener::OnContentDownloadToBufferCompleted() * @see IContentTransferListener::OnContentTransferInProgress() */ diff --git a/inc/FCntImageContentInfo.h b/inc/FCntImageContentInfo.h index 87208ba..b305877 100644 --- a/inc/FCntImageContentInfo.h +++ b/inc/FCntImageContentInfo.h @@ -111,10 +111,11 @@ public: * @exception E_OUT_OF_MEMORY The memory is insufficient. * @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*) - * or ContentManager::CreateContent(const Tizen::Base::String&, const Tizen::Base::String&, bool, const ContentInfo*). @n - * If the content has coordinates as metadata, they are automatically set. + * @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*) + * 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. */ result Construct(const Tizen::Base::String* pContentPath); @@ -160,9 +161,10 @@ 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 - * The permitted format for a thumbnail image is Bitmap (bmp). + * @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 */ virtual result Construct(const Tizen::Base::String& contentPath, const Tizen::Base::String& thumbnailPath = L"", bool setGps = false); diff --git a/inc/FCntOtherContentInfo.h b/inc/FCntOtherContentInfo.h index 889c733..ce63f12 100644 --- a/inc/FCntOtherContentInfo.h +++ b/inc/FCntOtherContentInfo.h @@ -159,9 +159,10 @@ 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 - * The permitted format for a thumbnail image is bitmap (bmp). + * @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 */ virtual result Construct(const Tizen::Base::String& contentPath, const Tizen::Base::String& thumbnailPath = L"", bool setGps = false); diff --git a/inc/FCntVideoContentInfo.h b/inc/FCntVideoContentInfo.h index a46d251..d89d081 100644 --- a/inc/FCntVideoContentInfo.h +++ b/inc/FCntVideoContentInfo.h @@ -159,9 +159,10 @@ 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 - * The permitted format for a thumbnail image is bitmap (bmp). + * @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 */ virtual result Construct(const Tizen::Base::String& contentPath, const Tizen::Base::String& thumbnailPath = L"", bool setGps = false); -- 2.7.4