From: Eunhae Choi Date: Thu, 24 Nov 2016 09:10:38 +0000 (+0900) Subject: [ACR-847] fix doxygen error X-Git-Tag: accepted/tizen/3.0/common/20161130.064558~2 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=28c07b0425fd07cf5b2d078380bc8fb8661b71ca;p=platform%2Fcore%2Fapi%2Fplayer.git [ACR-847] fix doxygen error Change-Id: I6cbfde1b770fb9527092a66af671553821afe3cc Signed-off-by: Eunhae Choi --- diff --git a/include/common/player.h b/include/common/player.h index 57ecc47..a668837 100644 --- a/include/common/player.h +++ b/include/common/player.h @@ -770,6 +770,7 @@ int player_pause(player_h player); * @return @c 0 on success, * otherwise a negative error value * @retval #PLAYER_ERROR_NONE Successful + * @retval #PLAYER_ERROR_INVALID_STATE Invalid player state * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter * @retval #PLAYER_ERROR_INVALID_OPERATION Invalid operation * @retval #PLAYER_ERROR_SEEK_FAILED Seek operation failure @@ -787,10 +788,11 @@ int player_set_play_position(player_h player, int millisecond, bool accurate, pl * @return @c 0 on success, * otherwise a negative error value * @retval #PLAYER_ERROR_NONE Successful + * @retval #PLAYER_ERROR_INVALID_STATE Invalid player state * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter * @retval #PLAYER_ERROR_INVALID_OPERATION Invalid operation * @retval #PLAYER_ERROR_SEEK_FAILED Seek operation failure - * @pre The player state must be one of #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. + * @pre The player state must be one of #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. * @see player_set_play_position() */ int player_get_play_position(player_h player, int *millisecond); @@ -1841,12 +1843,13 @@ int player_unset_progressive_download_message_cb(player_h player); * @remarks #PLAYER_ERROR_INVALID_OPERATION occurs when streaming playback. * @remarks No operation is performed, if @a rate is @c 0. * @remarks The sound is muted, when playback rate is under @c 0.0 and over @c 2.0. - * @param[in] player The handle to the media player - * @param[in] rate The playback rate (-5.0x ~ 5.0x) + * @param[in] player The handle to the media player + * @param[in] rate The playback rate (-5.0x ~ 5.0x) + * @retval #PLAYER_ERROR_NONE Successful + * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter * @retval #PLAYER_ERROR_INVALID_OPERATION Invalid operation * @retval #PLAYER_ERROR_INVALID_STATE Invalid player state - * @pre The player state must be set to #PLAYER_STATE_PLAYING by calling player_start(). - * @pre The player state must be set to #PLAYER_STATE_READY by calling player_prepare() or set to #PLAYER_STATE_PLAYING by calling player_start() or set to #PLAYER_STATE_PAUSED by calling player_pause(). + * @pre The player state must be one of #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. */ int player_set_playback_rate(player_h player, float rate); diff --git a/include/wearable/player.h b/include/wearable/player.h index 33211d6..d135874 100644 --- a/include/wearable/player.h +++ b/include/wearable/player.h @@ -771,6 +771,7 @@ int player_pause(player_h player); * @return @c 0 on success, * otherwise a negative error value * @retval #PLAYER_ERROR_NONE Successful + * @retval #PLAYER_ERROR_INVALID_STATE Invalid player state * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter * @retval #PLAYER_ERROR_INVALID_OPERATION Invalid operation * @retval #PLAYER_ERROR_SEEK_FAILED Seek operation failure @@ -788,10 +789,11 @@ int player_set_play_position(player_h player, int millisecond, bool accurate, pl * @return @c 0 on success, * otherwise a negative error value * @retval #PLAYER_ERROR_NONE Successful + * @retval #PLAYER_ERROR_INVALID_STATE Invalid player state * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter * @retval #PLAYER_ERROR_INVALID_OPERATION Invalid operation * @retval #PLAYER_ERROR_SEEK_FAILED Seek operation failure - * @pre The player state must be one of #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. + * @pre The player state must be one of #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. * @see player_set_play_position() */ int player_get_play_position(player_h player, int *millisecond); @@ -1845,12 +1847,13 @@ int player_unset_progressive_download_message_cb(player_h player); * @remarks #PLAYER_ERROR_INVALID_OPERATION occurs when streaming playback. * @remarks No operation is performed, if @a rate is @c 0. * @remarks The sound is muted, when playback rate is under @c 0.0 and over @c 2.0. - * @param[in] player The handle to the media player - * @param[in] rate The playback rate (-5.0x ~ 5.0x) + * @param[in] player The handle to the media player + * @param[in] rate The playback rate (-5.0x ~ 5.0x) + * @retval #PLAYER_ERROR_NONE Successful + * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter * @retval #PLAYER_ERROR_INVALID_OPERATION Invalid operation * @retval #PLAYER_ERROR_INVALID_STATE Invalid player state - * @pre The player state must be set to #PLAYER_STATE_PLAYING by calling player_start(). - * @pre The player state must be set to #PLAYER_STATE_READY by calling player_prepare() or set to #PLAYER_STATE_PLAYING by calling player_start() or set to #PLAYER_STATE_PAUSED by calling player_pause(). + * @pre The player state must be one of #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. */ int player_set_playback_rate(player_h player, float rate);