From 6f0f403d4ad0b96083850e13f179e85529b3ec87 Mon Sep 17 00:00:00 2001 From: "jungmin76.park" Date: Fri, 29 Mar 2013 13:49:24 +0900 Subject: [PATCH] apply translation check Change-Id: Ief2c05731a964123e6a63d5cf28e2bc07a8597a9 Signed-off-by: jungmin76.park --- inc/FShellAppWidgetManager.h | 29 ++++++++--------- inc/FShellAppWidgetProvider.h | 50 +++++++++++++++--------------- inc/FShellAppWidgetProviderInfo.h | 38 +++++++++++------------ inc/FShellAppWidgetProviderManager.h | 40 ++++++++++++------------ inc/FShellAppWidgetSizeInfo.h | 10 +++--- inc/FShellIAppWidgetPopupProviderFactory.h | 6 ++-- inc/FShellIAppWidgetProviderFactory.h | 8 ++--- inc/FShellIAppWidgetRequestListener.h | 12 ++++--- inc/FShellShortcutManager.h | 2 +- 9 files changed, 98 insertions(+), 97 deletions(-) diff --git a/inc/FShellAppWidgetManager.h b/inc/FShellAppWidgetManager.h index 82da6ca..c99241d 100644 --- a/inc/FShellAppWidgetManager.h +++ b/inc/FShellAppWidgetManager.h @@ -38,7 +38,7 @@ class IAppWidgetRequestListener; /** * @class AppWidgetManager - * @brief Manages static information of all the AppWidgets and provides APIs for AppWidget viewer(Such as the Home screen). + * @brief This class manages static information of all the AppWidgets and provides APIs for AppWidget viewer (such as the Home screen). * * @since 2.1 * @@ -62,11 +62,11 @@ public: static AppWidgetManager* GetInstance(void); /** - * Gets a list of installed AppWidgetProviderInfo + * Gets a list of installed AppWidgetProviderInfo. * * @since 2.1 * - * @return A pointer to the array list that contains all AppWidgetProviderInfo of installed AppWidgetProvider@n + * @return A pointer to the array list that contains all AppWidgetProviderInfo of installed AppWidgetProvider, @n * else @c null if an error occurs * * @exception E_SUCCESS The method is successful. @@ -80,11 +80,10 @@ public: * * @since 2.1 * - * @param[in] appId The Id of the application that provides AppWidget - * @param[in] providerName The name of the AppWidget provider - * @return A pointer to the AppWidgetProviderInfo of the specified AppWidgetProvider@n + * @return A pointer to the AppWidgetProviderInfo instance of the specified AppWidgetProvider, @n * else @c null if an error occurs - * + * @param[in] appId The ID of the application that provides AppWidget + * @param[in] providerName The name of the AppWidget provider * @exception E_SUCCESS The method is successful. * @exception E_APP_NOT_INSTALLED The application is not installed. * @exception E_OBJ_NOT_FOUND The specified AppWidget provider is not found. @@ -94,14 +93,13 @@ public: AppWidgetProviderInfo* GetAppWidgetProviderInfoN(const Tizen::App::AppId& appId, const Tizen::Base::String& providerName) const; /** - * Gets the AppWidgetProviderInfo of default AppWidget provider in the package. + * Gets the AppWidgetProviderInfo of the default AppWidget provider in the package. * * @since 2.1 * - * @param[in] packageId The Id of the packageId that contains AppWidget provider - * @return A pointer to the AppWidgetProviderInfo of the default AppWidgetProvider@n - * else @c null if there is no default AppWidget provider or an error occurs - * + * @return A pointer to the AppWidgetProviderInfo instance of the default AppWidgetProvider, @n + * else @c null if there is no default AppWidget provider or if an error occurs + * @param[in] packageId The ID of the package that contains the AppWidget provider * @exception E_SUCCESS The method is successful. * @exception E_APP_NOT_INSTALLED The application is not installed. * @exception E_SYSTEM The method cannot proceed due to a severe system error. @@ -111,8 +109,8 @@ public: /** * Sets a AppWidget request listener. @n - * The listener gets notified when the request is recieved. @n - * To unset the listener, pass a @c null value to the pListener parameter. + * The listener gets notified when the request is received. @n + * To unset the listener, pass a @c null value to the @c pListener parameter. * * @since 2.1 * @@ -120,9 +118,8 @@ public: * @param[in] pListener The pointer to the listener to receive request to add AppWidget * @exception E_SUCCESS The method is successful. * @exception E_SYSTEM The method cannot proceed due to a severe system error. - * + * @remarks Platform does not have the ownership of this pointer, so caller should manage the listener object properly. * @see IAppWidgetRequestListener - * @remarks Platform does not have the ownership of this pointer, So caller should manage the listener object properly. */ result SetAppWidgetRequestListener(IAppWidgetRequestListener* pListener); diff --git a/inc/FShellAppWidgetProvider.h b/inc/FShellAppWidgetProvider.h index cf567f3..a505edb 100644 --- a/inc/FShellAppWidgetProvider.h +++ b/inc/FShellAppWidgetProvider.h @@ -34,11 +34,11 @@ class AppWidgetFrame; /** * @class AppWidgetProvider - * @brief This class is the abstract base class of all AppWidget provider + * @brief This class is the abstract base class for all AppWidget providers. * * @since 2.1 * - * The %AppWidgetProvider class is a base class which represents a AppWidget provider + * The %AppWidgetProvider class is an abstract base class, which represents a AppWidget provider. */ class _OSP_EXPORT_ AppWidgetProvider : public Tizen::Base::Object @@ -60,21 +60,21 @@ protected: virtual ~AppWidgetProvider(void); /** - * Called when the AppWidget provider is required to be created @n + * Called when the AppWidget provider is created or initialized. * * @since 2.1 * * @param[in] width The width of the AppWidget * @param[in] height The height of the AppWidget - * @param[in] userInfo User information that specifed when the AppWidget is added + * @param[in] userInfo User information that is specified when the AppWidget is added * * @return @c true if the method is successful, @n * else @c false * - * @remarks AppWidgetFrame should be created and set here - * @see SetAppWidgetFrame + * @remarks AppWidgetFrame should be created and set here. + * @see SetAppWidgetFrame() * - * The following example demonstrates how to initialize the %AppWidgetProvider. + * The following example demonstrates how to initialize the %AppWidgetProvider instance. * * @code * #include @@ -100,70 +100,70 @@ protected: virtual bool OnAppWidgetProviderInitializing(float width, float height, const Tizen::Base::String& userInfo) = 0; /** - * Called when the AppWidget provider is required to be destroyed @n + * Called when the AppWidget provider is destroyed or terminated. * * @since 2.1 */ virtual void OnAppWidgetProviderTerminating(void) = 0; /** - * Called when the correspondent AppWidget is removed from AppWidget viewer application. (Home or Lock screen, etc)@n - * If you stored AppWidget provider state to persistent storage such as registry or DB, you can destroy by implementing this pure virtual function.@n + * Called when the correspondent AppWidget is removed from AppWidget viewer application. (Home or Lock screen, and so on). @n + * If AppWidget provider state is stored in a persistent storage such as registry or DB, it can be destroyed by implementing this pure virtual function. * * * @since 2.1 * - * @remarks This function is called after OnAppWidgetProviderTerminating called. + * @remarks This method is called after the OnAppWidgetProviderTerminating() method is called. */ virtual void OnAppWidgetProviderRemoved(void) = 0; /** - * Called when the AppWidget is required to be updated @n - * Your AppWidget provider can be updated by implementing this pure virtual function. + * Called when AppWidget is updated. @n + * AppWidget provider can be updated by implementing this pure virtual function. * * @since 2.1 * - * @param[in] userInfo User information to update the AppWidget provider@n - * This parameter is delivered from AppWidgetProvider::RequestUpdate() + * @param[in] userInfo User information to update the AppWidget provider @n + * This parameter is delivered from AppWidgetProvider::RequestUpdate(). * * @return @c true if the method is successful, @n * else @c false * - * @remarks This function is called when UpdatePeriod timer is expired or AppWidgetManager::RequestUpdate() is called.@n + * @remarks This method is called when UpdatePeriod timer is expired or AppWidgetManager::RequestUpdate() is called.@n */ virtual bool OnAppWidgetProviderUpdating(const Tizen::Base::String& userInfo) = 0; /** - * Sets the AppWidgetFrame to the AppWidgetProvider + * Sets the AppWidgetFrame instance to the AppWidgetProvider instance. * * @since 2.1 * * @return An error code - * @param[in] pAppWidgetFrame The AppWidgetFrame to be set to the AppWidgetProvider + * @param[in] pAppWidgetFrame The AppWidgetFrame instance to set as the AppWidgetProvider instance * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The pointer to the AppWidgetFrame is null, or not constructed yet. + * @exception E_INVALID_ARG The pointer to AppWidgetFrame is @c null, or not constructed as yet. * @exception E_SYSTEM The method cannot proceed due to a severe system error. * - * @remarks This function should be called only in OnAppWidgetProviderInitializing. - * @remarks AppWidgetFrame instance ownership is transferred to platform. After AppWidgetProvider::OnAppWidgetProviderTerminating() is called, AppWidgetPopup instance is removed automatically. AppWidgetFrame instance reuse is not allowed. + * @remarks This method should be called only within the OnAppWidgetProviderInitializing() method. + * @remarks The AppWidgetFrame instance ownership is transferred to the platform. After AppWidgetProvider::OnAppWidgetProviderTerminating() is called, the AppWidgetPopup instance is removed automatically. The %AppWidgetFrame instance reuse is not allowed. */ result SetAppWidgetFrame(AppWidgetFrame* pAppWidgetFrame); /** - * Get the AppWidgetFrame from the AppWidgetProvider + * Gets the AppWidgetFrame instance from the AppWidgetProvider instance. * * @since 2.1 * - * @return the AppWidgetFrame instnace, or null if any AppWidgetFrame isn't set yet. + * @return The AppWidgetFrame instance, or @c null if any %AppWidgetFrame is not set yet */ AppWidgetFrame* GetAppWidgetFrame(void); /** - * Get the AppWidgetFrame from the AppWidgetProvider + * Gets the AppWidgetFrame instance from the AppWidgetProvider instance. * * @since 2.1 * - * @return the AppWidgetFrame instnace, or null if any AppWidgetFrame isn't set yet. + * @return The AppWidgetFrame instance, or @c null if any %AppWidgetFrame is not set yet */ const AppWidgetFrame* GetAppWidgetFrame(void) const; diff --git a/inc/FShellAppWidgetProviderInfo.h b/inc/FShellAppWidgetProviderInfo.h index 3e3facf..f0e04d6 100644 --- a/inc/FShellAppWidgetProviderInfo.h +++ b/inc/FShellAppWidgetProviderInfo.h @@ -35,11 +35,11 @@ namespace Tizen { namespace Shell /** * @class AppWidgetProviderInfo - * @brief This class contains static AppWidget information + * @brief This class contains static AppWidget information. * * @since 2.1 * - * The %AppWidgetProviderInfo class contains static AppWidget information@n + * The %AppWidgetProviderInfo class contains static AppWidget information. */ class _OSP_EXPORT_ AppWidgetProviderInfo : public Tizen::Base::Object @@ -71,44 +71,44 @@ public: Tizen::App::AppId GetAppId(void) const; /** - * Gets the AppWidget provider name + * Gets the AppWidget provider name. * * @since 2.1 * - * @return The application ID + * @return The application name */ Tizen::Base::String GetName(void) const; /** - * Gets the display name of the Livbox @n - * If the system language setting is changed, this method returns the localized application name. - * The display name is displayed in applications that showing AppWidget like Launcher, and so on. + * Gets the display name of a AppWidget. @n + * If the system language setting is changed, the %GetDisplayName() method returns the localized application name. + * The display name is displayed in applications that showing AppWidget such as Launcher, and so on. * * @since 2.1 * - * @return The display name of the Livbox + * @return The display name of a AppWidget */ Tizen::Base::String GetDisplayName(void) const; /** - * Gets the icon path of the application. + * Gets the icon path of an application. * * @since 2.1 * - * @return The icon path of the application, @n + * @return The icon path of an application @n * An empty string is returned if there is no value. */ Tizen::Base::String GetIconPath(void) const; /** - * Gets the Id of the application that exports AppContorl to configure the AppWidget + * Gets the ID of the application that exports AppContorl to configure the AppWidget. * * @since 2.1 * - * @return The Id of the application that exports AppContorl to configure the AppWidget @n + * @return The ID of the application that exports AppContorl to configure the AppWidget @n * An empty string is returned if there is no value. * - * The following example demonstrates how to start the application control that is exported for AppWidget configuration + * The following example demonstrates how to start the application control that is exported for AppWidget configuration. * * @code * #include @@ -135,24 +135,24 @@ public: Tizen::Base::String GetConfigurationAppControlAppId(void) const; /** - * Checks whether the AppWidget provider is default or not. + * Checks whether the specified AppWidget provider is the default provider or not. * * @since 2.1 * - * @return @c true if the AppWidget is default @n + * @return @c true if the AppWidget is default, @n * else @c false * - * @remarks Default AppWidget provider providing AppWidget that represents application.@n + * @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. */ bool IsDefault(void) const; /** - * Gets a list of AppWidgetSizeInfo of the AppWidget + * Gets a list of AppWidgetSizeInfo of a AppWidget. * * @since 2.1 * - * @return A pointer to the array list that contains all AppWidgetSizeInfo of the AppWidgetProvider@n + * @return A pointer to the array list that contains all AppWidgetSizeInfo of the AppWidgetProvider instance, @n * else @c null if an error occurs * @exception E_SUCCESS The method is successful. * @exception E_SYSTEM The method cannot proceed due to a severe system error. @@ -168,7 +168,7 @@ private: // // @since 2.1 // - // @param[in] appId The Id of the application that provides AppWidget + // @param[in] appId The ID of the application that provides AppWidget // @param[in] name The name of the AppWidget provider // AppWidgetProviderInfo(const Tizen::App::AppId& appId, const Tizen::Base::String& name); diff --git a/inc/FShellAppWidgetProviderManager.h b/inc/FShellAppWidgetProviderManager.h index 0cd87d8..ff29d0d 100644 --- a/inc/FShellAppWidgetProviderManager.h +++ b/inc/FShellAppWidgetProviderManager.h @@ -38,14 +38,14 @@ class IAppWidgetPopupProviderFactory; /** * @class AppWidgetProviderManager - * @brief Manages all the AppWidget providers. + * @brief This class manages all the AppWidget providers. * * @since 2.1 * * @final This class is not intended for extension. * * The %AppWidgetProviderManager class manages all the AppWidget providers. - * The appwidget manager manages static and run time AppWidget information. + * The AppWidget manager manages static and run time AppWidget information. */ class _OSP_EXPORT_ AppWidgetProviderManager : public Tizen::Base::Object @@ -63,19 +63,19 @@ public: static AppWidgetProviderManager* GetInstance(void); /** - * Requests AppWidget service to trigger specified AppWidget update + * Requests AppWidget service to trigger the specified AppWidget update. * * @since 2.1 * * @param[in] appId The appId that provides AppWidget * @param[in] providerName The name of the AppWidget provider - * @param[in] userInfo User information for the AppWidget provider@n - * This parameter will be delivered as parameter of AppWidgetProvider::OnAppWidgetProviderUpdating() + * @param[in] userInfo User information for the AppWidget provider @n + * This parameter will be delivered as parameter of AppWidgetProvider::OnAppWidgetProviderUpdating(). * * @exception E_SUCCESS The method is successful. * @exception E_APP_NOT_INSTALLED The application is not installed. * @exception E_OBJ_NOT_FOUND The specified AppWidget provider is not found. - * @exception E_CERTIFICATE_VERIFICATION_FAILED The application isn't permitted to request to update AppWidget of other application package.@n + * @exception E_CERTIFICATE_VERIFICATION_FAILED The application is not permitted to request to update AppWidget of other application package. @n * To get permission, the target application is signed with the same certificate. * @exception E_SYSTEM The method cannot proceed due to a severe system error. * @@ -84,14 +84,14 @@ public: result RequestUpdate(const Tizen::App::AppId& appId, const Tizen::Base::String& providerName, const Tizen::Base::String& userInfo = L""); /** - * Requests a AppWidget viewer(eg, Home screen, Lock screen) to add the specified AppWidget. + * Requests a AppWidget viewer (for example, Home screen, Lock screen) to add the specified AppWidget. * * @since 2.1 * @privlevel public * @privilege %http://tizen.org/privilege/appwidgetprovider.install * * @param[in] providerAppId The ID of the application providing AppWidget - * @param[in] providerName The name of AppWidget provider to be added + * @param[in] providerName The name of AppWidget provider to add * @param[in] alternateText Alternate text displayed in the AppWidgetView while the AppWidgetProvider is initializing or unavailable. * @param[in] userInfo User information for the AppWidget provider * @@ -99,22 +99,22 @@ public: * @exception E_APP_NOT_INSTALLED The application is not installed. * @exception E_OBJ_NOT_FOUND The specified AppWidget provider is not found. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @exception E_CERTIFICATE_VERIFICATION_FAILED The application isn't permitted to request add AppWidget of other application package. + * @exception E_CERTIFICATE_VERIFICATION_FAILED The application is not permitted to request to add AppWidget of other application package. @n * To get permission, the target application is signed with the same certificate. - * @exception E_UNSUPPORTED_OPERATION The specified AppWidget provider doesn't support this operation.@ - * To request a AppWidget viewer to add a AppWidget, AppWidget provider should support 1x1 size AppWidget, but the specified AppWidget provider doesn't support 1x1 size. - * @exception E_CONNECTION_FAILED The viewer application doesn't set a listener to receive this request. + * @exception E_UNSUPPORTED_OPERATION The specified AppWidget provider does not support this operation. @n + * To request a AppWidget viewer to add a AppWidget, AppWidget provider should support 1x1 size AppWidget, but the specified AppWidget provider does not support 1x1 size. + * @exception E_CONNECTION_FAILED The viewer application does not set a listener to receive this request. * @exception E_SYSTEM The method cannot proceed due to a severe system error. * - * @remarks Only AppWidget provider that is packaged with the caller application can be added by this API. - * @see SetAppWidgetRequestListener + * @remarks Only AppWidget provider that is packaged with the caller application can be added by this method. + * @see AppWidgetManager::SetAppWidgetRequestListener() */ result AddAppWidget(const Tizen::App::AppId& providerAppId, const Tizen::Base::String& providerName, const Tizen::Base::String& alternateText, const Tizen::Base::String& userInfo); /** * Sets a AppWidgetProvider factory. @n - * The factory is called when AppWidgetProvider is need to be created. - * This function should be called in App::OnAppInitializing(), to receive event correctly. + * The factory is called when AppWidgetProvider needs to be created. + * The %SetAppWidgetProviderFactory() method should be called in App::OnAppInitializing(), to receive the event correctly. * Implementing AppWidgetProviderFactory is mandatory to provide AppWidget functionality. * * @since 2.1 @@ -122,7 +122,7 @@ public: * @return An error code * @param[in] factory The factory to create concrete AppWidgetProvider * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_OPERATION The application's attribute doesn't meet conditon to provide AppWidget. + * @exception E_INVALID_OPERATION The application's attribute does not meet the condition to provide AppWidget. * @exception E_SYSTEM The method cannot proceed due to a severe system error. * @see IAppWidgetProviderFactory */ @@ -130,8 +130,8 @@ public: /** * Sets a AppWidgetPopupProvider factory. @n - * The factory is called when AppWidgetPopupProvider is need to be created. - * This function should be called in App::OnAppInitializing(), to receive event correctly. + * The factory is called when AppWidgetPopupProvider needs to be created. + * The %SetAppWidgetPopupProviderFactory() method should be called in App::OnAppInitializing(), to receive the event correctly. * Implementing AppWidgetPopupProviderFactory is mandatory to provide AppWidgetPopup functionality. * * @since 2.1 @@ -139,7 +139,7 @@ public: * @return An error code * @param[in] factory The factory to create concrete AppWidgetPopupProvider * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_OPERATION The application's attribute doesn't meet conditon to provide AppWidget popup. + * @exception E_INVALID_OPERATION The application's attribute does not meet the condition to provide AppWidget popup. * @exception E_SYSTEM The method cannot proceed due to a severe system error. * @see IAppWidgetPopupProviderFactory */ diff --git a/inc/FShellAppWidgetSizeInfo.h b/inc/FShellAppWidgetSizeInfo.h index 8c6b0f6..81e07c7 100644 --- a/inc/FShellAppWidgetSizeInfo.h +++ b/inc/FShellAppWidgetSizeInfo.h @@ -36,9 +36,11 @@ class _AppWidgetSizeInfoImpl; /** * @class AppWidgetSizeInfo - * @brief This class contains size and preview image path for the size + * @brief This class provides methods to retrieve size and image path for preview. * * @since 2.1 + * + * The %AppWidgetSizeInfo class provides methods to retrieve size and image path for preview. */ class _OSP_EXPORT_ AppWidgetSizeInfo : public Tizen::Base::Object @@ -61,16 +63,16 @@ public: AppWidgetSizeInfo(const AppWidgetSizeInfo& rhs); /** - * Gets the size + * Gets the size. * * @since 2.1 * - * @return A size + * @return The size */ Tizen::Graphics::FloatDimension GetSize(void) const; /** - * Gets the image path for preview + * Gets the image path for preview. * * @since 2.1 * diff --git a/inc/FShellIAppWidgetPopupProviderFactory.h b/inc/FShellIAppWidgetPopupProviderFactory.h index c322911..decdcc3 100644 --- a/inc/FShellIAppWidgetPopupProviderFactory.h +++ b/inc/FShellIAppWidgetPopupProviderFactory.h @@ -55,14 +55,14 @@ public: virtual ~IAppWidgetPopupProviderFactory(void) {}; /** - * Creates a AppWidgetPopupProvider instance@n - * Called when the AppWidgetPopupProvider creation request is received from the appwidget service. @n + * Creates a AppWidgetPopupProvider instance. @n + * Called when the %AppWidgetPopupProvider creation request is received from the appwidget service. @n * Applications that provide the AppWidget functionality must implement this listener. * * @since 2.1 * * @param[in] providerName The AppWidget provider name - * @param[in] userInfo User information that specifed when the AppWidget is added + * @param[in] userInfo User information that specified when the AppWidget is added */ virtual AppWidgetPopupProvider* CreateInstance(const Tizen::Base::String& providerName, const Tizen::Base::String& userInfo) = 0; diff --git a/inc/FShellIAppWidgetProviderFactory.h b/inc/FShellIAppWidgetProviderFactory.h index bb995db..172e8b4 100644 --- a/inc/FShellIAppWidgetProviderFactory.h +++ b/inc/FShellIAppWidgetProviderFactory.h @@ -34,12 +34,12 @@ class AppWidgetProvider; /** * @interface IAppWidgetProviderFactory - * @brief This interface defines the factory for the %AppWidgetProvider creation + * @brief This interface defines the factory for the AppWidgetProvider creation. * * @since 2.1 * - * The %IAppWidgetProviderFactory interface defines a factory for the %AppWidgetProvider creation - * The %AppWidgetManager calls CreateInstance() when an instance of %AppWidgetProvider is required. + * The %IAppWidgetProviderFactory interface defines a factory for the AppWidgetProvider creation. + * The AppWidgetManager calls CreateInstance() when an instance of %AppWidgetProvider is required. * Applications that provide the %AppWidgetProvider functionality must implement this interface. * * @see AppWidgetManager @@ -64,7 +64,7 @@ public: * @param[in] providerName The AppWidget provider name * @param[in] width The width of the AppWidget * @param[in] height The height of the AppWidget - * @param[in] userInfo User information that specifed when the AppWidget is added + * @param[in] userInfo User information that specifes when the AppWidget is added */ virtual AppWidgetProvider* CreateInstance(const Tizen::Base::String& providerName, float width, float height, const Tizen::Base::String& userInfo) = 0; diff --git a/inc/FShellIAppWidgetRequestListener.h b/inc/FShellIAppWidgetRequestListener.h index a261bf6..e3ca200 100644 --- a/inc/FShellIAppWidgetRequestListener.h +++ b/inc/FShellIAppWidgetRequestListener.h @@ -34,11 +34,11 @@ namespace Tizen { namespace Shell /** * @interface IAppWidgetRequestListener - * @brief This interface defines a listener for a AppWidget viewer(eg, Home screen) that receives request to add AppWidget + * @brief This interface defines a listener for a AppWidget viewer (for example, Home screen, Lock screen) that receives request to add AppWidget. * * @since 2.1 * - * The %IAppWidgetRequestListener interface defines a listener for a AppWidget viewer(eg, Home screen) that receives request to add AppWidget + * The %IAppWidgetRequestListener interface defines a listener for a AppWidget viewer (for example, Home screen, Lock screen) that receives request to add AppWidget. */ class _OSP_EXPORT_ IAppWidgetRequestListener : virtual public Tizen::Base::Runtime::IEventListener @@ -53,11 +53,13 @@ public: virtual ~IAppWidgetRequestListener(void) {} /** - * Called when requested to add a AppWidget @n - * The AppWidget viewer application such as the Home screen can get callback request to add a AppWidget by implementing this listener. @n + * Called when requested to add a AppWidget. @n + * The AppWidget viewer application such as the Home screen can get callback request to add a AppWidget by implementing this listener. + * + * @since 2.1 * * @param[in] appId The application ID of the application providing AppWidget - * @param[in] providerName The name of AppWidget provider to be added + * @param[in] providerName The name of AppWidget provider to add * @param[in] text Alternative text for the AppWidget * @param[in] userInfo User information for the AppWidget provider * @see AppWidgetManager::AddAppWidget() diff --git a/inc/FShellShortcutManager.h b/inc/FShellShortcutManager.h index e0779c2..8ad9b23 100644 --- a/inc/FShellShortcutManager.h +++ b/inc/FShellShortcutManager.h @@ -76,7 +76,7 @@ public: * @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 via shortcut. + * @param[in] uriData Uri that will be delivered by IAppControlProviderEventListener::OnAppControlRequestReceived(), when the application start via shortcut. * @param[in] allowDuplication Flag to allow duplicate shortcut. * * @exception E_SUCCESS The method is successful. -- 2.7.4