Add CAPI description about returning error

[platform/core/api/wifi-direct.git] / include / wifi-direct.h

diff --git a/include/wifi-direct.h b/include/wifi-direct.h
index 012f0c8..acb693a 100755 (executable)
--- a/include/wifi-direct.h
+++ b/include/wifi-direct.h
@@ -5521,14 +5521,15 @@ int wifi_direct_set_group_owner_intent(int intent);
  * @param[in] type  The type of connection for a peer device
  * @param[in] intent  The intent of the group owner
  * @return 0 on success, otherwise a negative error value
- * @retval #WIFI_DIRECT_ERROR_NONE  Successful
- * @retval #WIFI_DIRECT_ERROR_INVALID_PARAMETER  Invalid parameter
- * @retval #WIFI_DIRECT_ERROR_OPERATION_FAILED  Operation failed
+ * @retval #WIFI_DIRECT_ERROR_NONE                  Successful
+ * @retval #WIFI_DIRECT_ERROR_INVALID_PARAMETER     Invalid parameter
+ * @retval #WIFI_DIRECT_ERROR_OPERATION_FAILED      Operation failed
  * @retval #WIFI_DIRECT_ERROR_COMMUNICATION_FAILED  Communication failed
- * @retval #WIFI_DIRECT_ERROR_PERMISSION_DENIED  Permission denied
- * @retval #WIFI_DIRECT_ERROR_NOT_PERMITTED  Operation not permitted
- * @retval #WIFI_DIRECT_ERROR_NOT_INITIALIZED  Not initialized
- * @retval #WIFI_DIRECT_ERROR_RESOURCE_BUSY  Device or resource busy
+ * @retval #WIFI_DIRECT_ERROR_PERMISSION_DENIED     Permission denied
+ * @retval #WIFI_DIRECT_ERROR_NOT_PERMITTED         Operation not permitted
+ * @retval #WIFI_DIRECT_ERROR_NOT_SUPPORTED         Not supported
+ * @retval #WIFI_DIRECT_ERROR_NOT_INITIALIZED       Not initialized
+ * @retval #WIFI_DIRECT_ERROR_RESOURCE_BUSY         Device or resource busy
  * @pre Wi-Fi Direct service must be initialized by wifi_direct_initialize().
  * @see wifi_direct_initialize()
  * @see wifi_direct_get_go_intent_per_type()
@@ -5606,14 +5607,15 @@ int wifi_direct_get_group_owner_intent(int *intent);
  * @param[in] type  The type of connection for a peer device
  * @param[out] intent  The intent of the group owner
  * @return 0 on success, otherwise a negative error value
- * @retval #WIFI_DIRECT_ERROR_NONE  Successful
- * @retval #WIFI_DIRECT_ERROR_INVALID_PARAMETER  Invalid parameter
- * @retval #WIFI_DIRECT_ERROR_OPERATION_FAILED  Operation failed
+ * @retval #WIFI_DIRECT_ERROR_NONE                  Successful
+ * @retval #WIFI_DIRECT_ERROR_INVALID_PARAMETER     Invalid parameter
+ * @retval #WIFI_DIRECT_ERROR_OPERATION_FAILED      Operation failed
  * @retval #WIFI_DIRECT_ERROR_COMMUNICATION_FAILED  Communication failed
- * @retval #WIFI_DIRECT_ERROR_PERMISSION_DENIED  Permission denied
- * @retval #WIFI_DIRECT_ERROR_NOT_PERMITTED  Operation not permitted
- * @retval #WIFI_DIRECT_ERROR_NOT_INITIALIZED  Not initialized
- * @retval #WIFI_DIRECT_ERROR_RESOURCE_BUSY  Device or resource busy
+ * @retval #WIFI_DIRECT_ERROR_PERMISSION_DENIED     Permission denied
+ * @retval #WIFI_DIRECT_ERROR_NOT_PERMITTED         Operation not permitted
+ * @retval #WIFI_DIRECT_ERROR_NOT_SUPPORTED         Not supported
+ * @retval #WIFI_DIRECT_ERROR_NOT_INITIALIZED       Not initialized
+ * @retval #WIFI_DIRECT_ERROR_RESOURCE_BUSY         Device or resource busy
  * @pre Wi-Fi Direct service must be initialized by wifi_direct_initialize().
  * @see wifi_direct_initialize()
  * @see wifi_direct_set_go_intent_per_type()
@@ -8332,15 +8334,15 @@ int wifi_direct_get_peer_vsie(char *mac_address, char **vsie);
  *            for example #WIFI_DIRECT_CONFIG_METHOD_PBC|#WIFI_DIRECT_CONFIG_METHOD_PIN_DISPLAY
  *            Use #WIFI_DIRECT_CONFIG_METHOD_DEFAULT to reset to default value
  * @return 0 on success, otherwise a negative error value
- * @retval #WIFI_DIRECT_ERROR_NONE  Successful
- * @retval #WIFI_DIRECT_ERROR_INVALID_PARAMETER  Invalid parameter
- * @retval #WIFI_DIRECT_ERROR_OPERATION_FAILED  Operation failed
+ * @retval #WIFI_DIRECT_ERROR_NONE                  Successful
+ * @retval #WIFI_DIRECT_ERROR_INVALID_PARAMETER     Invalid parameter
+ * @retval #WIFI_DIRECT_ERROR_OPERATION_FAILED      Operation failed
  * @retval #WIFI_DIRECT_ERROR_COMMUNICATION_FAILED  Communication failed
- * @retval #WIFI_DIRECT_ERROR_PERMISSION_DENIED  Permission denied
- * @retval #WIFI_DIRECT_ERROR_NOT_PERMITTED  Operation not permitted
- * @retval #WIFI_DIRECT_ERROR_NOT_SUPPORTED  Not supported
- * @retval #WIFI_DIRECT_ERROR_NOT_INITIALIZED  Not initialized
- * @retval #WIFI_DIRECT_ERROR_RESOURCE_BUSY  Device or resource busy
+ * @retval #WIFI_DIRECT_ERROR_PERMISSION_DENIED     Permission denied
+ * @retval #WIFI_DIRECT_ERROR_NOT_PERMITTED         Operation not permitted
+ * @retval #WIFI_DIRECT_ERROR_NOT_SUPPORTED         Not supported
+ * @retval #WIFI_DIRECT_ERROR_NOT_INITIALIZED       Not initialized
+ * @retval #WIFI_DIRECT_ERROR_RESOURCE_BUSY         Device or resource busy
  * @pre Wi-Fi Direct service must be initialized by wifi_direct_activate().
  * @see wifi_direct_initialize()
  */
@@ -8353,15 +8355,15 @@ int wifi_direct_set_wps_config_method(int type);
  * @privilege http://tizen.org/privilege/wifidirect
  * @param[out] type  The type of WPS. composition of #wifi_direct_config_method_type_e
  * @return 0 on success, otherwise a negative error value
- * @retval #WIFI_DIRECT_ERROR_NONE  Successful
- * @retval #WIFI_DIRECT_ERROR_INVALID_PARAMETER  Invalid parameter
- * @retval #WIFI_DIRECT_ERROR_OPERATION_FAILED  Operation failed
+ * @retval #WIFI_DIRECT_ERROR_NONE                  Successful
+ * @retval #WIFI_DIRECT_ERROR_INVALID_PARAMETER     Invalid parameter
+ * @retval #WIFI_DIRECT_ERROR_OPERATION_FAILED      Operation failed
  * @retval #WIFI_DIRECT_ERROR_COMMUNICATION_FAILED  Communication failed
- * @retval #WIFI_DIRECT_ERROR_PERMISSION_DENIED  Permission denied
- * @retval #WIFI_DIRECT_ERROR_NOT_PERMITTED  Operation not permitted
- * @retval #WIFI_DIRECT_ERROR_NOT_SUPPORTED  Not supported
- * @retval #WIFI_DIRECT_ERROR_NOT_INITIALIZED  Not initialized
- * @retval #WIFI_DIRECT_ERROR_RESOURCE_BUSY  Device or resource busy
+ * @retval #WIFI_DIRECT_ERROR_PERMISSION_DENIED     Permission denied
+ * @retval #WIFI_DIRECT_ERROR_NOT_PERMITTED         Operation not permitted
+ * @retval #WIFI_DIRECT_ERROR_NOT_SUPPORTED         Not supported
+ * @retval #WIFI_DIRECT_ERROR_NOT_INITIALIZED       Not initialized
+ * @retval #WIFI_DIRECT_ERROR_RESOURCE_BUSY         Device or resource busy
  * @pre Wi-Fi Direct service must be initialized by wifi_direct_initialize().
  * @pre Wi-Fi Direct service must be activated by wifi_direct_activate().
  * @see wifi_direct_initialize()
@@ -8375,15 +8377,15 @@ int wifi_direct_get_wps_config_method(int *type);
  * @privilege http://tizen.org/privilege/wifidirect
  * @param[in] mac_address  The MAC address of the persistent group owner
  * @return 0 on success, otherwise a negative error value
- * @retval #WIFI_DIRECT_ERROR_NONE  Successful
- * @retval #WIFI_DIRECT_ERROR_INVALID_PARAMETER  Invalid parameter
- * @retval #WIFI_DIRECT_ERROR_OPERATION_FAILED  Operation failed
+ * @retval #WIFI_DIRECT_ERROR_NONE                  Successful
+ * @retval #WIFI_DIRECT_ERROR_INVALID_PARAMETER     Invalid parameter
+ * @retval #WIFI_DIRECT_ERROR_OPERATION_FAILED      Operation failed
  * @retval #WIFI_DIRECT_ERROR_COMMUNICATION_FAILED  Communication failed
- * @retval #WIFI_DIRECT_ERROR_PERMISSION_DENIED  Permission denied
- * @retval #WIFI_DIRECT_ERROR_NOT_PERMITTED  Operation not permitted
- * @retval #WIFI_DIRECT_ERROR_NOT_SUPPORTED  Not supported
- * @retval #WIFI_DIRECT_ERROR_NOT_INITIALIZED  Not initialized
- * @retval #WIFI_DIRECT_ERROR_RESOURCE_BUSY  Device or resource busy
+ * @retval #WIFI_DIRECT_ERROR_PERMISSION_DENIED     Permission denied
+ * @retval #WIFI_DIRECT_ERROR_NOT_PERMITTED         Operation not permitted
+ * @retval #WIFI_DIRECT_ERROR_NOT_SUPPORTED         Not supported
+ * @retval #WIFI_DIRECT_ERROR_NOT_INITIALIZED       Not initialized
+ * @retval #WIFI_DIRECT_ERROR_RESOURCE_BUSY         Device or resource busy
  * @pre Wi-Fi Direct service must be initialized by wifi_direct_initialize().
  * @see wifi_direct_initialize()
 */
@@ -8395,14 +8397,14 @@ int wifi_direct_remove_persistent_device(char *mac_address);
  * @privlevel public
  * @privilege http://tizen.org/privilege/wifidirect
  * @return 0 on success, otherwise a negative error value
- * @retval #WIFI_DIRECT_ERROR_NONE  Successful
- * @retval #WIFI_DIRECT_ERROR_OPERATION_FAILED  Operation failed
+ * @retval #WIFI_DIRECT_ERROR_NONE                  Successful
+ * @retval #WIFI_DIRECT_ERROR_OPERATION_FAILED      Operation failed
  * @retval #WIFI_DIRECT_ERROR_COMMUNICATION_FAILED  Communication failed
- * @retval #WIFI_DIRECT_ERROR_PERMISSION_DENIED  Permission denied
- * @retval #WIFI_DIRECT_ERROR_NOT_PERMITTED  Operation not permitted
- * @retval #WIFI_DIRECT_ERROR_NOT_SUPPORTED  Not supported
- * @retval #WIFI_DIRECT_ERROR_NOT_INITIALIZED  Not initialized
- * @retval #WIFI_DIRECT_ERROR_RESOURCE_BUSY  Device or resource busy
+ * @retval #WIFI_DIRECT_ERROR_PERMISSION_DENIED     Permission denied
+ * @retval #WIFI_DIRECT_ERROR_NOT_PERMITTED         Operation not permitted
+ * @retval #WIFI_DIRECT_ERROR_NOT_SUPPORTED         Not supported
+ * @retval #WIFI_DIRECT_ERROR_NOT_INITIALIZED       Not initialized
+ * @retval #WIFI_DIRECT_ERROR_RESOURCE_BUSY         Device or resource busy
  * @pre Wi-Fi Direct service must be initialized by wifi_direct_initialize().
  * @see wifi_direct_initialize()
 */