From a546b79c0d78dbb308d0ef31935e4b08e90af8ed Mon Sep 17 00:00:00 2001 From: Minkyoung Kang Date: Mon, 22 Apr 2013 12:05:51 +0900 Subject: [PATCH] update header files for Doxygen Change-Id: Ia35129593504ce42929c78551867aba1d5e1d3d9 --- inc/FShellAppWidgetPopup.h | 4 ++-- inc/FShellAppWidgetProviderInfo.h | 5 +++-- inc/FShellAppWidgetProviderManager.h | 5 +++-- inc/FShellIAppWidgetRequestListener.h | 2 +- inc/FShellIShortcutRequestListener.h | 4 ++-- inc/FShellNotificationManager.h | 6 +++--- inc/FShellNotificationRequest.h | 4 ++-- inc/FShellShortcutManager.h | 7 +++---- 8 files changed, 19 insertions(+), 18 deletions(-) diff --git a/inc/FShellAppWidgetPopup.h b/inc/FShellAppWidgetPopup.h index 4ea644e..14b3919 100644 --- a/inc/FShellAppWidgetPopup.h +++ b/inc/FShellAppWidgetPopup.h @@ -70,7 +70,7 @@ public: * For more information, see Application Filtering. * @remarks Before calling this method, check whether the feature is supported by * Tizen::System::SystemInfo::GetValue(const Tizen::Base::String&, bool&). - * @see AppWidgetProvider::OnAppWidgetPopupProviderInitializing() + * @see AppWidgetPopupProvider::OnAppWidgetPopupProviderInitializing() */ result Construct(const Tizen::Graphics::FloatDimension& size); @@ -88,7 +88,7 @@ public: * For more information, see Application Filtering. * @remarks Before calling this method, check whether the feature is supported by * Tizen::System::SystemInfo::GetValue(const Tizen::Base::String&, bool&). - * @see AppWidgetProvider::OnAppWidgetPopupProviderInitializing() + * @see AppWidgetPopupProvider::OnAppWidgetPopupProviderInitializing() */ result Construct(const Tizen::Ui::Layout& layout, const Tizen::Graphics::FloatDimension& size); diff --git a/inc/FShellAppWidgetProviderInfo.h b/inc/FShellAppWidgetProviderInfo.h index 6c87466..90756c2 100644 --- a/inc/FShellAppWidgetProviderInfo.h +++ b/inc/FShellAppWidgetProviderInfo.h @@ -142,8 +142,9 @@ public: * @return @c true if the AppWidget is default, @n * else @c false * - * @remarks Default AppWidget provider providing AppWidget that represents application. @n - * Home application can show AppWidget instead of icon and text for applications that includes default AppWidget provider. + * @remarks + * - Default AppWidget provider providing AppWidget that represents application. + * - Home application can show AppWidget instead of icon and text for applications that includes default AppWidget provider. */ bool IsDefault(void) const; diff --git a/inc/FShellAppWidgetProviderManager.h b/inc/FShellAppWidgetProviderManager.h index 3d17550..24e86d2 100755 --- a/inc/FShellAppWidgetProviderManager.h +++ b/inc/FShellAppWidgetProviderManager.h @@ -66,8 +66,9 @@ public: * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. * For more information, see Application Filtering. * - * @remarks - The specific error code can be accessed using the GetLastResult() method. - * - Before calling this method, check whether the feature is supported by + * @remarks + * - The specific error code can be accessed using the GetLastResult() method. + * - Before calling this method, check whether the feature is supported by * Tizen::System::SystemInfo::GetValue(const Tizen::Base::String&, bool&). */ static AppWidgetProviderManager* GetInstance(void); diff --git a/inc/FShellIAppWidgetRequestListener.h b/inc/FShellIAppWidgetRequestListener.h index eac94d0..f234c76 100644 --- a/inc/FShellIAppWidgetRequestListener.h +++ b/inc/FShellIAppWidgetRequestListener.h @@ -63,7 +63,7 @@ public: * @param[in] text Alternative text for the AppWidget * @param[in] userInfo User information for the AppWidget provider * @remarks This method is invoked only in the main thread. - * @see AppWidgetManager::AddAppWidget() + * @see AppWidgetProviderManager::AddAppWidget() */ virtual void OnAppWidgetAddRequested(const Tizen::App::AppId& appId, const Tizen::Base::String& providerName, const Tizen::Base::String& text, const Tizen::Base::String& userInfo) = 0; diff --git a/inc/FShellIShortcutRequestListener.h b/inc/FShellIShortcutRequestListener.h index 7746fe6..8e630e5 100644 --- a/inc/FShellIShortcutRequestListener.h +++ b/inc/FShellIShortcutRequestListener.h @@ -85,8 +85,8 @@ public: * @param[in] iconFilePath The icon file path * @param[in] uriData Uri that will be delivered by IAppControlProviderEventListener::OnAppControlRequestReceived(), when the application is started using a shortcut. * - * @remarks If @c uriData is specified, application should be started by AppControl with http://tizen.org/appcontrol/operation/view operation, when it is launched from the Home application using a shortcut. - * Or else application should be started by AppControl with default operation (http://tizen.org/appcontrol/operation/main). + * @remarks If @c uriData is specified, application should be started by AppControl with %http://tizen.org/appcontrol/operation/view operation, when it is launched from the Home application using a shortcut. + * Or else application should be started by AppControl with default operation (%http://tizen.org/appcontrol/operation/main). * For more information on the AppControl class, see Application Controls, and Delivering Launch Arguments. * @see ShortcutManager::AddShortcut() */ diff --git a/inc/FShellNotificationManager.h b/inc/FShellNotificationManager.h index 3bc288b..6573d08 100644 --- a/inc/FShellNotificationManager.h +++ b/inc/FShellNotificationManager.h @@ -231,7 +231,7 @@ public: * Notifies the user who has @c badgeNumber as badge number with a message. @n * If the user selects this message, @c launchArguments is delivered to the application. @n * @c launchArguments is delivered as the value of the http://tizen.org/appcontrol/data/notification key - * for IAppControlProviderEventListener::OnAppControlRequestReceived(). + * for Tizen::App::IAppControlProviderEventListener::OnAppControlRequestReceived(). * * @since 2.0 * @privlevel public @@ -343,8 +343,8 @@ public: /** * Notifies the user about the ongoing activity using a message. @n * If the user selects the message, @c launchArguments is delivered to the application. @n - * @c launchArguments is delivered as the value of the http://tizen.org/appcontrol/data/notification key - * for IAppControlProviderEventListener::OnAppControlRequestReceived(). + * @c launchArguments is delivered as the value of the %http://tizen.org/appcontrol/data/notification key + * for Tizen::App::IAppControlProviderEventListener::OnAppControlRequestReceived(). * * @since 2.0 * @privlevel public diff --git a/inc/FShellNotificationRequest.h b/inc/FShellNotificationRequest.h index 76633d4..31a45df 100644 --- a/inc/FShellNotificationRequest.h +++ b/inc/FShellNotificationRequest.h @@ -205,8 +205,8 @@ public: /** * Sets the application message of a notification message. @n - * @c appMessage is delivered as the value of the http://tizen.org/appcontrol/data/notification key - * for IAppControlProviderEventListener::OnAppControlRequestReceived(). + * @c appMessage is delivered as the value of the %http://tizen.org/appcontrol/data/notification key + * for Tizen::App::IAppControlProviderEventListener::OnAppControlRequestReceived(). * * @since 2.0 * diff --git a/inc/FShellShortcutManager.h b/inc/FShellShortcutManager.h index 3359899..a757c3f 100644 --- a/inc/FShellShortcutManager.h +++ b/inc/FShellShortcutManager.h @@ -69,13 +69,13 @@ public: * * @since 2.1 * @privlevel public - * @privilege http::tizen.org/privilege/shortcut.install + * @privilege %http::tizen.org/privilege/shortcut.install * * @return An error code * @param[in] appId The application ID * @param[in] displayName The display name of shortcut * @param[in] iconPath The icon file path - * @param[in] uriData Uri that will be delivered by IAppControlProviderEventListener::OnAppControlRequestReceived(), when the application is started using a shortcut. + * @param[in] uriData Uri that will be delivered by Tizen::App::IAppControlProviderEventListener::OnAppControlRequestReceived(), when the application is started using a shortcut. * @param[in] allowDuplication Flag to allow duplicate shortcut * * @exception E_SUCCESS The method is successful. @@ -87,11 +87,10 @@ public: * - Icon file should be placed in sub directory of 'shared/res' to be used by the Home app. * For more information on shared directory, see I/O Overview * and see General Information for icon file. - * * - If @c uriData is specified, application will be started by AppControl with %http://tizen.org/appcontrol/operation/view operation, when it is launched from the Home app using a shortcut. * Or else application will be started by AppControl with default operation(%http://tizen.org/appcontrol/operation/main). * - * @see IAppControlEventListener::OnAppControlRequestReceived() + * @see Tizen::App::IAppControlEventListener::OnAppControlRequestReceived() * @see IShortcutRequestListener::OnShortcutAddRequested() * * The following example demonstrates how to add shortcut. -- 2.7.4