diff options
author | hs321.lee <hs321.lee@samsung.com> | 2013-10-23 13:41:48 +0900 |
---|---|---|
committer | hs321.lee <hs321.lee@samsung.com> | 2013-12-03 13:49:01 +0900 |
commit | 95f6b6383fa17b44bcad9df080f058a2adfc713a (patch) | |
tree | 1980dd3e8d098749d8a264e7f25eb7516adbedfb /inc/FSclAccountAccessor.h | |
parent | 59bf0526bb43f08ab3e12908a3459a2b93507954 (diff) | |
download | social-95f6b6383fa17b44bcad9df080f058a2adfc713a.tar.gz social-95f6b6383fa17b44bcad9df080f058a2adfc713a.tar.bz2 social-95f6b6383fa17b44bcad9df080f058a2adfc713a.zip |
Update the doxygen by LB
Change-Id: Id63d33146f4f71d3fe8502a112ac8729478e5635
Signed-off-by: hs321.lee <hs321.lee@samsung.com>
Diffstat (limited to 'inc/FSclAccountAccessor.h')
-rw-r--r-- | inc/FSclAccountAccessor.h | 48 |
1 files changed, 24 insertions, 24 deletions
diff --git a/inc/FSclAccountAccessor.h b/inc/FSclAccountAccessor.h index 96d674c..e5f9f7e 100644 --- a/inc/FSclAccountAccessor.h +++ b/inc/FSclAccountAccessor.h @@ -71,80 +71,80 @@ public: * @exception E_SUCCESS The method is successful. * @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. - * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. + * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. * @remarks The platform will not take the ownership of @c pListener after this call. */ result SetEventListener(IAccountEventListener* pListener); /** - * Gets an account with a specified account ID. + * Gets an account with the specified account ID. * * @since 2.1 * @privlevel public * @privilege %http://tizen.org/privilege/account.read * - * @return An account with the specified @c accountId + * @return The account with the specified @c accountId * @param[in] accountId The account ID * @exception E_SUCCESS The method is successful. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. * @exception E_INVALID_ARG The specified @c accountId is invalid. * @exception E_OBJ_NOT_FOUND The specified @c accountId is not found. - * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. + * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. * @exception E_SYSTEM The method cannot proceed due to a severe system error. * @remarks The specific error code can be accessed using the GetLastResult() method. */ Account GetAccount(AccountId accountId) const; /** - * Gets accounts associated with the account provider that has a specified application ID. + * Gets accounts associated with the account provider that has the specified application ID. * * @since 2.1 * @privlevel public * @privilege %http://tizen.org/privilege/account.read * - * @return A list of accounts, @n - * else an empty list if there is no account, or @c null if an exception occurs (@ref Account list) + * @return The list of accounts, @n + * else an empty list if there is no account, or @c null if an exception occurs (@ref Account list) * @param[in] accountProviderAppId The application ID of the account provider * @exception E_SUCCESS The method is successful. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. * @exception E_INVALID_ARG The specified @c accountProviderAppId is empty. - * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. + * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. * @exception E_SYSTEM The method cannot proceed due to a severe system error. * @remarks The specific error code can be accessed using the GetLastResult() method. */ Tizen::Base::Collection::IList* GetAccountsByAccountProviderN(const Tizen::App::AppId& accountProviderAppId) const; /** - * Gets all accounts. + * Gets all the accounts. * * @since 2.1 * @privlevel public * @privilege %http://tizen.org/privilege/account.read * - * @return A list of accounts, @n - * else an empty list if there is no account, or @c null if an exception occurs (@ref Account list) + * @return The list of accounts, @n + * else an empty list if there is no account, or @c null if an exception occurs (@ref Account list) * @exception E_SUCCESS The method is successful. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. + * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. * @exception E_SYSTEM The method cannot proceed due to a severe system error. * @remarks The specific error code can be accessed using the GetLastResult() method. */ Tizen::Base::Collection::IList* GetAllAccountsN(void) const; /** - * Gets an account provider with a specified application ID. + * Gets an account provider with the specified application ID. * * @since 2.1 * @privlevel public * @privilege %http://tizen.org/privilege/account.read * - * @return An account provider with the specified @c accountProviderAppId ID + * @return The account provider with the specified @c accountProviderAppId ID * @param[in] accountProviderAppId The application ID of the account provider * @exception E_SUCCESS The method is successful. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. * @exception E_INVALID_ARG The specified @c accountProviderAppId is empty. * @exception E_OBJ_NOT_FOUND The specified @c accountProviderAppId is not found. - * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. + * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. * @exception E_SYSTEM The method cannot proceed due to a severe system error. * @remarks The specific error code can be accessed using the GetLastResult() method. */ @@ -157,42 +157,42 @@ public: * @privlevel public * @privilege %http://tizen.org/privilege/account.read * - * @return A list of account providers, @n - * else an empty list if there is no account provider, or @c null if an exception occurs (@ref AccountProvider list) + * @return The list of account providers, @n + * else an empty list if there is no account provider, or @c null if an exception occurs (@ref AccountProvider list) * @param[in] capability The predefined capability or the vendor-specific capability defined as the IRI format * @exception E_SUCCESS The method is successful. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. * @exception E_INVALID_ARG The specified @c capability is empty. - * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. + * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. * @exception E_SYSTEM The method cannot proceed due to a severe system error. * @remarks The specific error code can be accessed using the GetLastResult() method. */ Tizen::Base::Collection::IList* GetAccountProvidersByCapabilityN(const Tizen::Base::String& capability) const; /** - * Gets all currently registered account providers. + * Gets all the currently registered account providers. * * @since 2.1 * @privlevel public * @privilege %http://tizen.org/privilege/account.read * - * @return A list of account providers, @n - * else an empty list if there is no account provider, or @c null if an exception occurs (@ref AccountProvider list) + * @return The list of account providers, @n + * else an empty list if there is no account provider, or @c null if an exception occurs (@ref AccountProvider list) * @exception E_SUCCESS The method is successful. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. + * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. * @exception E_SYSTEM The method cannot proceed due to a severe system error. * @remarks The specific error code can be accessed using the GetLastResult() method. */ Tizen::Base::Collection::IList* GetAllAccountProvidersN(void) const; /** - * Gets the %AccountAccessor instance. + * Gets an %AccountAccessor instance. * * @since 2.1 * * @return A pointer to the %AccountAccessor instance, @n - * else @c null if it fails + * else @c null if it fails * @remarks The specific error code can be accessed using the GetLastResult() method. */ static AccountAccessor* GetInstance(void); |