Add pre&post condition in doxygen 65/142165/1
authorJongkyu Koo <jk.koo@samsung.com>
Thu, 3 Aug 2017 02:36:29 +0000 (11:36 +0900)
committerJongkyu Koo <jk.koo@samsung.com>
Thu, 3 Aug 2017 02:36:29 +0000 (11:36 +0900)
Change-Id: I8bb03ba4dbdcd82550883ba2608cebbd96df7b96
Signed-off-by: Jongkyu Koo <jk.koo@samsung.com>
include/phone_number.h

index 0774afa6aadd38a478227dd46e7fc805a041b4c1..936c2aebd9f83b5de7a4a95927edfa654b58ed34 100644 (file)
@@ -161,7 +161,8 @@ int phone_number_get_normalized_number(const char *number, char **normalized_num
  * @retval  #PHONE_NUMBER_ERROR_PERMISSION_DENIED   Permission denied. This application does not have the privilege to call this method.
  * @retval  #PHONE_NUMBER_ERROR_IPC                 Unknown IPC error
  * @retval  #PHONE_NUMBER_ERROR_OUT_OF_MEMORY       Out of memory
- *
+ * @pre phone_number_connect() should be called to open a connection to the phonenumber-utils service.
+ * @post phone_number_disconnect() should be called to close a connection to the phonenumber-utils service.
  * @see phone_number_remove_blocking_rule()
  */
 int phone_number_add_blocking_rule(phone_number_blocking_rule_h rule);
@@ -186,7 +187,8 @@ int phone_number_add_blocking_rule(phone_number_blocking_rule_h rule);
  * @retval  #PHONE_NUMBER_ERROR_PERMISSION_DENIED   Permission denied. This application does not have the privilege to call this method.
  * @retval  #PHONE_NUMBER_ERROR_IPC                 Unknown IPC error
  * @retval  #PHONE_NUMBER_ERROR_OUT_OF_MEMORY       Out of memory
- *
+ * @pre phone_number_connect() should be called to open a connection to the phonenumber-utils service.
+ * @post phone_number_disconnect() should be called to close a connection to the phonenumber-utils service.
  * @see phone_number_add_blocking_rule()
  */
 int phone_number_remove_blocking_rule(phone_number_blocking_rule_h rule);
@@ -215,6 +217,8 @@ int phone_number_remove_blocking_rule(phone_number_blocking_rule_h rule);
  * @retval  #PHONE_NUMBER_ERROR_PERMISSION_DENIED   Permission denied. This application does not have the privilege to call this method.
  * @retval  #PHONE_NUMBER_ERROR_IPC                 Unknown IPC error
  * @retval  #PHONE_NUMBER_ERROR_NO_DATA             Data does not exist
+ * @pre phone_number_connect() should be called to open a connection to the phonenumber-utils service.
+ * @post phone_number_disconnect() should be called to close a connection to the phonenumber-utils service.
  */
 int phone_number_get_blocking_rules(int offset, int limit, phone_number_blocking_rule_h **rules, int *length);
 
@@ -241,6 +245,8 @@ int phone_number_get_blocking_rules(int offset, int limit, phone_number_blocking
  * @retval  #PHONE_NUMBER_ERROR_PERMISSION_DENIED   Permission denied. This application does not have the privilege to call this method.
  * @retval  #PHONE_NUMBER_ERROR_IPC                 Unknown IPC error
  * @retval  #PHONE_NUMBER_ERROR_NO_DATA             Data does not exist
+ * @pre phone_number_connect() should be called to open a connection to the phonenumber-utils service.
+ * @post phone_number_disconnect() should be called to close a connection to the phonenumber-utils service.
  */
 int phone_number_get_blocking_rules_related(const char *number, phone_number_blocking_rule_h **rules, int *length);
 
@@ -262,6 +268,8 @@ int phone_number_get_blocking_rules_related(const char *number, phone_number_blo
  * @retval  #PHONE_NUMBER_ERROR_DB_FAILED           Database operation failure
  * @retval  #PHONE_NUMBER_ERROR_PERMISSION_DENIED   Permission denied. This application does not have the privilege to call this method.
  * @retval  #PHONE_NUMBER_ERROR_IPC                 Unknown IPC error
+ * @pre phone_number_connect() should be called to open a connection to the phonenumber-utils service.
+ * @post phone_number_disconnect() should be called to close a connection to the phonenumber-utils service.
  */
 int phone_number_check_blocking(const char *number, bool *is_blocked);