From ef5de86950822c88b7380c44f657d1105ea22446 Mon Sep 17 00:00:00 2001 From: Jaehwa Shin Date: Wed, 27 Mar 2013 12:28:23 +0900 Subject: [PATCH] Apply addressbook API doxygen review Change-Id: I03f7902b9cf20c5ca603583bf06a7164a61fee84 Signed-off-by: Jaehwa Shin --- inc/FSclAddressbook.h | 100 ++++++++++++++++++------------------ inc/FSclAddressbookFilter.h | 12 ++--- inc/FSclAddressbookManager.h | 34 ++++++------ inc/FSclContact.h | 6 +-- inc/FSclEmail.h | 32 ++++++------ inc/FSclIAddressbookEventListener.h | 2 +- inc/FSclOrganization.h | 12 ++--- inc/FSclPhoneNumber.h | 28 +++++----- inc/FSclUserProfile.h | 86 +++++++++++++++---------------- 9 files changed, 157 insertions(+), 155 deletions(-) diff --git a/inc/FSclAddressbook.h b/inc/FSclAddressbook.h index 71f1cc1..b2090f6 100644 --- a/inc/FSclAddressbook.h +++ b/inc/FSclAddressbook.h @@ -260,7 +260,7 @@ class _OSP_EXPORT_ Addressbook public: /** * - * The object is not fully constructed after this constructor is called.@n + * The object is not fully constructed after this constructor is called. @n * An application must use AddressbookManager::GetAddressbookN() to get fully constructed %Addressbook instance. * @since 2.0 * @@ -292,7 +292,7 @@ public: /** * @if OSPDEPREC - * Initializes this instance of %Addressbook with the specified listener. @n + * Initializes this instance of %Addressbook with the specified listener. * * @brief [Deprecated] * @deprecated This method and IRecordEventListener are deprecated. Instead of using this method, use AddressbookManager::GetAddressbookN() and SetEventListener(). @@ -416,7 +416,8 @@ 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_OBJ_NOT_FOUND The specified @c contact does not exist in this address book. - * @exception E_INVALID_ARG The specified @c contact is invalid or the properties of the specified @c contact have not been set. + * @exception E_INVALID_ARG The specified @c contact is invalid, or + * the properties of the specified @c contact have not been set. * @exception E_STORAGE_FULL The storage is insufficient. * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ @@ -548,7 +549,7 @@ public: * @privilege %http://tizen.org/privilege/contact.read * * @return A list of all contacts in the addressbook, @n - * else an empty list if there is no contact or @c null if an exception occurs (@ref Contact list) + * else an empty list if there is no contact, or @c null if an exception occurs (@ref Contact 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_SYSTEM The method cannot proceed due to a severe system error. @@ -571,7 +572,7 @@ public: * @privilege %http://tizen.org/privilege/contact.read * * @return A list of contacts that are members of the specified category, @n - * else an empty list if there is no contact or @c null if an exception occurs (@ref Contact list) + * else an empty list if there is no contact, or @c null if an exception occurs (@ref Contact list) * @param[in] categoryId The category ID * @exception E_SUCCESS The method is successful. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. @@ -595,7 +596,7 @@ public: * @privilege %http://tizen.org/privilege/contact.read * * @return A list of contacts in the specified range, @n - * else an empty list if there is no contact or @c null if an exception occurs (@ref Contact list) + * else an empty list if there is no contact, or @c null if an exception occurs (@ref Contact list) * @param[in] pageNo The page number of the result list @n * It starts from @c 1. * @param[in] countPerPage The maximum count of the result items on a page @@ -623,7 +624,7 @@ public: * @privilege %http://tizen.org/privilege/contact.read * * @return A list of contacts in the specified range of the specified category, @n - * else an empty list if there is no contact or @c null if an exception occurs (@ref Contact list) + * else an empty list if there is no contact, or @c null if an exception occurs (@ref Contact list) * @param[in] category The category * @param[in] pageNo The page number of the result list, which starts from @c 1 * @param[in] countPerPage The maximum count of the result items on a page @@ -802,7 +803,7 @@ public: * @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. - * - There is a high probability for an occurrence of an out-of-memory exception.@n If possible, check whether the exception is E_OUT_OF_MEMORY or not.@n + * - There is a high probability for an occurrence of an out-of-memory exception. @n If possible, check whether the exception is E_OUT_OF_MEMORY or not. @n * For more information on how to handle the out-of-memory exception, refer * here. */ @@ -818,7 +819,7 @@ public: * @privilege %http://tizen.org/privilege/contact.read * * @return A list of all the matched contacts, @n - * else an empty list if there is no matched contact or @c null if an exception occurs (@ref Contact list) + * else an empty list if there is no matched contact, or @c null if an exception occurs (@ref Contact list) * @param[in] name The substring of the name to search * @exception E_SUCCESS The method is successful. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. @@ -834,7 +835,7 @@ public: /** * Searches the contacts that have the specified @c phoneNumber string as a substring of one of their phone numbers. @n - * This method returns the contacts whose phone number match the value of the specified @c phoneNumber. @n + * The %SearchContactsByPhoneNumberN() method returns the contacts whose phone number match the value of the specified @c phoneNumber. @n * The search operation is performed with a case insensitive key (param: @c phoneNumber). @n * The contacts are ordered by display name. * @@ -843,7 +844,7 @@ public: * @privilege %http://tizen.org/privilege/contact.read * * @return A list of all the matched contacts, @n - * else an empty list if there is no contact or @c null if an exception occurs (@ref Contact list) + * else an empty list if there is no contact, or @c null if an exception occurs (@ref Contact list) * @param[in] phoneNumber The substring of the phone number to search * @exception E_SUCCESS The method is successful. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. @@ -851,7 +852,7 @@ public: * @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. - * - There is a high probability for an occurrence of an out-of-memory exception.@n If possible, check whether the exception is E_OUT_OF_MEMORY or not.@n + * - There is a high probability for an occurrence of an out-of-memory exception. @n If possible, check whether the exception is E_OUT_OF_MEMORY or not. @n * For more information on how to handle the out-of-memory exception, refer * here. */ @@ -886,7 +887,7 @@ public: * @privilege %http://tizen.org/privilege/contact.read * * @return A list of contact change information, @n - * else an empty list if there is no changed contact or @c null if an exception occurs (@ref ContactChangeInfo list) + * else an empty list if there is no changed contact, or @c null if an exception occurs (@ref ContactChangeInfo list) * @param[in] version The change version * @param[out] latestVersion The latest change version among the changed contacts * @exception E_SUCCESS The method is successful. @@ -959,25 +960,25 @@ public: Tizen::Base::Collection::IList* GetChangedContactInfoListN(int version, int& latestVersion) const; /** - * Gets the change information of the categories that have been changed after the specified version. - * + * Gets the change information of the categories that have been changed after the specified version. + * * @brief [Deprecated] * @deprecated This method is deprecated. Instead of using this method, use GetChangedCategoryInfoListAfterN(). * - * @since 2.0 - * @privlevel public - * @privilege %http://tizen.org/privilege/contact.read - * - * @return A list of category change information, @n - * else an empty list if there is no changed category or @c null if an exception occurs (@ref CategoryChangeInfo list) - * - * @param[in] version The change version - * @param[out] latestVersion The latest change version among the changed categories - * @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 version is invalid. + * @since 2.0 + * @privlevel public + * @privilege %http://tizen.org/privilege/contact.read + * + * @return A list of category change information, @n + * else an empty list if there is no changed category, or @c null if an exception occurs (@ref CategoryChangeInfo list) + * + * @param[in] version The change version + * @param[out] latestVersion The latest change version among the changed categories + * @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 version is invalid. * @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. + * @remarks The specific error code can be accessed using the GetLastResult() method. * @see GetLatestVersion() * * The following example demonstrates how to use the %GetChangedCategoriesAfterN() method. @@ -1044,7 +1045,8 @@ public: Tizen::Base::Collection::IList* GetChangedCategoryInfoListN(int version, int& latestVersion) const; /** - * Sets the user profile of this addressbook. To remove the user profile, @c null must be passed. + * Sets a user profile of this addressbook. @n + * To remove the user profile, @c null must be passed. * * @since 2.1 * @privlevel public @@ -1054,19 +1056,19 @@ public: * @param[in] pUserProfile The user profile to set * @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_SYSTEM The method cannot proceed due to a severe system error. */ result SetUserProfile(const UserProfile* pUserProfile); /** - * Gets the user profile of this addressbook. + * Gets a user profile of this addressbook. * * @since 2.1 * @privlevel public * @privilege %http://tizen.org/privilege/userprofile.read * * @return The user profile, @n - * else @c null if the user profile does not exist or an exception has occurred. + * else @c null if the user profile does not exist, or if an exception has occurred * @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. @@ -1129,18 +1131,18 @@ public: * @privilege %http://tizen.org/privilege/contact.write * * @return An error code - * @param[in] contactList The contacts to add. The list should contain Contact instances. - * @param[out] pContactIdList A pointer to the list of the IDs of the contacts that have been added successfully. Pass null if the contact IDs are not necessary. + * @param[in] contactList The contacts to add @n The list should contain the Contact instances. + * @param[out] pContactIdList A pointer to the list of contact IDs that have been added successfully @n Pass @c null if the contact IDs are not necessary. * @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 Either of the following conditions has occurred: - * - The specified @c contactList is empty + * - The specified @c contactList is empty. * - The specified @c contactList contains an empty contact. * - The specified @c contactList contains a contact whose ID is not INVALID_RECORD_ID. * @exception E_SYSTEM The method cannot proceed due to a severe system error. - * @remarks If an exception occurs during adding contacts, the changes are getting rollbacked.@n - * This method blocks the execution of the calling thread until all contacts in the list has been added to the addressbook or an exception occurs. - * It is recommended to call this method, on a thread other than main thread. + * @remarks If an exception occurs during adding contacts, the changes are getting rollbacked. @n + * This method blocks the execution of the calling thread until all contacts in the list has been added to the addressbook or if an exception occurs. + * It is recommended to call this method on any thread other than the main thread. */ result AddContacts(const Tizen::Base::Collection::IList& contactList, Tizen::Base::Collection::IListT* pContactIdList = null); @@ -1152,37 +1154,37 @@ public: * @privilege %http://tizen.org/privilege/contact.write * * @return An error code - * @param[in] contactList The contacts to update. The list should contain Contact instances. + * @param[in] contactList The contacts to update @n The list should contain the Contact instances. * @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 Either of the following conditions has occurred: - * - The specified @c contactList is empty + * - The specified @c contactList is empty. * - The specified @c contactList contains an empty contact. * - The specified @c contactList contains a contact whose ID is invalid. - * @exception E_OBJ_NOT_FOUND There is a contact which does not exist. + * @exception E_OBJ_NOT_FOUND The specified @c contact does not exist. * @exception E_SYSTEM The method cannot proceed due to a severe system error. - * @remarks If an exception occurs during updating contacts, the changes are getting rollbacked.@n - * This method blocks the execution of the calling thread until all contacts in the list has been updated or an exception occurrs.@n - * It is recommended to call this method, on a thread other than main thread. + * @remarks If an exception occurs during updating contacts, the changes are getting rollbacked. @n + * This method blocks the execution of the calling thread until all contacts in the list has been updated or if an exception occurs. @n + * It is recommended to call this method on any thread other than the main thread. */ result UpdateContacts(const Tizen::Base::Collection::IList& contactList); /** - * Removes the contacts. If the contact specified by a contact ID in the list does not exist, the contact ID is ignored. + * Removes the contacts. @n If the contact specified by a contact ID in the list does not exist, the contact ID is ignored. * * @since 2.1 * @privlevel public * @privilege %http://tizen.org/privilege/contact.write * * @return An error code - * @param[in] contactIdList The list of contact IDs to delete. + * @param[in] contactIdList The list of contact IDs to delete * @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 contactIdList is empty or contains an invalid ID. * @exception E_SYSTEM The method cannot proceed due to a severe system error. - * @remarks If an exception occurs during removing contacts, the changes are getting rollbacked.@n - * This method blocks the execution of the calling thread until all contacts in the list has been removed or an exception occurs.@n - * It is recommended to call this method, on a thread other than main thread. + * @remarks If an exception occurs during removing contacts, the changes are getting rollbacked. @n + * This method blocks the execution of the calling thread until all contacts in the list has been removed or if an exception occurs. @n + * It is recommended to call this method on any thread other than the main thread. */ result RemoveContacts(const Tizen::Base::Collection::IListT& contactIdList); diff --git a/inc/FSclAddressbookFilter.h b/inc/FSclAddressbookFilter.h index 85b26b7..91f3cad 100644 --- a/inc/FSclAddressbookFilter.h +++ b/inc/FSclAddressbookFilter.h @@ -45,7 +45,7 @@ namespace Tizen { namespace Social * @final This class is not intended for extension. * * The %AddressbookFilter class represents the condition for searching the specific item on addressbook. - * The type of the filter decides which item will be searched. (such as addressbook, contacts, persons, categories) @n + * The type of the filter decides which item will be searched (such as addressbook, contacts, persons, categories). @n * The filter can consist of multiple filtering expressions and conjunctive operators. * A filtering expression consists of a filter property, comparison operator and value. * The filter property must be an element of the enumerator that corresponds with the type of the filter. @n @@ -109,7 +109,7 @@ class _OSP_EXPORT_ AddressbookFilter { public: /** - * Initializes an instance of %AddressbookFilter with the specified type. + * Initializes an instance of %AddressbookFilter with the specified @c type. * * @since 2.0 * @@ -183,10 +183,10 @@ public: * @param[in] comparisonOperator The comparison operator #FI_CMP_OP_EQUAL is only permitted * @param[in] value The @c bool value for comparison * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG Either of the following conditions has occurred: @n - * - The @c filterProperty is not an element of the enumerator that corresponds with the type of this filter. @n - * - The type of the @c filterProperty is not @c bool. @n - * - The @c comparisonOperator is no #FI_CMP_OP_EQUAL. @n + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The @c filterProperty is not an element of the enumerator that corresponds with the type of this filter. + * - The type of the @c filterProperty is not @c bool. + * - The @c comparisonOperator is no #FI_CMP_OP_EQUAL. * - The specified @c conjuctiveOperator is invalid. * @remarks If the filtering expression is appended firstly, the @c conjunctiveOperator is ignored. */ diff --git a/inc/FSclAddressbookManager.h b/inc/FSclAddressbookManager.h index 9a20b54..0ba6033 100644 --- a/inc/FSclAddressbookManager.h +++ b/inc/FSclAddressbookManager.h @@ -792,7 +792,7 @@ public: /** * Gets the persons that are members of the specified category where a person is a member of a category if a contact linked to it is a member of the category. @n - * If the specified @c categoryId is INVALID_RECORD_ID, this method returns the persons that are not members of any category.@n + * If the specified @c categoryId is INVALID_RECORD_ID, this method returns the persons that are not members of any category. @n * The persons are ordered by display name. * * @since 2.0 @@ -893,7 +893,7 @@ public: * - Removes the source person. * - Updates information of the target person. * - * This method does nothing if the source or target person does not exist. + * The %MergePersons() method does nothing if the source or target person does not exist. * * @since 2.0 * @privlevel public @@ -918,7 +918,7 @@ public: * - Updates information of the persons. * * It is not allowed to unlink a contact if it is the only one contact linked to a person. - * This method does nothing if the contact has not been linked to the person or does not exist. + * The %UnlinkContact() method does nothing if the contact has not been linked to the person or does not exist. * * @since 2.0 * @privlevel public @@ -998,7 +998,7 @@ public: /** * Parses contacts from the specified vCard file. @n - * This method supports vCard formation 2.1 and 3.0. + * The %ParseContactsFromVcardN() method supports vCard formation 2.1 and 3.0. * * @since 2.0 * @@ -1042,7 +1042,7 @@ public: * @privilege %http://tizen.org/privilege/contact.read * * @return An error code - * @param[in] personList The person list to export @n The list should contain Person instances. + * @param[in] personList The person list to export @n The list should contain the Person instances. * @param[in] vcardPath The file path of a vCard file * @exception E_SUCCESS The method is successful. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. @@ -1096,7 +1096,7 @@ public: * @since 2.1 * * @return The exported vcard stream, @n - * else @c null if an exception occurs. + * else @c null if an exception occurs * @param[in] contact The contact to export * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified @c contact is invalid. @@ -1112,8 +1112,8 @@ public: * @since 2.1 * * @return The exported vcard stream, @n - * else @c null if an exception occurs. - * @param[in] contactList The contact list to export @n The list should contain Contact instances + * else @c null if an exception occurs + * @param[in] contactList The contact list to export @n The list should contain the Contact instances * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified @c contactList contains an invalid contact. * @exception E_SYSTEM The method cannot proceed due to a severe system error. @@ -1149,8 +1149,8 @@ public: * @privilege %http://tizen.org/privilege/contact.read * * @return The exported vcard stream, @n - * else @c null if an exception occurs. - * @param[in] personList The person list to export @n The list should contain Person instances. + * else @c null if an exception occurs + * @param[in] personList The person list to export @n The list should contain the Person instances. * @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 personList contains invalid person. @@ -1162,7 +1162,7 @@ public: /** * Parses contacts from the specified vCard stream. @n - * This method supports vCard formation 2.1 and 3.0. + * The %ParseVcardStreamN() method supports vCard formation 2.1 and 3.0. * * @since 2.1 * @@ -1183,7 +1183,7 @@ public: * @since 2.1 * * @return The exported vCard stream, @n - * else @c null if an exception occurs. + * else @c null if an exception occurs * @param[in] userProfile The user profile to export * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified @c userProfile is invalid. @@ -1198,8 +1198,8 @@ public: * @since 2.1 * * @return The exported vCard stream, @n - * else @c null if an exception occurs. - * @param[in] userProfileList The user profile list to export. The list should contain UserProfile instance + * else @c null if an exception occurs + * @param[in] userProfileList The user profile list to export @n The list should contain the UserProfile instances * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified @c userProfile is invalid. * @exception E_SYSTEM The method cannot proceed due to a severe system error. @@ -1230,7 +1230,7 @@ public: * @since 2.1 * * @return An error code - * @param[in] userProfileList The user profile list to export @n The list should contain UserProfile instances. + * @param[in] userProfileList The user profile list to export @n The list should contain the UserProfile instances * @param[in] vcardPath The file path of a vCard file * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG Either the specified @c userProfileList is invalid or @@ -1243,7 +1243,7 @@ public: result ExportUserProfilesToVcard(const Tizen::Base::Collection::IList& userProfileList, const Tizen::Base::String& vcardPath); /** - * Gets all user profiles on the device. @n + * Gets all user profiles on the device. * * @since 2.1 * @privlevel public @@ -1259,7 +1259,7 @@ public: Tizen::Base::Collection::IList* GetAllUserProfilesN(void) const; /** - * Gets the user profile of the address book specified by the address book ID. + * Gets a user profile of the address book specified by the address book ID. * * @since 2.1 * @privlevel public diff --git a/inc/FSclContact.h b/inc/FSclContact.h index 6971f53..804bea3 100644 --- a/inc/FSclContact.h +++ b/inc/FSclContact.h @@ -175,7 +175,7 @@ public: Tizen::Graphics::Bitmap* GetThumbnailN(void) const; /** - * Gets the thumbnail path + * Gets the thumbnail path. * * @since 2.0 * @@ -222,7 +222,7 @@ public: * @return An error code * @param[in] id The ID of the property whose value is to set * @param[in] value A new string value to set - * @exception E_SUCCESS The method is successful. + * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The @c id is #CONTACT_PROPERTY_ID_DISPLAY_NAME or @if OSPDEPREC #CONTACT_PROPERTY_ID_THUMBNAIL, or @endif * the ringtone file path (value) is invalid if @c id is #CONTACT_PROPERTY_ID_RINGTONE. * @remarks @@ -449,7 +449,7 @@ public: result SetOrganizationAt(int index, const Organization& organization); /** - * Sets the specified relationship corresponding to the specified index. + * Sets the specified @c relationship corresponding to the specified @c index. * * @since 2.1 * diff --git a/inc/FSclEmail.h b/inc/FSclEmail.h index dd91f9e..436709b 100644 --- a/inc/FSclEmail.h +++ b/inc/FSclEmail.h @@ -83,7 +83,7 @@ public: /** * Initializes this instance of %Email with the specified @c type and @c email. @n - * This constructs an instance of %Email of the specified type. + * This constructs an instance of %Email of the specified @c type. * * @since 2.0 * @@ -129,32 +129,32 @@ public: virtual int GetHashCode(void) const; /** - * Gets the type of the email. - * + * Gets the type of the email. + * * @if OSPCOMPAT - * @brief [Compatibility] + * @brief [Compatibility] * @endif - * @since 2.0 + * @since 2.0 * @if OSPCOMPAT * @compatibility This method has compatibility issues with OSP compatible applications. @n - * For more information, see @ref CompEmailGetTypePage "here". + * For more information, see @ref CompEmailGetTypePage "here". * @endif - * - * @return The type of the email - */ + * + * @return The type of the email + */ EmailType GetType(void) const; /** * @if OSPCOMPAT - * @page CompEmailGetTypePage Compatibility for GetType() - * @section CompEmailGetTypePageIssueSection Issues + * @page CompEmailGetTypePage Compatibility for GetType() + * @section CompEmailGetTypePageIssueSection Issues * Implementing this method in OSP compatible applications has the following issue: @n - * -# EMAIL_TYPE_CUSTOM is not supported. If the type of the email is EMAIL_TYPE_CUSTOM, EMAIL_TYPE_OTHER is returned instead. - * - * @section CompEmailGetTypePageSolutionSection Resolutions + * -# EMAIL_TYPE_CUSTOM is not supported. If the type of the email is EMAIL_TYPE_CUSTOM, EMAIL_TYPE_OTHER is returned instead. + * + * @section CompEmailGetTypePageSolutionSection Resolutions * The issue mentioned above has been resolved in Tizen. * @endif - */ + */ /** * Gets the email address. @@ -216,7 +216,7 @@ public: Tizen::Base::String GetLabel(void) const; /** - * Sets the label of an email. + * Sets the label of an email. * * @since 2.0 * diff --git a/inc/FSclIAddressbookEventListener.h b/inc/FSclIAddressbookEventListener.h index 4715316..4b62979 100644 --- a/inc/FSclIAddressbookEventListener.h +++ b/inc/FSclIAddressbookEventListener.h @@ -88,7 +88,7 @@ public: /** * Called to notify when categories are changed. @n - * A list of CategoryChangeInfo instances are passed. + * A list of CategoryChangeInfo instances is passed. * * @since 2.0 * diff --git a/inc/FSclOrganization.h b/inc/FSclOrganization.h index 1f5088e..f792f19 100644 --- a/inc/FSclOrganization.h +++ b/inc/FSclOrganization.h @@ -143,7 +143,7 @@ public: * * @since 2.1 * - * @return The type of the organization + * @return The organization type */ OrganizationType GetType(void) const; @@ -188,7 +188,7 @@ public: * * @since 2.1 * - * @return The file path of the logo image + * @return The logo image file path */ Tizen::Base::String GetLogoPath(void) const; @@ -242,7 +242,7 @@ public: * * @since 2.1 * - * @param[in] type The type of the organization + * @param[in] type The organization type */ void SetType(OrganizationType type); @@ -283,8 +283,8 @@ public: void SetPhoneticName(const Tizen::Base::String& phoneticName); /** - * Sets the logo image. - * If the specified filePath is an empty string, the current logo image is removed. + * Sets the logo image. @n + * If the specified @c filePath is an empty string, the current logo image is removed. * * @since 2.1 * @@ -294,7 +294,7 @@ public: * @exception E_FILE_NOT_FOUND The specified file cannot be found or accessed. * @exception E_SYSTEM The method cannot proceed due to a severe system error. * @remarks The logo image is copied to the specific directory for logo images by the system when the contact is added or updated. - * Therefore, GetLogoPath() returns the file path to which the logo image copied. + * Therefore, GetLogoPath() returns the file path to which the logo image is copied. */ result SetLogo(const Tizen::Base::String& filePath); diff --git a/inc/FSclPhoneNumber.h b/inc/FSclPhoneNumber.h index 789e598..9ea4b01 100644 --- a/inc/FSclPhoneNumber.h +++ b/inc/FSclPhoneNumber.h @@ -126,32 +126,32 @@ public: virtual int GetHashCode(void) const; /** - * Gets the type of the phone number. - * + * Gets the type of the phone number. + * * @if OSPCOMPAT - * @brief [Compatibility] + * @brief [Compatibility] * @endif - * @since 2.0 + * @since 2.0 * @if OSPCOMPAT * @compatibility This method has compatibility issues with OSP compatible applications. @n - * For more information, see @ref CompPhoneNumberGetTypePage "here". + * For more information, see @ref CompPhoneNumberGetTypePage "here". * @endif - * - * @return The type of the phone number - */ + * + * @return The type of the phone number + */ PhoneNumberType GetType(void) const; /** * @if OSPCOMPAT - * @page CompPhoneNumberGetTypePage Compatibility for GetType() - * @section CompPhoneNumberGetTypePageIssueSection Issues + * @page CompPhoneNumberGetTypePage Compatibility for GetType() + * @section CompPhoneNumberGetTypePageIssueSection Issues * Implementing this method in OSP compatible applications has the following issue: @n - * -# PHONENUMBER_TYPE_CUSTOM is not supported. If the type of the phone number is PHONENUMBER_TYPE_CUSTOM, PHONENUMBER_TYPE_OTHER is returned instead. - * - * @section CompPhoneNumberGetTypePageSolutionSection Resolutions + * -# PHONENUMBER_TYPE_CUSTOM is not supported. If the type of the phone number is PHONENUMBER_TYPE_CUSTOM, PHONENUMBER_TYPE_OTHER is returned instead. + * + * @section CompPhoneNumberGetTypePageSolutionSection Resolutions * The issue mentioned above has been resolved in Tizen. * @endif - */ + */ /** * Gets the phone number. diff --git a/inc/FSclUserProfile.h b/inc/FSclUserProfile.h index 2b36bd9..8c09cda 100644 --- a/inc/FSclUserProfile.h +++ b/inc/FSclUserProfile.h @@ -57,7 +57,7 @@ class Relationship; * * @final This class is not intended for extension. * - * The %UserProfile class provides the contact information the owner of the addressbook + * The %UserProfile class provides the contact information of the owner of an addressbook. * * */ @@ -111,11 +111,11 @@ public: virtual int GetHashCode(void) const; /** - * Gets the thumbnail path + * Gets the thumbnail file path. * * @since 2.1 * - * @return The file path of the thumbnail + * @return The file path of a thumbnail * @remarks If the thumbnail has not been set, an empty string is returned. */ Tizen::Base::String GetThumbnailPath(void) const; @@ -137,11 +137,11 @@ public: result SetThumbnail(const Tizen::Base::String& filePath); /** - * Sets the value of the property having the specified ID to the specified value. + * Sets the value of the property having a specified ID to the specified @c value. * * * @return An error code - * @param[in] id The ID of the property whose value is to set + * @param[in] id The ID of the property whose value is set * @param[in] value A new string value to set * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified property is read-only. @@ -150,7 +150,7 @@ public: result SetValue(UserProfilePropertyId id, const Tizen::Base::String& value); /** - * Gets the value of the specified property. + * Gets the value of a specified property. * * @since 2.1 * @@ -160,13 +160,13 @@ public: Tizen::Base::String GetValue(UserProfilePropertyId id) const; /** - * Sets the specified phone number at the specified index. + * Sets a specified phone number at the specified @c index. * * @since 2.1 * * @return An error code - * @param[in] index An index to set the value - * @param[in] phoneNumber An instance of PhoneNumber to set. + * @param[in] index An index at which the value is set + * @param[in] phoneNumber An instance of PhoneNumber to set * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified @c phoneNumber is empty. * @exception E_OUT_OF_RANGE The specified @c index is outside the bounds of the properties. @@ -174,12 +174,12 @@ public: result SetPhoneNumberAt(int index, const PhoneNumber& phoneNumber); /** - * Sets the specified email corresponding to the specified index. + * Sets the specified @c email corresponding to the specified @c index. * * @since 2.1 * * @return An error code - * @param[in] index An index to set the value + * @param[in] index An index at which the value is set * @param[in] email An instance of Email * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified @c email is empty. @@ -188,12 +188,12 @@ public: result SetEmailAt(int index, const Email& email); /** - * Sets the specified URL corresponding to the specified index. + * Sets a specified URL corresponding to the specified @c index. * * @since 2.1 * * @return An error code - * @param[in] index An index to set the value + * @param[in] index An index at which the value is set * @param[in] url An instance of Url * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified @c url is empty. @@ -202,12 +202,12 @@ public: result SetUrlAt(int index, const Url& url); /** - * Sets the specified address corresponding to the specified index. + * Sets the specified @c address corresponding to the specified @c index. * * @since 2.1 * * @return An error code - * @param[in] index An index to set the value + * @param[in] index An index at which the value is set * @param[in] address An instance of Address * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified @c address is empty. @@ -216,12 +216,12 @@ public: result SetAddressAt(int index, const Address& address); /** - * Sets the specified ImAddress corresponding to the specified index. + * Sets the specified @c imAddress corresponding to the specified @c index. * * @since 2.1 * * @return An error code - * @param[in] index An index to set the value + * @param[in] index An index at which the value is set * @param[in] imAddress An instance of ImAddress * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified @c imAddress is empty. @@ -230,12 +230,12 @@ public: result SetImAddressAt(int index, const ImAddress& imAddress); /** - * Sets the specified note corresponding to the specified index. + * Sets the specified @c note corresponding to the specified @c index. * * @since 2.1 * * @return An error code - * @param[in] index An index to set the value + * @param[in] index An index at which the value is set * @param[in] note The note to set * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified @c note is empty. @@ -244,12 +244,12 @@ public: result SetNoteAt(int index, const Tizen::Base::String& note); /** - * Sets the specified nick name corresponding to the specified index. + * Sets a specified nick name corresponding to the specified @c index. * * @since 2.1 * * @return An error code - * @param[in] index An index to set the value + * @param[in] index An index at which the value is set * @param[in] nickname The nick name to set * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_RANGE The specified @c index is outside the bounds of the properties. @@ -257,12 +257,12 @@ public: result SetNicknameAt(int index, const Tizen::Base::String& nickname); /** - * Sets the specified event corresponding to the specified index. + * Sets the specified @c event corresponding to the specified @c index. * * @since 2.1 * * @return An error code - * @param[in] index An index to set the value + * @param[in] index An index at which the value is set * @param[in] event The event to set * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified @c event is empty. @@ -271,12 +271,12 @@ public: result SetEventAt(int index, const ContactEvent& event); /** - * Sets the specified organization corresponding to the specified index. + * Sets the specified organization corresponding to the specified @c index. * * @since 2.1 * * @return An error code - * @param[in] index An index to set the value + * @param[in] index An index at which the value is set * @param[in] organization The organization to set * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified @c organization is empty. @@ -285,13 +285,13 @@ public: result SetOrganizationAt(int index, const Organization& organization); /** - * Sets the specified relationship corresponding to the specified index. + * Sets the specified @c relationship corresponding to the specified @c index. * * @since 2.1 * * @return An error code - * @param[in] index An index to set the value - * @param[in] relationship An instance of Relationship to set. + * @param[in] index An index at which the value is set + * @param[in] relationship An instance of Relationship to set * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified @c relationship is empty. * @exception E_OUT_OF_RANGE The specified @c index is outside the bounds of the properties. @@ -308,7 +308,7 @@ public: AddressbookId GetAddressbookId(void) const; /** - * Gets a list of the values belonging to the specific multi value property. + * Gets a list of the values belonging to a specific multi value property. * * @since 2.1 * @@ -321,7 +321,7 @@ public: Tizen::Base::Collection::IList* GetValuesN(UserProfileMultiPropertyId id) const; /** - * Adds the specified phone number to the user profile.. + * Adds a specified phone number to the user profile. * * @since 2.1 * @@ -333,19 +333,19 @@ public: result AddPhoneNumber(const PhoneNumber& phoneNumber); /** - * Adds the specified email to the user profile.. + * Adds the specified @c email to the user profile. * * @since 2.1 * * @return An error code - * @param[in] email The mail address to add + * @param[in] email The email address to add * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified @c email is empty. */ result AddEmail(const Email& email); /** - * Adds the specified URL to the user profile.. + * Adds a specified URL to the user profile. * * @since 2.1 * @@ -358,7 +358,7 @@ public: result AddUrl(const Url& url); /** - * Adds the specified address to the user profile. + * Adds the specified @c address to the user profile. * * @since 2.1 * @@ -370,7 +370,7 @@ public: result AddAddress(const Address& address); /** - * Adds the specified instant message information to the user profile. + * Adds a specified instant message information to the user profile. * * @since 2.1 * @@ -382,7 +382,7 @@ public: result AddImAddress(const ImAddress& imAddress); /** - * Adds the specified note to the user profile. + * Adds the specified @c note to the user profile. * * @since 2.1 * @@ -394,7 +394,7 @@ public: result AddNote(const Tizen::Base::String& note); /** - * Adds the specified nick name to the user profile. + * Adds a specified nick name to the user profile. * * @since 2.1 * @@ -406,7 +406,7 @@ public: result AddNickname(const Tizen::Base::String& nickname); /** - * Adds the specified event to the user profile.. + * Adds the specified @c event to the user profile. * * @since 2.1 * @@ -418,7 +418,7 @@ public: result AddEvent(const ContactEvent& event); /** - * Adds the specified organization to the contact. + * Adds the specified @c organization to a contact. * * @since 2.1 * @@ -430,7 +430,7 @@ public: result AddOrganization(const Organization& organization); /** - * Adds the specified relationship to the user profile. + * Adds the specified @c relationship to the user profile. * * @since 2.1 * @@ -442,13 +442,13 @@ public: result AddRelationship(const Relationship& relationship); /** - * Removes the specific value at the specified index of the multi value property. + * Removes a specific value at the specified @c index of a multi value property. * * @since 2.1 * * @return An error code * @param[in] id A property ID - * @param[in] index The index of the value to remove + * @param[in] index The index at which the value is removed * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_RANGE The specified @c index is outside the bounds of the properties. */ @@ -459,7 +459,7 @@ public: * * @since 2.1 * - * @param[in] rhs An instance of %Contact + * @param[in] rhs An instance of %UserProfile */ UserProfile& operator =(const UserProfile& rhs); -- 2.7.4