From 686adc8207227dc2b209241fdc026b7c5fdf4f2d Mon Sep 17 00:00:00 2001 From: "kyeongwoo.lee" Date: Fri, 28 Jun 2013 16:12:15 +0900 Subject: [PATCH] update doxygen Change-Id: Id0931374fb0acf87c275a175d13fbc8051caf268 --- inc/FShellNotificationRequest.h | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/inc/FShellNotificationRequest.h b/inc/FShellNotificationRequest.h index aebf537..6b948af 100644 --- a/inc/FShellNotificationRequest.h +++ b/inc/FShellNotificationRequest.h @@ -264,6 +264,7 @@ public: * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified path is invalid. * @remarks If @c iconPath is not set, the application icon is displayed. + * The @c iconPath should start with the directory path returned by Tizen::App::App::GetAppSharedPath(). */ result SetIconFilePath(const Tizen::Base::String& iconPath); @@ -288,6 +289,7 @@ public: * @remarks * - If the format of the sound file is not valid, then the sound file is not played properly when the notification message is displayed. * - If @c soundPath is not set, the default sound is played when the %NotificationRequest instance is delivered to the NotificationManager::Notify() method. + * - The @c soundPath should start with the directory path returned by Tizen::App::App::GetAppSharedPath(). */ result SetSoundFilePath(const Tizen::Base::String& soundPath); @@ -405,7 +407,8 @@ public: * @param[in] pThumbnailPathList A list of the thumbnail image file path * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified path is invalid. - * @remarks This information is only meaningful when the notification style is Shell::NOTIFICATION_STYLE_THUMBNAIL. + * @remarks This information is only meaningful when the notification style is Shell::NOTIFICATION_STYLE_THUMBNAIL. + * The path of thumbnail image should start with the directory path returned by Tizen::App::App::GetAppSharedPath(). */ result SetMessageThumbnailFilePathList(const Tizen::Base::Collection::IList* pThumbnailPathList); @@ -449,6 +452,7 @@ public: * @param[in] imagePath The file path of the background image * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified path is invalid. + * @remarks The @c imagePath should start with the directory path returned by Tizen::App::App::GetAppSharedPath(). */ result SetBackgroundImageFilePath(const Tizen::Base::String& imagePath); -- 2.7.4