update header for Doxygen

Change-Id: Idec02cf8b857ea7eefcc0989f6ab0572a31a52b7

diff --git a/inc/FSclAddressbook.h b/inc/FSclAddressbook.h
index 7613c0a..4b640ed 100644 (file)
--- a/inc/FSclAddressbook.h
+++ b/inc/FSclAddressbook.h
@@ -291,7 +291,7 @@ public:
 
        /**
         * @if OSPDEPREC
-        * Initializes this instance of %Addressbook with the specified listener.
+        * Initializes this instance of %Addressbook with a specified listener.
         *
         * @brief <i> [Deprecated] </i>
         * @deprecated This method and IRecordEventListener are deprecated. Instead of using this method, use AddressbookManager::GetAddressbookN() and SetEventListener().
@@ -408,7 +408,7 @@ public:
        result RemoveContact(RecordId contactId);
 
        /**
-        * Updates the specified contact. @n
+        * Updates a specified contact. @n
         * At least one property of the contact must have been set.
         *
         * @since       2.0
@@ -573,7 +573,7 @@ public:
        Tizen::Base::Collection::IList* GetAllContactsN(void) const;
 
        /**
-        * Gets the member contacts of the specified category. @n
+        * Gets the member contacts of a specified category. @n
         * If the specified @c category is INVALID_RECORD_ID, this method returns the list of contacts that are not member of any category.
         * The contacts are ordered by display name.
         *
@@ -581,7 +581,7 @@ public:
         * @privlevel   public
         * @privilege   %http://tizen.org/privilege/contact.read
         *
-        * @return      A list of contacts that are members of the specified category, @n
+        * @return      A list of contacts that are members of a specified category, @n
         *                                  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.
@@ -599,14 +599,14 @@ public:
        Tizen::Base::Collection::IList* GetContactsByCategoryN(RecordId categoryId) const;
 
        /**
-        * Gets contacts in the specified range in the address book. @n
+        * Gets contacts in a specified range in the address book. @n
         * The contacts are ordered by display name.
         *
         * @since       2.0
         * @privlevel   public
         * @privilege   %http://tizen.org/privilege/contact.read
         *
-        * @return      A list of contacts in the specified range, @n
+        * @return      A list of contacts in a specified range, @n
         *                              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.
@@ -628,14 +628,14 @@ public:
        Tizen::Base::Collection::IList* GetContactsN(int pageNo, int countPerPage) const;
 
        /**
-        * Gets contacts that are in the specified range of the specified category. @n
+        * Gets contacts that are in the specified range of a specified category. @n
         * The contacts are ordered by display name.
         *
         * @since       2.0
         * @privlevel   public
         * @privilege   %http://tizen.org/privilege/contact.read
         *
-        * @return      A list of contacts in the specified range of the specified category, @n
+        * @return      A list of contacts in the specified range of a specified category, @n
         *                              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
@@ -657,7 +657,7 @@ public:
        Tizen::Base::Collection::IList* GetContactsInN(const Category& category, int pageNo, int countPerPage) const;
 
        /**
-        * Gets the contact with the specified contact ID.
+        * Gets the contact with a specified contact ID.
         *
         * @since       2.0
         * @privlevel   public
@@ -694,7 +694,7 @@ public:
        int GetContactCount(void) const;
 
        /**
-        * Adds the specified contact to the specified category.
+        * Adds a specified contact to a specified category.
         *
         * @since       2.0
         * @privlevel   public
@@ -713,7 +713,7 @@ public:
        result AddMemberToCategory(RecordId categoryId, RecordId contactId);
 
        /**
-        * Removes the specified contact from the specified category.
+        * Removes a specified contact from a specified category.
         *
         * @since       2.0
         * @privlevel   public
@@ -757,7 +757,7 @@ public:
         * @privlevel   public
         * @privilege   %http://tizen.org/privilege/contact.read
         *
-        * @return              A list of categories that has the specified contact as a member, @n
+        * @return              A list of categories that has a specified contact as a member, @n
         *                                  else an empty list if there is no category, or @c null if an exception occurs (@ref Category list)
         * @param[in] contactId         The contact ID
         * @exception   E_SUCCESS               The method is successful.
@@ -787,7 +787,7 @@ public:
        int GetCategoryCount(void) const;
 
        /**
-        * Gets the category with the specified category ID.
+        * Gets the category with a specified category ID.
         *
         * @since       2.0
         * @privlevel   public
@@ -902,7 +902,7 @@ public:
        int GetLatestVersion(void) const;
 
        /**
-        * Gets the change information of the contacts that have been changed after the specified change version. @n
+        * Gets the change information of the contacts that have been changed after a specified change version. @n
         *
         * @brief <i> [Deprecated] </i>
         * @deprecated This method is deprecated. Instead of using this method, use GetChangedContactInfoListN().
@@ -946,7 +946,7 @@ public:
        Tizen::Base::Collection::IList* GetChangedContactsAfterN(int version, int& latestVersion) const;
 
        /**
-        * Gets the change information of the contacts that have been changed after the specified change version. @n
+        * Gets the change information of the contacts that have been changed after a specified change version.
         *
         * @since       2.1
         * @privlevel   public
@@ -987,7 +987,7 @@ 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 a specified version.
         *
        * @brief <i> [Deprecated] </i>
        * @deprecated This method is deprecated. Instead of using this method, use GetChangedCategoryInfoListN().
@@ -1032,7 +1032,7 @@ public:
        Tizen::Base::Collection::IList* GetChangedCategoriesAfterN(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 a specified version.
         *
         * @since       2.1
         * @privlevel   public
@@ -1108,8 +1108,8 @@ public:
        UserProfile* GetUserProfileN(void) const;
 
        /**
-        * Checks whether the user profile of this address book has been changed after the specified version or not.
-        * If the user profile does not exist, this method returns false.
+        * Checks whether the user profile of this address book has been changed after a specified version or not.
+        * If the user profile does not exist, this method returns @c false.
         *
         * @since       2.1
         * @privlevel           public
@@ -1117,7 +1117,7 @@ public:
         *
         * @return     @c true if the user profile has been changed, @n
         *              else @c false
-        * @param[in]   version                  The change version
+        * @param[in]   version                  The changed version
         * @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.

diff --git a/inc/FSclAddressbookManager.h b/inc/FSclAddressbookManager.h
index 1aaf3ae..b6bd131 100644 (file)
--- a/inc/FSclAddressbookManager.h
+++ b/inc/FSclAddressbookManager.h
@@ -64,9 +64,9 @@ class _OSP_EXPORT_ AddressbookManager
 {
 public:
        /**
-        * Creates an addressbook with the specified account ID and name. @n
-        * The accountId must specify a valid account and only one addressbook can be created per a account. @n
-        * The name of the addressbook must be specified and the name must be unique among the addressbooks on the device.
+        * Creates an addressbook with a specified account ID and name. @n
+        * The accountId must specify a valid account and only one addressbook can be created per account. @n
+        * The name of the addressbook must be specified and the name must be unique among existing addressbooks on the device.
         *
         * @since       2.0
         * @privlevel   public

diff --git a/inc/FSclContact.h b/inc/FSclContact.h
index 11281eb..00a72d2 100644 (file)
--- a/inc/FSclContact.h
+++ b/inc/FSclContact.h
@@ -228,7 +228,7 @@ public:
         *              - The #CONTACT_PROPERTY_ID_DISPLAY_NAME property cannot be set. @n
         *              - The #CONTACT_PROPERTY_ID_RINGTONE can be set to the path string of the ringtone file. @n
         * @if OSPDEPREC
-        *              - The The #CONTACT_PROPERTY_ID_THUMBNAIL property cannot be set. @n
+        *              - The #CONTACT_PROPERTY_ID_THUMBNAIL property cannot be set. @n
         *              - In case @c id is set to #CONTACT_PROPERTY_ID_NICK_NAME, @n
         *                              - If this contact has nicknames, the first nickname among them is set to the @c value. @n
         *                              - If not, a new nickname is added to this contact. @n
@@ -637,7 +637,7 @@ public:
        bool IsFavorite(void) const;
 
        /**
-        * Sets whether this contact is a favorite or not.
+        * Sets or unsets a contact as a favorite.
         *
         * @since       2.1
         * @see IsFavorite()

diff --git a/inc/FSclIAddressbookChangeEventListener.h b/inc/FSclIAddressbookChangeEventListener.h
index 5242cec..41e0137 100644 (file)
--- a/inc/FSclIAddressbookChangeEventListener.h
+++ b/inc/FSclIAddressbookChangeEventListener.h
@@ -47,7 +47,8 @@ class _OSP_EXPORT_ IAddressbookChangeEventListener
 {
 public:
        /**
-        * This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes @n
+        * This polymorphic destructor should be overridden if required. @n
+        * This way, the destructors of the derived classes 
         * are called when the destructor of this interface is called.
         *
         * @since       2.1
@@ -55,7 +56,7 @@ public:
        virtual ~IAddressbookChangeEventListener(void) {}
 
        /**
-        * Called to notify when contacts are changed. @n
+        * Called to notify when changes have been made to contacts. @n
         * A list of ContactChangeInfo instances is passed.
         *
         * @since       2.1
@@ -86,7 +87,7 @@ public:
        virtual void OnContactsChanged(const Tizen::Base::Collection::IList& contactChangeInfoList) = 0;
 
        /**
-        * Called to notify when categories are changed. @n
+        * Called to notify when changes have been made to categories. @n
         * A list of CategoryChangeInfo instances are passed.
         *
         * @since       2.1