summaryrefslogtreecommitdiff
path: root/inc
diff options
context:
space:
mode:
authorHosang Kim <hosang.kim@samsung.com>2013-03-28 17:14:34 +0900
committerGerrit Code Review <gerrit2@kim11>2013-03-28 17:14:34 +0900
commit69387fa3cf384e7ec06c9ddc52fbba7e81fcc3ce (patch)
tree567be555fbf3e00049aa65c88855693bde1684b0 /inc
parentf8d7d6a09c5df13ba6ee1bee32e24cf948bb72cc (diff)
parentfa92f42e53e1511d11b04d9c27635e9bed501274 (diff)
downloadsocial-69387fa3cf384e7ec06c9ddc52fbba7e81fcc3ce.tar.gz
social-69387fa3cf384e7ec06c9ddc52fbba7e81fcc3ce.tar.bz2
social-69387fa3cf384e7ec06c9ddc52fbba7e81fcc3ce.zip
Merge "Merge reviewed headers" into tizen_2.1
Diffstat (limited to 'inc')
-rw-r--r--inc/FSclAccount.h20
-rw-r--r--inc/FSclAccountAccessor.h29
-rw-r--r--inc/FSclAccountManager.h30
-rw-r--r--inc/FSclAccountProvider.h18
-rw-r--r--inc/FSclAddress.h6
-rw-r--r--inc/FSclAttendee.h8
-rw-r--r--inc/FSclCalEvent.h38
-rw-r--r--inc/FSclCalTodo.h12
-rw-r--r--inc/FSclCalendarbook.h38
-rw-r--r--inc/FSclCalendarbookFilter.h12
-rw-r--r--inc/FSclIRecordListener.h2
-rw-r--r--inc/FSclRecord.h2
-rw-r--r--inc/FSclRecurrence.h8
-rw-r--r--inc/FSclReminder.h36
-rw-r--r--inc/FSclTypes.h92
15 files changed, 179 insertions, 172 deletions
diff --git a/inc/FSclAccount.h b/inc/FSclAccount.h
index f1363e0..310bc8e 100644
--- a/inc/FSclAccount.h
+++ b/inc/FSclAccount.h
@@ -46,6 +46,8 @@ class AccountProvider;
* @since 2.1
*
* @final This class is not intended for extension.
+ *
+ * This %Account class represents the account information.
*/
class _OSP_EXPORT_ Account
: public Tizen::Base::Object
@@ -57,7 +59,7 @@ public:
*
* @since 2.1
*
- * @param[in] rhs The user name
+ * @param[in] userName The user name
*/
Account(const Tizen::Base::String& userName);
@@ -82,7 +84,7 @@ public:
*
* @since 2.1
*
- * @return @c true if the value of the specified instance of Object is equal to the value of the current instance, @n
+ * @return @c true if the value of the specified instance of Tizen::Base::Object is equal to the value of the current instance, @n
* else @c false
* @param[in] rhs An instance to compare
*/
@@ -98,7 +100,7 @@ public:
virtual int GetHashCode(void) const;
/**
- * Gets the ID of this account. @n
+ * Gets the ID of an account.
*
* @since 2.1
*
@@ -107,7 +109,7 @@ public:
AccountId GetId(void) const;
/**
- * Gets the account provider. @n
+ * Gets the account provider.
*
* @since 2.1
*
@@ -116,7 +118,7 @@ public:
AccountProvider GetAccountProvider(void) const;
/**
- * Gets the user name. @n
+ * Gets the user name.
*
* @since 2.1
*
@@ -125,18 +127,18 @@ public:
Tizen::Base::String GetUserName(void) const;
/**
- * Gets the extended data. @n
+ * Gets the extended data.
*
* @since 2.1
*
- * @return The key-value lists of the extended data
+ * @return The key-value lists of the extended data, @n
* else an empty list if there is no extended data, or @c null if an exception occurs (@ref String, @ref String list)
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
Tizen::Base::Collection::IMap* GetExtendedDataN(void) const;
/**
- * Sets the user name. @n
+ * Sets the user name.
*
* @since 2.1
*
@@ -149,7 +151,7 @@ public:
/**
* Sets the extended data with the specified @c key and @c value. @n
- * If the specified @c key already exists, the corresponding value is overwritten as the specified @c value.
+ * If the specified @c key already exists, the corresponding value is overwritten with the specified @c value.
*
* @since 2.1
*
diff --git a/inc/FSclAccountAccessor.h b/inc/FSclAccountAccessor.h
index d92a91d..cbc0092 100644
--- a/inc/FSclAccountAccessor.h
+++ b/inc/FSclAccountAccessor.h
@@ -46,18 +46,19 @@ class IAccountEventListener;
/**
* @class AccountAccessor
- * @brief This class provides the method for the account management.
+ * @brief This class provides methods for accessing accounts and account providers.
* @since 2.1
*
* @final This class is not intended for extension.
+ *
+ * This %AccountAccessor class provides methods for accessing accounts and account providers.
*/
class _OSP_EXPORT_ AccountAccessor
: public Tizen::Base::Object
{
public:
/**
- * Sets an account change event listener. @n
- * The listener is called when an account is changed.
+ * Sets an account change event listener that is called when an account is changed. @n
* To reset the event listener, @c null must be passed.
*
* @since 2.1
@@ -74,7 +75,7 @@ public:
result SetEventListener(IAccountEventListener* pListener);
/**
- * Gets an account with the specified account ID. @n
+ * Gets an account with a specified account ID.
*
* @since 2.1
* @privlevel public
@@ -92,7 +93,7 @@ public:
Account GetAccount(AccountId accountId) const;
/**
- * Gets accounts associated with the account provider which has the specified application ID. @n
+ * Gets accounts associated with the account provider that has a specified application ID.
*
* @since 2.1
* @privlevel public
@@ -110,7 +111,7 @@ public:
Tizen::Base::Collection::IList* GetAccountsByAccountProviderN(const Tizen::App::AppId& accountProviderAppId) const;
/**
- * Gets all accounts. @n
+ * Gets all accounts.
*
* @since 2.1
* @privlevel public
@@ -126,13 +127,13 @@ public:
Tizen::Base::Collection::IList* GetAllAccountsN(void) const;
/**
- * Gets an account provider with the specified application ID. @n
+ * Gets an account provider with a specified application ID.
*
* @since 2.1
* @privlevel public
* @privilege %http://tizen.org/privilege/account.read
*
- * @return An account provider with the specified @c accountProviderAppId
+ * @return An 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.
@@ -144,7 +145,7 @@ public:
AccountProvider GetAccountProvider(const Tizen::App::AppId& accountProviderAppId) const;
/**
- * Gets account providers which has the specified capability. @n
+ * Gets account providers that have the specified @c capability.
*
* @since 2.1
* @privlevel public
@@ -162,7 +163,7 @@ public:
Tizen::Base::Collection::IList* GetAccountProvidersByCapabilityN(const Tizen::Base::String& capability) const;
/**
- * Gets all currently registered account providers. @n
+ * Gets all currently registered account providers.
*
* @since 2.1
* @privlevel public
@@ -178,7 +179,7 @@ public:
Tizen::Base::Collection::IList* GetAllAccountProvidersN(void) const;
/**
- * Gets the account accessor instance.
+ * Gets the %AccountAccessor instance.
*
* @since 2.1
*
@@ -218,7 +219,7 @@ private:
AccountAccessor& operator =(const AccountAccessor& rhs);
//
- // Constructs the instance of this class.
+ // Constructs an instance of this class.
//
// @since 2.1
//
@@ -229,14 +230,14 @@ private:
result Construct(void);
//
- // Initializes the instance of this class.
+ // Initializes an instance of this class.
//
// @since 2.1
//
static void InitAccountAccessor(void);
//
- // Destroys the instance of this class.
+ // Destroys an instance of this class.
//
// @since 2.1
//
diff --git a/inc/FSclAccountManager.h b/inc/FSclAccountManager.h
index 1983ee3..4ee5018 100644
--- a/inc/FSclAccountManager.h
+++ b/inc/FSclAccountManager.h
@@ -44,10 +44,12 @@ class AccountProvider;
/**
* @class AccountManager
- * @brief This class provides the method for the account management.
+ * @brief This class provides the method for managing accounts.
* @since 2.1
*
* @final This class is not intended for extension.
+ *
+ * The %AccountManager class provides the method for managing accounts.
*/
class _OSP_EXPORT_ AccountManager
: public Tizen::Base::Object
@@ -55,9 +57,9 @@ class _OSP_EXPORT_ AccountManager
public:
/**
* Adds an account. @n
- * The user name must have been set in the account.
+ * The user name must be set in the account.
* If the account is added successfully, an account ID is newly assigned to it.
- * This method can be used only by the application belonging to the package of the application which registers its own account provider.
+ * The %AddAccount() method can be used only by the application belonging to a package of an application that registers its own account provider.
*
* @since 2.1
* @privlevel public
@@ -71,15 +73,15 @@ public:
* - The user name is an empty string in the specified @c account. @n
* - The account ID is not #INVALID_ACCOUNT_ID. @n
* @exception E_INVALID_OPERATION Either of the following conditions has occurred: @n
- * - The caller application does not belong to the package of the application which registers its own account provider. @n
- * - The multiple accounts support is set to false and the account is already added. @n
+ * - The caller application does not belong to a package of an application that registers its own account provider. @n
+ * - The account has already been added with the multiple accounts support set to @c false.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
*/
result AddAccount(Account& account);
/**
* Removes an account. @n
- * This method can be used only by the application belonging to the package of the application which registers its own account provider.
+ * The %RemoveAccount() method can be used only by an application belonging to a package of an application that registers its own account provider.
*
* @since 2.1
* @privlevel public
@@ -91,15 +93,15 @@ public:
* @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 does not exist.
- * @exception E_INVALID_OPERATION This operation is not allowed if the caller application does not belong to the package of the application which registers its own account provider.
+ * @exception E_INVALID_OPERATION This operation is not allowed if the caller application does not belong to a package of an application that registers its own account provider.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
*/
result RemoveAccount(AccountId accountId);
/**
* Updates an account. @n
- * The user name must have been set in the account.
- * This method can be used only by the application belonging to the package of the application which registers its own account provider.
+ * The user name must be set in an account.
+ * The %UpdateAccount() method can be used only by an application belonging to a package of an application that registers its own account provider.
*
* @since 2.1
* @privlevel public
@@ -113,13 +115,13 @@ public:
* - The user name is an empty string in the specified @c account. @n
* - The account ID is invalid. @n
* @exception E_OBJ_NOT_FOUND The specified @c account does not exist.
- * @exception E_INVALID_OPERATION This operation is not allowed if the caller application does not belong to the package of the application which registers its own account provider.
+ * @exception E_INVALID_OPERATION This operation is not allowed if the caller application does not belong to a package of an application that registers its own account provider.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
*/
result UpdateAccount(const Account& account);
/**
- * Gets the account manager instance.
+ * Gets the %AccountManager instance.
*
* @since 2.1
*
@@ -159,7 +161,7 @@ private:
AccountManager& operator =(const AccountManager& rhs);
//
- // Constructs the instance of this class.
+ // Constructs an instance of this class.
//
// @since 2.1
//
@@ -170,14 +172,14 @@ private:
result Construct(void);
//
- // Initializes the instance of this class.
+ // Initializes an instance of this class.
//
// @since 2.1
//
static void InitAccountManager(void);
//
- // Destroys the instance of this class.
+ // Destroys an instance of this class.
//
// @since 2.1
//
diff --git a/inc/FSclAccountProvider.h b/inc/FSclAccountProvider.h
index 4d7597c..15ec41a 100644
--- a/inc/FSclAccountProvider.h
+++ b/inc/FSclAccountProvider.h
@@ -46,6 +46,8 @@ namespace Tizen { namespace Social
* @since 2.1
*
* @final This class is not intended for extension.
+ *
+ * The %AccountProvider class provides the account provider information.
*/
class _OSP_EXPORT_ AccountProvider
: public Tizen::Base::Object
@@ -80,7 +82,7 @@ public:
*
* @since 2.1
*
- * @return @c true if the value of the specified instance of Object is equal to the value of the current instance, @n
+ * @return @c true if the value of the specified instance of Tizen::Base::Object is equal to the value of the current instance, @n
* else @c false
* @param[in] rhs An instance to compare
*/
@@ -96,7 +98,7 @@ public:
virtual int GetHashCode(void) const;
/**
- * Gets the app ID of the application which has registered this account provider. @n
+ * Gets the app ID of the application that has registered this account provider.
*
* @since 2.1
*
@@ -105,7 +107,7 @@ public:
Tizen::App::AppId GetAppId(void) const;
/**
- * Gets the capabilities which the account provider owns.
+ * Gets a list of capabilities that an account provider owns.
*
* @since 2.1
*
@@ -116,7 +118,7 @@ public:
Tizen::Base::Collection::IList* GetCapabilitiesN(void) const;
/**
- * Gets the display name of the account provider. @n
+ * Gets the display name of an account provider.
*
* @since 2.1
*
@@ -125,7 +127,7 @@ public:
Tizen::Base::String GetDisplayName(void) const;
/**
- * Gets the icon path. @n
+ * Gets the icon path.
*
* @since 2.1
*
@@ -134,7 +136,7 @@ public:
Tizen::Base::String GetIconPath(void) const;
/**
- * Gets the small icon path. @n
+ * Gets the small icon path.
*
* @since 2.1
*
@@ -143,11 +145,11 @@ public:
Tizen::Base::String GetSmallIconPath(void) const;
/**
- * Checks whether the account provider supports the multiple accounts. @n
+ * Checks whether an account provider supports multiple accounts.
*
* @since 2.1
*
- * @return @c true if the account provider supports the multiple accounts, @n
+ * @return @c true if the account provider supports multiple accounts, @n
* else @c false
*/
bool IsMultipleAccountSupported(void) const;
diff --git a/inc/FSclAddress.h b/inc/FSclAddress.h
index b71e893..02ed278 100644
--- a/inc/FSclAddress.h
+++ b/inc/FSclAddress.h
@@ -316,9 +316,9 @@ public:
* For more information, see @ref CompAddressSetStreetPage "here".
* @endif
*
- * @return An error code
- * @param[in] street The new street value to set
- * @exception E_SUCCESS The method is successful.
+ * @return An error code
+ * @param[in] street The new street value to set
+ * @exception E_SUCCESS The method is successful.
*/
result SetStreet(const Tizen::Base::String& street);
diff --git a/inc/FSclAttendee.h b/inc/FSclAttendee.h
index 0328f1d..0e3a87c 100644
--- a/inc/FSclAttendee.h
+++ b/inc/FSclAttendee.h
@@ -153,11 +153,11 @@ public:
* @if OSPCOMPAT
* @page CompAttendeeSetNamePage Compatibility for SetName()
* @section CompAttendeeSetNamePageIssueSection Issues
- * Implementing this method in OSP compatible applications has the following issues: @n
+ * Implementing this method in OSP compatible applications has the following issues: @n
* -# If the length of the name to be set is greater than 100 characters, E_INVALID_ARG is returned.
*
* @section CompAttendeeSetNamePageSolutionSection Resolutions
- * This issue has been resolved in Tizen. @n
+ * This issue has been resolved in Tizen. @n
* -# There is no limit for the length of the name.
*
* @endif
@@ -187,11 +187,11 @@ public:
* @if OSPCOMPAT
* @page CompAttendeeSetEmailPage Compatibility for SetEmail()
* @section CompAttendeeSetEmailPageIssueSection Issues
- * Implementing this method in OSP compatible applications has the following issues: @n
+ * Implementing this method in OSP compatible applications has the following issues: @n
* -# If the length of the email to be set is greater than 320 characters, E_INVALID_ARG is returned.
*
* @section CompAttendeeSetEmailPageSolutionSection Resolutions
- * This issue has been resolved in Tizen. @n
+ * This issue has been resolved in Tizen. @n
* -# There is no limit for the length of the email.
* @endif
*/
diff --git a/inc/FSclCalEvent.h b/inc/FSclCalEvent.h
index 33c3882..f4a848f 100644
--- a/inc/FSclCalEvent.h
+++ b/inc/FSclCalEvent.h
@@ -135,7 +135,7 @@ public:
* @since 2.0
*
* @return @c true if the input object equals the calling %CalEvent instance, @n
- else @c false
+ * else @c false
* @param[in] rhs The object instance to compare with the calling object
* @see GetHashCode()
*/
@@ -224,7 +224,7 @@ public:
* UID: globally Unique Identifier (vCalendar 1.0)
*
* @brief <i> [Deprecated] </i>
- * @deprecated This method is deprecated because string value can’t be handled. @n
+ * @deprecated This method is deprecated because string value cannot be handled. @n
* Instead of using this method, it is recommended to use GetUid().
* @since 2.0
*
@@ -242,7 +242,7 @@ public:
* UID: globally Unique Identifier (vCalendar 1.0)
*
* @brief <i> [Deprecated] </i>
- * @deprecated This method is deprecated because string value can’t be handled. @n
+ * @deprecated This method is deprecated because string value cannot be handled. @n
* Instead of using this method, it is recommended to use SetUid().
* @since 2.0
*
@@ -358,11 +358,11 @@ public:
* @page CompCalEventAddAttendeePage Compatibility for AddAttendee()
* @section CompCalEventAddAttendeePageIssueSection Issues
* Implementation of this method in Tizen API versions prior to 2.1 has the following issue: @n
- * -# If the email of @c attendee is empty, the E_OBJ_ALREADY_EXIST is returned.
+ * -# If the email of @c attendee is empty, the @c E_OBJ_ALREADY_EXIST is returned.
*
* @section CompCalEventAddAttendeePageSolutionSection Resolutions
* The issue mentioned above is resolved in Tizen API version 2.1.
- * -# The E_INVALID_ARG will be returned, if the email of @c attendee is empty.
+ * -# If the email of @c attendee is empty, the @c E_INVALID_ARG is returned.
*/
/**
@@ -418,7 +418,7 @@ public:
/**
* @if OSPDEPREC
* Gets the recurrence ID. @n
- * This method works only for the %CalEvent instances.
+ * The %GetRecurrenceId() method works only for the %CalEvent instances.
*
* @brief <i> [Deprecated] </i>
* @deprecated This method is deprecated because %CalEvent class is not used for event instance any more. @n
@@ -558,11 +558,11 @@ public:
* @if OSPCOMPAT
* @page CompCalEventSetSubjectPage Compatibility for SetSubject()
* @section CompCalEventSetSubjectPageIssueSection Issues
- * Implementing this method in OSP compatible applications has the following issues: @n
+ * Implementing this method in OSP compatible applications has the following issues: @n
* -# If the length of the subject to be set is greater than 100 characters, E_INVALID_ARG is returned.
*
* @section CompCalEventSetSubjectPageSolutionSection Resolutions
- * This issue has been resolved in Tizen. @n
+ * This issue has been resolved in Tizen. @n
* -# There is no limit for the length of the subject.
* @endif
*/
@@ -589,11 +589,11 @@ public:
* @if OSPCOMPAT
* @page CompCalEventSetDescriptionPage Compatibility for SetDescription()
* @section CompCalEventSetDescriptionPageIssueSection Issues
- * Implementing this method in OSP compatible applications has the following issues: @n
+ * Implementing this method in OSP compatible applications has the following issues: @n
* -# If the length of the description to be set is greater than 1000 characters, E_INVALID_ARG is returned.
*
* @section CompCalEventSetDescriptionPageSolutionSection Resolutions
- * This issue has been resolved in Tizen. @n
+ * This issue has been resolved in Tizen. @n
* -# There is no limit for the length of the description.
* @endif
*/
@@ -613,7 +613,7 @@ public:
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG Either of the following conditions has occurred: @n
* - The specified @c endDateTime value is earlier than the specified @c startDateTime value.
- * - The @c startDateTime or @c endDateTime is not in a valid range. @n
+ * - The @c startDateTime or @c endDateTime is out of the valid range. @n
* The valid range of the date can be referenced from GetMaxDateTime() and GetMinDateTime().
* @exception E_INVALID_CONDITION The recurrence date is already set.
* @remarks The start and end time of all day events created from the base applications is the local time of the location where
@@ -647,11 +647,11 @@ public:
* @if OSPCOMPAT
* @page CompCalEventSetLocationPage Compatibility for SetLocation()
* @section CompCalEventSetLocationPageIssueSection Issues
- * Implementing this method in OSP compatible applications has the following issues: @n
+ * Implementing this method in OSP compatible applications has the following issues: @n
* -# If the length of the location to be set is greater than 100 characters, E_INVALID_ARG is returned.
*
* @section CompCalEventSetLocationPageSolutionSection Resolutions
- * This issue has been resolved in Tizen. @n
+ * This issue has been resolved in Tizen. @n
* -# There is no limit for the length of the location.
* @endif
*/
@@ -686,14 +686,14 @@ public:
* @if OSPCOMPAT
* @page CompCalEventSetCategoryPage Compatibility for SetCategory()
* @section CompCalEventSetCategoryPageIssueSection Issues
- * Implementing this method in OSP compatible applications has the following issues: @n
+ * Implementing this method in OSP compatible applications has the following issues: @n
*
- * -# When the anniversary category is set to the event, it's handled as all day event even though the all day event property is not set.
+ * -# When the anniversary category is set to the event, it is handled as all day event even though the all day event property is not set.
*
* @section CompCalEventSetCategoryPageSolutionSection Resolutions
*
- * This issue has been resolved in Tizen. @n
- * -# The category property is deprecated and it's not used any more.
+ * This issue has been resolved in Tizen. @n
+ * -# The category property is deprecated and it is not used any more.
* In Tizen, the all day event property will be set simultaneously when the anniversary category is set to the event.
* If an application tries to change the all day event property of the anniversary event to @c false, it will not be changed.
* @endif
@@ -812,12 +812,12 @@ public:
* @if OSPCOMPAT
* @page CompCalEventSetRecurrencePage Compatibility for SetRecurrence()
* @section CompCalEventSetRecurrencePageIssueSection Issues
- * Implementing this method in OSP compatible applications has the following issues: @n
+ * Implementing this method in OSP compatible applications has the following issues: @n
* - If the category is anniversary and the frequency of recurrence is not yearly, E_TYPE_MISMATCH exception is occurred. @n
* Yearly frequency is only accepted for anniversary category.
*
* @section CompCalEventSetRecurrencePageSolutionSection Resolutions
- * This issue has been resolved in Tizen. @n
+ * This issue has been resolved in Tizen. @n
* -# All recurrence frequency will be accepted because the category of event is not used any more.
* @endif
*/
diff --git a/inc/FSclCalTodo.h b/inc/FSclCalTodo.h
index edcc116..1e342de 100644
--- a/inc/FSclCalTodo.h
+++ b/inc/FSclCalTodo.h
@@ -214,11 +214,11 @@ public:
* @if OSPCOMPAT
* @page CompCalTodoSetSubjectPage Compatibility for SetSubject()
* @section CompCalTodoSetSubjectPageIssueSection Issues
- * Implementing this method in OSP compatible applications has the following issues: @n
+ * Implementing this method in OSP compatible applications has the following issues: @n
* -# If the length of the subject to be set is greater than 100 characters, E_INVALID_ARG is returned.
*
* @section CompCalTodoSetSubjectPageSolutionSection Resolutions
- * This issue has been resolved in Tizen. @n
+ * This issue has been resolved in Tizen. @n
* -# There is no limit for the length of the subject.
* @endif
*/
@@ -246,11 +246,11 @@ public:
* @if OSPCOMPAT
* @page CompCalTodoSetDescriptionPage Compatibility for SetDescription()
* @section CompCalTodoSetDescriptionPageIssueSection Issues
- * Implementing this method in OSP compatible applications has the following issues: @n
+ * Implementing this method in OSP compatible applications has the following issues: @n
* -# If the length of the description to be set is greater than 1000 characters, E_INVALID_ARG is returned.
*
* @section CompCalTodoSetDescriptionPageSolutionSection Resolutions
- * This issue has been resolved in Tizen. @n
+ * This issue has been resolved in Tizen. @n
* -# There is no limit for the length of the description.
* @endif
*/
@@ -288,12 +288,12 @@ public:
* @if OSPCOMPAT
* @page CompCalTodoSetStartAndDueDatePage Compatibility for SetStartAndDueDate()
* @section CompCalTodoSetStartAndDueDatePageIssueSection Issues
- * Implementing this method in OSP compatible applications has the following issues: @n
+ * Implementing this method in OSP compatible applications has the following issues: @n
* -# The start and due date cannot be unset. And if the SetStartAndDueDate() is not called, the default start and due date @n
* are set to the system time when the to-do is constructed.
*
* @section CompCalTodoSetStartAndDueDatePageSolutionSection Resolutions
- * This issue has been resolved in Tizen. @n
+ * This issue has been resolved in Tizen. @n
* -# The default start and due date of the to-do is unset.
* @endif
*/
diff --git a/inc/FSclCalendarbook.h b/inc/FSclCalendarbook.h
index 81188f9..5d0abfc 100644
--- a/inc/FSclCalendarbook.h
+++ b/inc/FSclCalendarbook.h
@@ -637,7 +637,7 @@ public:
* @exception E_INVALID_ARG Either of the following conditions has occurred: @n
* - The specified @c pageNo or @c countPerPage is less than @c 1. @n
* - The start time is later than the end date. @n
- * - The start or end time is not in a valid range. @n
+ * - The start or end time is out of the valid range. @n
* The valid range of the date can be referenced from GetMaxDateTime() and GetMinDateTime().
* @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.
@@ -649,12 +649,12 @@ public:
* @if OSPCOMPAT
* @page CompCalendarbookGetTodosNPage Compatibility for GetTodosN()
* @section CompCalendarbookGetTodosNPageIssueSection Issues
- * Implementing this method in OSP compatible applications has the following issues: @n
+ * Implementing this method in OSP compatible applications has the following issues: @n
* -# If the start date of a to-do is not in the time range of start/end parameters, @n
* the to-do is not retrieved even though the due date is in the time range.
*
* @section CompCalendarbookGetTodosNPageSolutionSection Resolutions
- * This issue has been resolved in Tizen. @n
+ * This issue has been resolved in Tizen. @n
* -# The to-do will be retrieved if the due date is in the range of start/end parameters.
* @endif
*/
@@ -688,7 +688,7 @@ public:
* @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: @n
* - The start time is later than the end date. @n
- * - The start or end time is not in a valid range. @n
+ * - The start or end time is out of the valid range. @n
* The valid range of the date can be referenced from GetMaxDateTime() and GetMinDateTime().
* @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.
@@ -699,12 +699,12 @@ public:
* @if OSPCOMPAT
* @page CompCalendarbookGetTodoCountPage Compatibility for GetTodoCount()
* @section CompCalendarbookGetTodoCountPageIssueSection Issues
- * Implementing this method in OSP compatible applications has the following issues: @n
+ * Implementing this method in OSP compatible applications has the following issues: @n
* -# If the start date of a to-do is not in the time range of start/end parameters, @n
* the to-do is not counted even though the due date is in the time range.
*
* @section CompCalendarbookGetTodoCountPageSolutionSection Resolutions
- * This issue has been resolved in Tizen. @n
+ * This issue has been resolved in Tizen. @n
* -# The to-do will be counted if the due date is in the range of start/end parameters.
* @endif
*/
@@ -722,7 +722,7 @@ public:
* @privilege %http://tizen.org/privilege/calendar.read
*
* @return A list containing all of the matched CalEvent instances, @n
- * else an empty list if there are no matched instances or @c null if an exception occurs @n
+ * else an empty list if there are no matched instances, or @c null if an exception occurs @n
* The results are listed in the following order: all day events, and other events. @n
* The results with the same property of all day event are ordered by their start time.
* @param[in] start The start of the time range
@@ -740,7 +740,7 @@ public:
* - The specified @c pageNo or @c countPerPage is less than @c 1. @n
* - The specified @c category is invalid. @n
* - The start time is later than the end date. @n
- * - The start or end time is not in a valid range. @n
+ * - The start or end time is out of the valid range. @n
* The valid range of the date can be referenced from GetMaxDateTime() and GetMinDateTime().
* @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.
@@ -784,7 +784,7 @@ public:
* - The specified @c pageNo or @c countPerPage is less than @c 1. @n
* - The specified @c category is invalid. @n
* - The start time is later than the end date. @n
- * - The start or end time is not in a valid range. @n
+ * - The start or end time is out of the valid range. @n
* The valid range of the date can be referenced from GetMaxDateTime() and GetMinDateTime().
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @remarks IRecordListener::OnRecordsReceivedN(), Calendarbook::GetEventInstancesN()
@@ -803,7 +803,7 @@ public:
* @privilege %http://tizen.org/privilege/calendar.read
*
* @return A list containing all the CalEvent instances, @n
- * else an empty list if there are no events or @c null if an exception occurs @n
+ * else an empty list if there are no events, or @c null if an exception occurs @n
* The results are listed in the order of their event ID.
* @exception E_SUCCESS The method is successful.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
@@ -823,7 +823,7 @@ public:
* @privilege %http://tizen.org/privilege/calendar.read
*
* @return A list containing all the CalTodo instances, @n
- * else an empty list if there are no to-dos or @c null if an exception occurs @n
+ * else an empty list if there are no to-dos, or @c null if an exception occurs @n
* The results are listed in the order of their to-do ID.
* @exception E_SUCCESS The method is successful.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
@@ -843,7 +843,7 @@ public:
* @privilege %http://tizen.org/privilege/calendar.read
*
* @return A list containing all the Calendar instances, @n
- * else an empty list if there are no calendars or @c null if an exception occurs @n
+ * else an empty list if there are no calendars, or @c null if an exception occurs @n
* The results are listed in the order of their calendar ID.
* @exception E_SUCCESS The method is successful.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
@@ -863,7 +863,7 @@ public:
* @privilege %http://tizen.org/privilege/calendar.read
*
* @return A list containing the CalEventChangeInfo instances, @n
- * else an empty list if there are no events or @c null if an exception occurs @n
+ * else an empty list if there are no events, or @c null if an exception occurs @n
* The results are listed in the order of their version.
* @param[in] version The version
* @param[out] latestVersion The latest change version among the changed events
@@ -886,7 +886,7 @@ public:
* @privilege %http://tizen.org/privilege/calendar.read
*
* @return A list containing the CalTodoChangeInfo instances, @n
- * else an empty list if there are no to-dos or @c null if an exception occurs @n
+ * else an empty list if there are no to-dos, or @c null if an exception occurs @n
* The results are listed in the order of their version.
* @param[in] version The version
* @param[out] latestVersion The latest change version among the changed to-dos
@@ -1100,7 +1100,7 @@ public:
* @privilege %http://tizen.org/privilege/calendar.read
*
* @return A list of searched results (the list of CalEvent, CalTodo, Calendar, or CalEventInstance), @n
- * else an empty list if there is no searched result or @c null if an exception occurs
+ * else an empty list if there is no searched result, or @c null if an exception occurs
* @param[in] filter The filter that specifies the search condition @n If the filter is empty, all items that are specified by the type of this filter will be searched.
* @param[in] propertySortedBy The property for sorting @n The searched results are ordered by the values of this property.
* @param[in] sortOrder The order for sorting
@@ -1141,12 +1141,12 @@ public:
/**
* Parses the events from specific vCalendar file. @n
- * This method supports to parse for vCalendar version 1.0 and 2.0 (iCalendar).
+ * The %ParseEventsFromVcalendarN() method supports to parse for vCalendar version 1.0 and 2.0 (iCalendar).
*
* @since 2.0
*
* @return A list containing the CalEvent instances, @n
- * else an empty list if there are no events or @c null if an exception occurs
+ * else an empty list if there are no events, or @c null if an exception occurs
* @param[in] vCalFilePath The path of the vCalendar file
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c vCalFilePath is invalid.
@@ -1162,12 +1162,12 @@ public:
/**
* Parses the to-dos from specific vCalendar file. @n
- * This method supports to parse for vCalendar version 1.0 and 2.0 (iCalendar).
+ * The %ParseTodosFromVcalendarN() method supports to parse for vCalendar version 1.0 and 2.0 (iCalendar).
*
* @since 2.0
*
* @return A list containing the CalTodo instances, @n
- * else an empty list if there are no to-dos or @c null if an exception occurs
+ * else an empty list if there are no to-dos, or @c null if an exception occurs
* @param[in] vCalFilePath The path of the vCalendar file
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c vCalFilePath is invalid.
diff --git a/inc/FSclCalendarbookFilter.h b/inc/FSclCalendarbookFilter.h
index 3a48081..d99a4d5 100644
--- a/inc/FSclCalendarbookFilter.h
+++ b/inc/FSclCalendarbookFilter.h
@@ -87,8 +87,8 @@ namespace Tizen { namespace Social
*
//search condition: (calendarId=3 OR calendarId=4) AND (subject LIKE '%meeting%')
CalendarbookFilter subFilter(CB_FILTER_TYPE_EVENT);
- subFilter.AppendInt(FI_CONJ_OP_NONE, EVENT_FI_PR_CALNEDAR_ID, FI_CMP_O_EQUAL, 3);
- subFilter.AppendInt(FI_CONJ_OP_OR, EVENT_FI_PR_CALNEDAR_ID, FI_CMP_OP_EQUAL, 4);
+ subFilter.AppendInt(FI_CONJ_OP_NONE, EVENT_FI_PR_CALENDAR_ID, FI_CMP_O_EQUAL, 3);
+ subFilter.AppendInt(FI_CONJ_OP_OR, EVENT_FI_PR_CALENDAR_ID, FI_CMP_OP_EQUAL, 4);
CalendarbookFilter mainFilter(CB_FI_TYPE_EVENT);
mainFilter.AppendFilter(FI_CONJ_OP_NONE, subFilter);
@@ -221,11 +221,11 @@ public:
* @param[in] comparisonOperator The comparison operator
* @param[in] value The Tizen::Base::DateTime 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 @c filterProperty is not for Tizen::Base::DateTime value. @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 @c filterProperty is not for Tizen::Base::DateTime value.
* - The specified @c conjunctiveOperator is invalid.
- * - The value is not in a valid range. @n
+ * - The specified @c value is out of the valid range.
*/
result AppendDateTime(FilterConjunctiveOperator conjunctiveOperator, unsigned long filterProperty, FilterComparisonOperator comparisonOperator, const Tizen::Base::DateTime& value);
diff --git a/inc/FSclIRecordListener.h b/inc/FSclIRecordListener.h
index a96b4be..5d06cfb 100644
--- a/inc/FSclIRecordListener.h
+++ b/inc/FSclIRecordListener.h
@@ -78,7 +78,7 @@ public:
* @param[in] reqId The request ID
* @param[in] pRecords The result of a specific asynchronous method @n
* A list containing all of the retrieved Record instances, @n
- * else an empty list if there are no retrieved records or @c null if an exception occurs
+ * else an empty list if there are no retrieved records, or @c null if an exception occurs
* @param[in] r The result of the request
* @exception E_SUCCESS The request is successful.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
diff --git a/inc/FSclRecord.h b/inc/FSclRecord.h
index 926af26..ad5889d 100644
--- a/inc/FSclRecord.h
+++ b/inc/FSclRecord.h
@@ -87,7 +87,7 @@ protected:
// This method is for internal use only. Using this method can cause behavioral, security-related,
// and consistency-related issues in the application.
//
- // Initializes this instance of %Record with the specified type.
+ // Initializes this instance of %Record with the specified @c type.
//
// @since 2.0
//
diff --git a/inc/FSclRecurrence.h b/inc/FSclRecurrence.h
index 1f263e9..60d4a5a 100644
--- a/inc/FSclRecurrence.h
+++ b/inc/FSclRecurrence.h
@@ -384,11 +384,11 @@ public:
* @if OSPCOMPAT
* @page CompRecurrenceSetIntervalPage Compatibility for SetInterval()
* @section CompRecurrenceSetIntervalPageIssueSection Issues
- * Implementing this method in OSP compatible applications has the following issues: @n
+ * Implementing this method in OSP compatible applications has the following issues: @n
* -# If the value of the interval to be set is greater than 255, E_INVALID_ARG is returned.
*
* @section CompRecurrenceSetIntervalPageSolutionSection Resolutions
- * This issue has been resolved in Tizen. @n
+ * This issue has been resolved in Tizen. @n
* -# There is no limit for the value of the interval.
* @endif
*/
@@ -402,7 +402,7 @@ public:
* @return An error code
* @param[in] pUntil The end date and time
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The @c pUntil is not in a valid range. @n
+ * @exception E_INVALID_ARG The specified @c pUntil is out of the valid range. @n
* The valid range of the date can be referenced from GetMaxDateTime() and GetMinDateTime().
* @remarks Either the until or count properties may be set. @n
* When the until property is set, the count property becomes @c 0. @n
@@ -511,7 +511,7 @@ public:
result SetMonthOfYear(int month);
/**
- * Adds an exception date to this event.
+ * Adds an exception date to this event. @n
* The instance that its start date and time matched with the exception date will be exclude from recurrence instances.
* If there are any changes in this recurrence, the exception dates would be cleared.
*
diff --git a/inc/FSclReminder.h b/inc/FSclReminder.h
index 494aa9f..35488e2 100644
--- a/inc/FSclReminder.h
+++ b/inc/FSclReminder.h
@@ -175,11 +175,11 @@ public:
* @param[in] timeOffset The reminder time offset
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG Either of the following conditions has occurred: @n
- * - The specified @c timeUnit is REMINDER_TIME_UNIT_NONE.
+ * - The specified @c timeUnit is @c REMINDER_TIME_UNIT_NONE.
* - The specified @c timeOffset is less than @c 0.
* @remarks The time offset and absolute time are mutually exclusive. @n
- * When the absolute time is set, the time unit and offset will be REMINDER_TIME_UNIT_NONE and @c 0. @n
- * When the time offset is set, the absolute time will be reset.
+ * When the absolute time is set, the time unit is @c REMINDER_TIME_UNIT_NONE and offset is @c 0. @n
+ * When the time offset is set, the absolute time is reset.
*/
result SetTimeOffset(ReminderTimeUnit timeUnit, int timeOffset);
@@ -188,8 +188,8 @@ public:
*
* @since 2.0
*
- * @return The reminder time unit
- * @c REMINDER_TIME_UNIT_NONE, if the absolute time has been set
+ * @return The reminder time unit, @n
+ * else @c REMINDER_TIME_UNIT_NONE if the absolute time is set
*/
ReminderTimeUnit GetTimeUnit(void) const;
@@ -198,13 +198,13 @@ public:
*
* @since 2.0
*
- * @return The reminder time offset
- * else @c 0 if the absolute time has been set
+ * @return The reminder time offset, @n
+ * else @c 0 if the absolute time is set
*/
int GetTimeOffset(void) const;
/**
- * Sets the reminder absolute time.
+ * Sets the reminder absolute time. @n
* The time is Coordinated Universal Time (UTC).
*
* @since 2.1
@@ -212,11 +212,11 @@ public:
* @return An error code
* @param[in] time The reminder absolute time
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The @c time is not in a valid range. @n
- * The valid range of the time can be referenced from GetMaxDateTime() and GetMinDateTime().
+ * @exception E_INVALID_ARG The specified @c time is out of the valid range. @n
+ * The valid range of the time can be referenced from Calendarbook::GetMaxDateTime() and Calendarbook::GetMinDateTime().
* @remarks The time offset and absolute time are mutually exclusive. @n
- * When the absolute time is set, the time unit and offset will be REMINDER_TIME_UNIT_NONE and @c 0. @n
- * When the time offset is set, the absolute time will be reset.
+ * When the absolute time is set, the time unit is @c REMINDER_TIME_UNIT_NONE and offset is @c 0. @n
+ * When the time offset is set, the absolute time is reset.
*/
result SetAbsoluteTime(const Tizen::Base::DateTime& time);
@@ -225,21 +225,21 @@ public:
*
* @since 2.1
*
- * @return The reminder absolute time
- * else the minimum value of DateTime if the absolute time has not been set
+ * @return The reminder absolute time, @n
+ * else the minimum value of Tizen::Base::DateTime if the absolute time is not set
*/
Tizen::Base::DateTime GetAbsoluteTime(void) const;
/**
- * Checks whether the absolute time is set. @n
+ * Checks whether the absolute time is set.
*
* @since 2.1
*
- * @return @c true if the absolute time has been set, @n
+ * @return @c true if the absolute time is set, @n
* else @c false
* @remarks The time offset and absolute time are mutually exclusive. @n
- * When the absolute time is set, the time unit and offset will be REMINDER_TIME_UNIT_NONE and @c 0. @n
- * When the time offset is set, the absolute time will be reset.
+ * When the absolute time is set, the time unit is @c REMINDER_TIME_UNIT_NONE and offset is @c 0. @n
+ * When the time offset is set, the absolute time is reset.
*/
bool IsAbsolute(void) const;
diff --git a/inc/FSclTypes.h b/inc/FSclTypes.h
index f50f0e7..cc4866e 100644
--- a/inc/FSclTypes.h
+++ b/inc/FSclTypes.h
@@ -59,7 +59,7 @@ const RecordId INVALID_RECORD_ID = -1;
typedef int AccountId;
/**
- * An invalid account ID. @n
+ * An invalid account ID.
*
* @since 2.1
*/
@@ -67,7 +67,7 @@ const AccountId INVALID_ACCOUNT_ID = -1;
/**
* @typedef RecurrenceId
- * Defines the recurrence ID which is used to identify a specific instance of a recurring calendar component (CalEvent). @n
+ * Defines the recurrence ID that is used to identify a specific instance of a recurring calendar component (CalEvent). @n
* The value type is @c Tizen::Base::DateTime. The property value is the effective value of the start time ("DTSTART" property) of the Recurrence instance.
*
* @since 2.0
@@ -290,24 +290,24 @@ enum ContactPropertyId
CONTACT_PROPERTY_ID_LAST_NAME, /**< The last name property ID (String type) */
CONTACT_PROPERTY_ID_DISPLAY_NAME, /**< The formatted name property ID (String type) */
CONTACT_PROPERTY_ID_NICK_NAME, /**< @if OSPDEPREC The nick name property ID (String type)
- @deprecated This enum field is deprecated because there can be multiple nicknames
+ @deprecated This enum value is deprecated because there can be multiple nicknames
in a contact. Instead of using this, use ContactMultiPropertyId::CONTACT_MPROPERTY_ID_NICKNAMES. @endif */
CONTACT_PROPERTY_ID_THUMBNAIL, /**< @if OSPDEPREC The thumbnail property ID (Bitmap type)
- @deprecated This enumeration field is deprecated because it is not used any longer. @endif */
+ @deprecated This enumeration value is deprecated because it is not used any longer. @endif */
CONTACT_PROPERTY_ID_BIRTHDAY, /**< @if OSPDEPREC The birthday property ID (DateTime type)
- @deprecated This enum field is deprecated because there can be multiple birthday events.
+ @deprecated This enum value is deprecated because there can be multiple birthday events.
Instead of using this, use ContactMultiPropertyId::CONTACT_MPROPERTY_ID_EVENTS. @endif */
CONTACT_PROPERTY_ID_JOB_TITLE, /**< @if OSPDEPREC The job title property ID (String type)
- @deprecated This enum field is deprecated because there can be multiple organizational information.
+ @deprecated This enum value is deprecated because there can be multiple organizational information.
Instead of using this, use ContactMultiPropertyId::CONTACT_MPROPERTY_ID_ORGANIZATIONS. @endif */
CONTACT_PROPERTY_ID_COMPANY, /**< @if OSPDEPREC The company property ID (String type)
- @deprecated This enum field is deprecated because there can be multiple organizational information.
+ @deprecated This enum value is deprecated because there can be multiple organizational information.
Instead of using this, use ContactMultiPropertyId::CONTACT_MPROPERTY_ID_ORGANIZATIONS.@endif */
CONTACT_PROPERTY_ID_NOTE, /**< @if OSPDEPREC The note property ID (String type)
- @deprecated This enum field is deprecated because there can be multiple notes
+ @deprecated This enum value is deprecated because there can be multiple notes
in a contact. Instead of using this, use ContactMultiPropertyId::CONTACT_MPROPERTY_ID_NOTES.@endif */
CONTACT_PROPERTY_ID_ANNIVERSARY, /**< @if OSPDEPREC The anniversary property ID (DateTime type)
- @deprecated This enum field is deprecated because there can be multiple anniversary events.
+ @deprecated This enum value is deprecated because there can be multiple anniversary events.
Instead of using this, use ContactMultiPropertyId::CONTACT_MPROPERTY_ID_EVENTS.@endif */
CONTACT_PROPERTY_ID_RINGTONE, /**< The ringtone property ID (String type) */
CONTACT_PROPERTY_ID_MIDDLE_NAME, /**< The middle name property ID (String type) */
@@ -323,7 +323,7 @@ enum ContactPropertyId
/**
* @enum ContactMultiPropertyId
*
- * Defines the IDs for accessing the multi-value type properties of a %Contact. @n
+ * Defines the IDs for accessing the multi-value type properties of Contact. @n
* The properties have several values and they are called multi-type properties.
* @since 2.0
*/
@@ -346,7 +346,7 @@ enum ContactMultiPropertyId
* The number of #ContactPropertyId factors.
*
* @brief <i> [Deprecated] </i>
- * @deprecated This constant is deprecated it is not used any more.
+ * @deprecated This constant is deprecated because it is not used any more.
* @since 2.0
* @endif
*/
@@ -357,7 +357,7 @@ static const int CONTACT_PROPERTY_ID_NUM = 14;
* The number of #ContactMultiPropertyId factors.
*
* @brief <i> [Deprecated] </i>
- * @deprecated This constant is deprecated it is not used any more.
+ * @deprecated This constant is deprecated because it is not used any more.
* @since 2.0
* @endif
*/
@@ -530,7 +530,7 @@ enum RecordEventType
ALL_RECORDS_REMOVED, /**<
* @if OSPDEPREC
* The removal of all records @n
- * @deprecated This enum value is deprecated because it's not used any more.
+ * @deprecated This enum value is deprecated because it is not used any more.
* @endif
*/
MULTI_RECORDS_ADDED, /**< @if OSPDEPREC The adding of multiple records @endif */
@@ -571,7 +571,7 @@ enum CalDayOfWeek
/**
* @enum RecordChangeType
- * Defines the change type of a Record.
+ * Defines the change type of Record.
*
* @since 2.0
*/
@@ -626,7 +626,7 @@ enum ReminderTimeUnit
REMINDER_TIME_UNIT_HOUR, /**< The unit of time offset is hour */
REMINDER_TIME_UNIT_DAY, /**< The unit of time offset is day */
REMINDER_TIME_UNIT_WEEK, /**< The unit of time offset is week */
- REMINDER_TIME_UNIT_NONE, /**< The time offset is not using @b Since @b 2.1 */
+ REMINDER_TIME_UNIT_NONE, /**< The unit of time offset is none @b Since @b 2.1 */
};
/**
@@ -719,7 +719,7 @@ enum RelationshipType
/**
* @enum OrganizationType
*
- * Defines the types of organization
+ * Defines the types of organization.
*
* @since 2.1
*/
@@ -844,8 +844,8 @@ enum AddressbookFilterType
/**
* @enum AddressbookFilterProperty
- * Defines the property for filtering the addressbooks.
- * This properties can be used to create a AddressbookFilter of #AB_FI_TYPE_ADDRESSBOOK type.
+ * Defines the property for filtering the addressbooks. @n
+ * These properties can be used to create an AddressbookFilter of #AB_FI_TYPE_ADDRESSBOOK type.
*
* @since 2.0
*/
@@ -858,8 +858,8 @@ enum AddressbookFilterProperty
/**
* @enum PersonFilterProperty
- * Defines the property for filtering the persons.
- * This properties can be used to create a AddressbookFilter of #AB_FI_TYPE_PERSON type.
+ * Defines the property for filtering the persons. @n
+ * These properties can be used to create an AddressbookFilter of #AB_FI_TYPE_PERSON type.
*
* @since 2.0
*/
@@ -876,8 +876,8 @@ enum PersonFilterProperty
/**
* @enum ContactFilterProperty
- * Defines the property for filtering the contacts.
- * This properties can be used to create a AddressbookFilter of #AB_FI_TYPE_CONTACT type.
+ * Defines the property for filtering the contacts. @n
+ * These properties can be used to create an AddressbookFilter of #AB_FI_TYPE_CONTACT type.
*
* @since 2.0
*/
@@ -894,7 +894,7 @@ enum ContactFilterProperty
/**
* @enum CategoryFilterProperty
* Defines the property for filtering the categories.
- * This properties can be used to create a AddressbookFilter of #AB_FI_TYPE_CATEGORY type.
+ * These properties can be used to create an AddressbookFilter of #AB_FI_TYPE_CATEGORY type.
*
* @since 2.0
*/
@@ -908,7 +908,7 @@ enum CategoryFilterProperty
/**
* @enum PhoneContactFilterProperty
* Defines the property for filtering the contacts with phone number.
- * This properties can be used to create a AddressbookFilter of #AB_FI_TYPE_PHONE_CONTACT type.
+ * These properties can be used to create an AddressbookFilter of #AB_FI_TYPE_PHONE_CONTACT type.
*
* @since 2.0
*/
@@ -924,7 +924,7 @@ enum PhoneContactFilterProperty
/**
* @enum EmailContactFilterProperty
* Defines the property for filtering the contacts with email.
- * This properties can be used to create a AddressbookFilter of #AB_FI_TYPE_EMAIL_CONTACT type.
+ * These properties can be used to create an AddressbookFilter of #AB_FI_TYPE_EMAIL_CONTACT type.
*
* @since 2.0
*/
@@ -959,7 +959,7 @@ enum UserProfilePropertyId
/**
* @enum UserProfileMultiPropertyId
*
- * Defines the IDs for accessing the multi-value type properties of a %UserProfile. @n
+ * Defines the IDs for accessing the multi-value type properties of UserProfile. @n
* The properties have several values and they are called multi-type properties.
* @since 2.1
*/
@@ -969,7 +969,7 @@ enum UserProfileMultiPropertyId
USER_PROFILE_MPROPERTY_ID_EMAILS, /**< The email property ID (Email class) */
USER_PROFILE_MPROPERTY_ID_URLS, /**< The URL property ID (Url class) */
USER_PROFILE_MPROPERTY_ID_ADDRESSES, /**< The address property ID (Address class) */
- USER_PROFILE_MPROPERTY_ID_IMADDRESSES, /**< The Instant Message property ID (ImAddress class) */
+ USER_PROFILE_MPROPERTY_ID_IMADDRESSES, /**< The instant message property ID (ImAddress class) */
USER_PROFILE_MPROPERTY_ID_EVENTS, /**< The contact event property ID (ContactEvent class) */
USER_PROFILE_MPROPERTY_ID_ORGANIZATIONS, /**< The organization property ID (Organization class) */
USER_PROFILE_MPROPERTY_ID_NOTES, /**< The note property ID (String type) */
@@ -994,15 +994,15 @@ enum CalendarbookFilterType
/**
* @enum EventFilterProperty
- * Defines the property for filtering the events.
- * This properties can be used to create a CalendarbookFilter of CB_FI_TYPE_EVENT type.
+ * Defines the property for filtering the events. @n
+ * These properties can be used to create a CalendarbookFilter of CB_FI_TYPE_EVENT type.
*
* @since 2.0
*/
enum EventFilterProperty
{
- EVENT_FI_PR_EVENT_ID = 1, /**< The event id: int (RecordId) */
- EVENT_FI_PR_CALENDAR_ID, /**< The calendar id: long long (RecordId) */
+ EVENT_FI_PR_EVENT_ID = 1, /**< The event ID: int (RecordId) */
+ EVENT_FI_PR_CALENDAR_ID, /**< The calendar ID: long long (RecordId) */
EVENT_FI_PR_SUBJECT, /**< The subject of the event: String */
EVENT_FI_PR_DESCRIPTION, /**< The description of the event: String */
EVENT_FI_PR_LOCATION, /**< The location of the event: String */
@@ -1019,16 +1019,16 @@ enum EventFilterProperty
};
/**
- * @enum TodoFilterProperty
-* Defines the property for filtering the to-dos.
-* This properties can be used to create a CalendarbookFilter of CB_FI_TYPE_TODO type.
+* @enum TodoFilterProperty
+* Defines the property for filtering the to-dos. @n
+* These properties can be used to create a CalendarbookFilter of CB_FI_TYPE_TODO type.
*
* @since 2.0
*/
enum TodoFilterProperty
{
- TODO_FI_PR_TODO_ID = 100, /**< The todo id: long long (RecordId) */
- TODO_FI_PR_CALENDAR_ID, /**< The calendar id: long long (RecordId) */
+ TODO_FI_PR_TODO_ID = 100, /**< The todo ID: long long (RecordId) */
+ TODO_FI_PR_CALENDAR_ID, /**< The calendar ID: long long (RecordId) */
TODO_FI_PR_START_DATE, /**< The start date of the to-do: DateTime*/
TODO_FI_PR_DUE_DATE, /**< The due date of the to-do: DateTime */
TODO_FI_PR_SUBJECT, /**< The subject of the to-do: String */
@@ -1044,16 +1044,16 @@ enum TodoFilterProperty
};
/**
- * @enum EventInstanceFilterProperty
-* Defines the property for filtering the all day event instances or non-all day event instances.
-* This properties can be used to create the CalendarbookFilter of CB_FI_TYPE_ALL_DAY_EVENT_INSTANCE type or CB_FI_TYPE_NON_ALL_DAY_EVENT_INSTANCE type.
+* @enum EventInstanceFilterProperty
+* Defines the property for filtering the all day event instances or non-all day event instances. @n
+* These properties can be used to create a CalendarbookFilter of CB_FI_TYPE_ALL_DAY_EVENT_INSTANCE type or CB_FI_TYPE_NON_ALL_DAY_EVENT_INSTANCE type.
*
* @since 2.0
*/
enum EventInstanceFilterProperty
{
- EVENT_INST_FI_PR_ORIGINAL_EVENT_ID = 200, /**< The original event id: int (RecordId) */
- EVENT_INST_FI_PR_CALENDAR_ID, /**< The calendar id: int (RecordId) */
+ EVENT_INST_FI_PR_ORIGINAL_EVENT_ID = 200, /**< The original event ID: int (RecordId) */
+ EVENT_INST_FI_PR_CALENDAR_ID, /**< The calendar ID: int (RecordId) */
EVENT_INST_FI_PR_START_TIME, /**< The start time of the event instance: DateTime */
EVENT_INST_FI_PR_END_TIME, /**< The end time of the event instance: DateTime */
EVENT_INST_FI_PR_SUBJECT, /**< The subject of the event instance: String */
@@ -1070,16 +1070,16 @@ enum EventInstanceFilterProperty
};
/**
- * @enum CalendarFilterProperty
-* Defines the property for filtering the calendars.
-* This properties can be used to create a CalendarbookFilter of CB_FI_TYPE_CALENDAR type.
+* @enum CalendarFilterProperty
+* Defines the property for filtering the calendars. @n
+* These properties can be used to create a CalendarbookFilter of CB_FI_TYPE_CALENDAR type.
*
* @since 2.0
*/
enum CalendarFilterProperty
{
- CALENDAR_FI_PR_CALENDAR_ID = 400, /**< The calendar id: int (RecordId) */
- CALENDAR_FI_PR_ACCOUNT_ID, /**< The account id of calendar: int (AccountId) */
+ CALENDAR_FI_PR_CALENDAR_ID = 400, /**< The calendar ID: int (RecordId) */
+ CALENDAR_FI_PR_ACCOUNT_ID, /**< The account ID of calendar: int (AccountId) */
CALENDAR_FI_PR_NAME, /**< The name of calendar: String */
CALENDAR_FI_PR_ITEM_TYPE /**< The type of calendar: int (CalendarItemType) */
};