fix doxygen of player_destroy(), player_destroy() can be called anytime

Change-Id: I47264b45c03c6776667c6624013164e1b6167e15

diff --git a/include/common/player.h b/include/common/player.h
index 0cb5a52..faafab7 100644 (file)
--- a/include/common/player.h
+++ b/include/common/player.h
@@ -421,7 +421,7 @@ int player_create(player_h *player);
  * @retval #PLAYER_ERROR_NONE Successful
  * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #PLAYER_ERROR_INVALID_OPERATION Invalid operation
- * @pre  The player state must be set to #PLAYER_STATE_IDLE.
+ * @pre The player state must be one of these: #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED.
  * @post The player state will be #PLAYER_STATE_NONE.
  * @see player_create()
  */

diff --git a/include/wearable/player.h b/include/wearable/player.h
index 91e853c..c648c6a 100644 (file)
--- a/include/wearable/player.h
+++ b/include/wearable/player.h
@@ -419,7 +419,7 @@ int player_create(player_h *player);
  * @retval #PLAYER_ERROR_NONE Successful
  * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #PLAYER_ERROR_INVALID_OPERATION Invalid operation
- * @pre  The player state must be set to #PLAYER_STATE_IDLE.
+ * @pre The player state must be one of these: #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED.
  * @post The player state will be #PLAYER_STATE_NONE.
  * @see player_create()
  */