client: Revise doxygen to describe state

Signed-off-by: Sangchul Lee <sc11.lee@samsung.com>

diff --git a/src/client/espp_service_client.h b/src/client/espp_service_client.h
index 1e5639a5a0cb4ac2aaf00b02246e4b4d5ff85eb9..a48d737cd0251393983e464d4b3ea492f39bce5a 100644 (file)
--- a/src/client/espp_service_client.h
+++ b/src/client/espp_service_client.h
@@ -346,7 +346,9 @@ int espp_client_destroy(espp_h espp);
  * @retval #ESPP_CLIENT_ERROR_NONE Successful
  * @retval #ESPP_CLIENT_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #ESPP_CLIENT_ERROR_INVALID_OPERATION Invalid operation
- * @pre Functions for setting callbacks must be called before calling this function.
+ * @pre Functions for setting callbacks must be called before calling this function.\n
+ *      The state must be #ESPP_STATE_NONE.
+ * @post The state will be #ESPP_STATE_IDLE.
  * @see espp_client_create()
  * @see espp_client_close()
  */
@@ -360,6 +362,8 @@ int espp_client_open(espp_h espp);
  * @retval #ESPP_CLIENT_ERROR_NONE Successful
  * @retval #ESPP_CLIENT_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #ESPP_CLIENT_ERROR_INVALID_OPERATION Invalid operation
+ * @pre The state must be one of espp_state_e values except #ESPP_STATE_NONE.
+ * @post The state will be #ESPP_STATE_NONE.
  * @see espp_client_open()
  * @see espp_client_stop()
  */
@@ -373,6 +377,8 @@ int espp_client_close(espp_h espp);
  * @retval #ESPP_CLIENT_ERROR_NONE Successful
  * @retval #ESPP_CLIENT_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #ESPP_CLIENT_ERROR_INVALID_OPERATION Invalid operation
+ * @pre The state must be #ESPP_STATE_READY.
+ * @post The state will be #ESPP_STATE_PLAYING.
  * @see espp_client_create()
  * @see espp_client_set_audio_stream_info()
  * @see espp_client_set_video_stream_info()
@@ -390,6 +396,8 @@ int espp_client_start(espp_h espp);
  * @retval #ESPP_CLIENT_ERROR_NONE Successful
  * @retval #ESPP_CLIENT_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #ESPP_CLIENT_ERROR_INVALID_OPERATION Invalid operation
+ * @pre The state must be one of espp_state_e values except #ESPP_STATE_NONE.
+ * @post The state will be #ESPP_STATE_IDLE.
  * @see espp_client_start()
  * @see espp_client_close()
  */
@@ -403,7 +411,9 @@ int espp_client_stop(espp_h espp);
  * @retval #ESPP_CLIENT_ERROR_NONE Successful
  * @retval #ESPP_CLIENT_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #ESPP_CLIENT_ERROR_INVALID_OPERATION Invalid operation
- * @post espp_client_prepare_async_done_cb() will be called when the preparation is finished.
+ * @pre The state must be #ESPP_STATE_IDLE.
+ * @post espp_client_prepare_async_done_cb() will be called when the preparation is finished.\n
+ *       If the result is success, the state will be #ESPP_STATE_READY.
  * @see espp_client_set_audio_stream_info()
  * @see espp_client_set_video_stream_info()
  * @see espp_client_start()