From: Eunhae Choi <eunhae1.choi@samsung.com>
Date: Thu, 11 May 2017 10:32:36 +0000 (+0900)
Subject: [ACR-955] update error code doxygen
X-Git-Tag: accepted/tizen/unified/20170608.072423~2^2
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=af46a774f0488d402b5c8ba1498a8882a4fdb113;p=platform%2Fcore%2Fapi%2Fplayer.git

[ACR-955] update error code doxygen

- to return PLAYER_ERROR_FEATURE_NOT_SUPPORTED_ON_DEVICE error code
  the API should specify related feature but there is no related feature.
- Officially, we do not mention this error code in a doxygen according to the ACR guide.

Change-Id: I16f24889d51238c35860b14e9c2c9bd129df300f
---

diff --git a/include/player.h b/include/player.h
index 0812be3..2b20959 100644
--- a/include/player.h
+++ b/include/player.h
@@ -1475,7 +1475,6 @@ int player_get_duration(player_h player, int *duration);
  * @retval #PLAYER_ERROR_NONE Successful
  * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #PLAYER_ERROR_INVALID_STATE Invalid player state
- * @retval #PLAYER_ERROR_FEATURE_NOT_SUPPORTED_ON_DEVICE Unsupported feature
  * @pre The player state must be one of #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED.
  * @see player_audio_effect_equalizer_is_available()
  * @see player_audio_effect_set_equalizer_band_level()
@@ -1495,7 +1494,6 @@ int player_audio_effect_get_equalizer_bands_count(player_h player, int *count);
  * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #PLAYER_ERROR_INVALID_OPERATION Invalid operation
  * @retval #PLAYER_ERROR_INVALID_STATE Invalid player state
- * @retval #PLAYER_ERROR_FEATURE_NOT_SUPPORTED_ON_DEVICE Unsupported feature
  * @pre The player state must be one of #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED.
  * @see player_audio_effect_equalizer_is_available()
  * @see player_audio_effect_get_equalizer_bands_count()
@@ -1516,7 +1514,6 @@ int player_audio_effect_set_equalizer_band_level(player_h player, int index, int
  * @retval #PLAYER_ERROR_NONE Successful
  * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #PLAYER_ERROR_INVALID_STATE Invalid player state
- * @retval #PLAYER_ERROR_FEATURE_NOT_SUPPORTED_ON_DEVICE Unsupported feature
  * @pre The player state must be one of #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED.
  * @see player_audio_effect_equalizer_is_available()
  * @see player_audio_effect_set_equalizer_band_level()
@@ -1535,7 +1532,6 @@ int player_audio_effect_get_equalizer_band_level(player_h player, int index, int
  * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #PLAYER_ERROR_INVALID_OPERATION Invalid operation
  * @retval #PLAYER_ERROR_INVALID_STATE Invalid player state
- * @retval #PLAYER_ERROR_FEATURE_NOT_SUPPORTED_ON_DEVICE Unsupported feature
  * @pre The player state must be one of #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED.
  * @see player_audio_effect_equalizer_is_available()
  * @see player_audio_effect_get_equalizer_bands_count()
@@ -1556,7 +1552,6 @@ int player_audio_effect_set_equalizer_all_bands(player_h player, int *band_level
  * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #PLAYER_ERROR_INVALID_STATE Invalid player state
  * @retval #PLAYER_ERROR_INVALID_OPERATION Invalid operation
- * @retval #PLAYER_ERROR_FEATURE_NOT_SUPPORTED_ON_DEVICE Unsupported feature
  * @pre The player state must be one of #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED.
  * @see player_audio_effect_equalizer_is_available()
  * @see player_audio_effect_set_equalizer_band_level()
@@ -1575,7 +1570,6 @@ int player_audio_effect_get_equalizer_level_range(player_h player, int* min, int
  * @retval #PLAYER_ERROR_NONE Successful
  * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #PLAYER_ERROR_INVALID_STATE Invalid player state
- * @retval #PLAYER_ERROR_FEATURE_NOT_SUPPORTED_ON_DEVICE Unsupported feature
  * @pre The player state must be one of #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED.
  * @see player_audio_effect_equalizer_is_available()
  */
@@ -1592,7 +1586,6 @@ int player_audio_effect_get_equalizer_band_frequency(player_h player, int index,
  * @retval #PLAYER_ERROR_NONE Successful
  * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #PLAYER_ERROR_INVALID_STATE Invalid player state
- * @retval #PLAYER_ERROR_FEATURE_NOT_SUPPORTED_ON_DEVICE Unsupported feature
  * @pre The player state must be one of #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED.
  * @see player_audio_effect_equalizer_is_available()
  */
@@ -1606,7 +1599,6 @@ int player_audio_effect_get_equalizer_band_frequency_range(player_h player, int
  * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #PLAYER_ERROR_INVALID_OPERATION Invalid operation
  * @retval #PLAYER_ERROR_INVALID_STATE Invalid player state
- * @retval #PLAYER_ERROR_FEATURE_NOT_SUPPORTED_ON_DEVICE Unsupported feature
  * @pre The player state must be one of #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED.
  * @see player_audio_effect_equalizer_is_available()
  * @see player_audio_effect_set_equalizer_band_level()