Fixes for doxygen

Change-Id: If314e53c8ab99bd89b6a93a282499cef1fdf0430
Signed-off-by: Ievgen Vagin <i.vagin@samsung.com>

diff --git a/include/sound_pool.h b/include/sound_pool.h
index 5144cff..9642bdc 100644 (file)
--- a/include/sound_pool.h
+++ b/include/sound_pool.h
@@ -117,6 +117,7 @@ sound_pool_error_e sound_pool_create(sound_pool_h *pool);
  * @return @c 0 on success, otherwise a negative error value
  * @retval #SOUND_POOL_ERROR_INVALID_PARAMETER
  *         Invalid parameter (@a pool is NULL or corrupted)
+ * @retval #SOUND_POOL_ERROR_INVALID_OPERATION Invalid operation
  *
  * @pre Create sound pool handler by calling @ref sound_pool_create()
  *
@@ -185,8 +186,6 @@ sound_pool_error_e sound_pool_unload_source(sound_pool_h pool, const char *tag);
  * @return @c 0 on success, otherwise a negative error value
  * @retval #SOUND_POOL_ERROR_INVALID_PARAMETER
  *         Invalid parameter (@a pool is NULL or corrupted, @a tag is NULL)
- * @retval #SOUND_POOL_ERROR_KEY_NOT_AVAILABLE No sources tagged by @a tag exist
- *         in pool
  *
  * @pre Create sound @a pool handler by calling @ref sound_pool_create()
  *
@@ -251,7 +250,7 @@ sound_pool_error_e sound_pool_deactivate(sound_pool_h pool);
  * @param [in]  callback    The callback that will be called after pool state
  *                          will be changed.  @a callback will be called
  *                          synchronously
- * @param [in]  data        The user data to be passed to the @a callback
+ * @param [in]  user_data   The user data to be passed to the @a callback
  * @return @c 0 on success, otherwise a negative error value
  * @retval #SOUND_POOL_ERROR_INVALID_PARAMETER Invalid parameter
  *         (@a pool is NULL or corrupted, or @a callback is NULL)
@@ -319,7 +318,7 @@ sound_pool_error_e sound_pool_unset_state_change_callback(sound_pool_h pool);
  *
  * @pre Create sound pool handler by calling @ref sound_pool_create()
  * @pre Load source to @a pool by calling @ref sound_pool_load_source_from_file()
- * @post When playback is finished normally (i.e. @ref sound_pool_stop_stream()
+ * @post When playback is finished normally (i.e. @ref sound_pool_stream_stop()
  *       will be not used for stream termination) state will be changed to
  *       SOUND_POOL_STREAM_STATE_FINISHED and memory will be cleared from the
  *       stream allocated resources automatically
@@ -447,7 +446,6 @@ sound_pool_error_e sound_pool_set_volume(sound_pool_h pool, float volume);
  * @return @c 0 on success, otherwise a negative error value
  * @retval #SOUND_POOL_ERROR_INVALID_PARAMETER Invalid parameter
  *         (@a pool is NULL or corrupted, or @a volume is NULL)
- * @retval #SOUND_POOL_ERROR_INVALID_OPERATION Invalid operation
  *
  * @pre Create sound @a pool handler by calling @ref sound_pool_create()
  *
@@ -467,7 +465,6 @@ sound_pool_error_e sound_pool_get_volume(sound_pool_h pool, float *volume);
  *         (@a pool is NULL or corrupted, or @a state is NULL)
  * @retval #SOUND_POOL_ERROR_KEY_NOT_AVAILABLE No streams identified by @a id
  *         exist in pool
- * @retval #SOUND_POOL_ERROR_INVALID_OPERATION Invalid operation
  *
  * @pre Create sound pool handler by calling @ref sound_pool_create()
  * @pre Load source to @a pool by calling @ref sound_pool_load_source_from_file()
@@ -521,7 +518,6 @@ sound_pool_error_e sound_pool_stream_set_loop(sound_pool_h pool, unsigned id,
  *         (@a pool is NULL or corrupted, or @a loop is NULL)
  * @retval #SOUND_POOL_ERROR_KEY_NOT_AVAILABLE No streams identified by @a id
  *         exist in pool
- * @retval #SOUND_POOL_ERROR_INVALID_OPERATION Invalid operation
  *
  * @pre Create sound @a pool handler by calling @ref sound_pool_create()
  * @pre Load source to @a pool by calling @ref sound_pool_load_source_from_file()
@@ -574,7 +570,6 @@ sound_pool_error_e sound_pool_stream_set_volume(sound_pool_h pool, unsigned id,
  *         (@a pool is NULL or corrupted, or @a volume is NULL)
  * @retval #SOUND_POOL_ERROR_KEY_NOT_AVAILABLE No streams identified by @a id
  *         exist in pool
- * @retval #SOUND_POOL_ERROR_INVALID_OPERATION Invalid operation
  *
  * @pre Create sound @a pool handler by calling @ref sound_pool_create()
  * @pre Load source to @a pool by calling @ref sound_pool_load_source_from_file()
@@ -646,7 +641,6 @@ sound_pool_error_e sound_pool_stream_set_priority(sound_pool_h pool, unsigned id
  *         (@a pool is NULL or corrupted, or @a priority is NULL)
  * @retval #SOUND_POOL_ERROR_KEY_NOT_AVAILABLE No streams identified by @a id
  *         exist in pool
- * @retval #SOUND_POOL_ERROR_INVALID_OPERATION Invalid operation
  *
  * @pre Create sound @a pool handler by calling @ref sound_pool_create()
  * @pre Load source to @a pool by calling @ref sound_pool_load_source_from_file()
@@ -668,7 +662,7 @@ sound_pool_error_e sound_pool_stream_get_priority(sound_pool_h pool, unsigned id
  * @param [in]  callback    The callback that will be called after stream state
  *                          will be changed. @a callback will be called
  *                          asynchronously
- * @param [in]  data        The user data to be passed to the @a callback
+ * @param [in]  user_data   The user data to be passed to the @a callback
  * @return @c 0 on success, otherwise a negative error value
  * @retval #SOUND_POOL_ERROR_INVALID_PARAMETER Invalid parameter
  *         (@a pool is NULL or corrupted, or @a callback is NULL)

diff --git a/src/sound_pool.c b/src/sound_pool.c
index 66d51fd..597c979 100644 (file)
--- a/src/sound_pool.c
+++ b/src/sound_pool.c
@@ -100,7 +100,6 @@ sound_pool_error_e sound_pool_unload_source(sound_pool_h pool, const char *tag)
        sound_pool_error_e ret = _sound_pool_get_source_by_tag(_pool, tag, &_source);
        SP_RETVM_IF(ret != SOUND_POOL_ERROR_NONE, ret, "Error occurred when "
                        "getting sound source [%s] from the sound pool", tag);
-       SP_INST_CHECK(_source, SOUND_POOL_ERROR_INVALID_OPERATION);
 
        ret = _sound_source_destroy(_source);
        SP_RETVM_IF(ret != SOUND_POOL_ERROR_NONE, ret, "Error occurred when "
@@ -123,7 +122,6 @@ sound_pool_error_e sound_pool_stream_play(sound_pool_h pool, const char *tag,
        sound_pool_error_e ret = _sound_pool_get_source_by_tag(_pool, tag, &_source);
        SP_RETVM_IF(ret != SOUND_POOL_ERROR_NONE, ret, "Error occurred when "
                        "getting sound source [%s] from the sound pool", tag);
-       SP_INST_CHECK(_source, SOUND_POOL_ERROR_INVALID_OPERATION);
 
        sound_stream_t *_stream = NULL;
        ret = _sound_stream_create(_source, &_stream);
@@ -172,7 +170,6 @@ sound_pool_error_e sound_pool_stream_pause(sound_pool_h pool, unsigned id)
        sound_pool_error_e ret = _sound_pool_get_stream_by_id(_pool, id, &_stream);
        SP_RETVM_IF(ret != SOUND_POOL_ERROR_NONE, ret, "Error occurred when "
                        "getting sound stream [%u] from the sound pool", id);
-       SP_INST_CHECK(_stream, SOUND_POOL_ERROR_INVALID_OPERATION);
 
        ret = _sound_stream_pause(_stream);
        SP_RETVM_IF(ret != SOUND_POOL_ERROR_NONE, ret, "Error occurred when "
@@ -192,7 +189,6 @@ sound_pool_error_e sound_pool_stream_resume(sound_pool_h pool, unsigned id)
        sound_pool_error_e ret = _sound_pool_get_stream_by_id(_pool, id, &_stream);
        SP_RETVM_IF(ret != SOUND_POOL_ERROR_NONE, ret, "Error occurred when "
                        "getting sound stream [%u] from the sound pool", id);
-       SP_INST_CHECK(_stream, SOUND_POOL_ERROR_INVALID_OPERATION);
 
        ret = _sound_stream_resume(_stream);
        SP_RETVM_IF(ret != SOUND_POOL_ERROR_NONE, ret, "Error occurred when "
@@ -213,7 +209,6 @@ sound_pool_error_e sound_pool_stream_stop(sound_pool_h pool, unsigned id)
        sound_pool_error_e ret = _sound_pool_get_stream_by_id(_pool, id, &_stream);
        SP_RETVM_IF(ret != SOUND_POOL_ERROR_NONE, ret, "Error occurred when "
                        "getting sound stream [%u] from the sound pool", id);
-       SP_INST_CHECK(_stream, SOUND_POOL_ERROR_INVALID_OPERATION);
 
        ret = _sound_stream_stop(_stream);
        SP_RETVM_IF(ret != SOUND_POOL_ERROR_NONE, ret, "Error occurred when "
@@ -293,7 +288,6 @@ sound_pool_error_e sound_pool_stream_get_state(sound_pool_h pool, unsigned id,
        sound_pool_error_e ret = _sound_pool_get_stream_by_id(_pool, id, &_stream);
        SP_RETVM_IF(ret != SOUND_POOL_ERROR_NONE, ret, "Error occurred when "
                        "getting sound stream [%u] from the sound pool", id);
-       SP_INST_CHECK(_stream, SOUND_POOL_ERROR_INVALID_OPERATION);
 
        ret = _sound_stream_get_state(_stream, state);
        SP_RETVM_IF(ret != SOUND_POOL_ERROR_NONE, ret, "Error occurred when "
@@ -313,7 +307,6 @@ sound_pool_error_e sound_pool_stream_set_loop(sound_pool_h pool, unsigned id,
        sound_pool_error_e ret = _sound_pool_get_stream_by_id(_pool, id, &_stream);
        SP_RETVM_IF(ret != SOUND_POOL_ERROR_NONE, ret, "Error occurred when "
                        "getting sound stream [%u] from the sound pool", id);
-       SP_INST_CHECK(_stream, SOUND_POOL_ERROR_INVALID_OPERATION);
 
        ret = _sound_stream_set_loop(_stream, loop);
        SP_RETVM_IF(ret != SOUND_POOL_ERROR_NONE, ret, "Error occurred when "
@@ -333,7 +326,6 @@ sound_pool_error_e sound_pool_stream_get_loop(sound_pool_h pool, unsigned id,
        sound_pool_error_e ret = _sound_pool_get_stream_by_id(_pool, id, &_stream);
        SP_RETVM_IF(ret != SOUND_POOL_ERROR_NONE, ret, "Error occurred when "
                        "getting sound stream [%u] from the sound pool", id);
-       SP_INST_CHECK(_stream, SOUND_POOL_ERROR_INVALID_OPERATION);
 
        ret = _sound_stream_get_loop(_stream, loop);
        SP_RETVM_IF(ret != SOUND_POOL_ERROR_NONE, ret, "Error occurred when "
@@ -353,7 +345,6 @@ sound_pool_error_e sound_pool_stream_set_volume(sound_pool_h pool, unsigned id,
        sound_pool_error_e ret = _sound_pool_get_stream_by_id(_pool, id, &_stream);
        SP_RETVM_IF(ret != SOUND_POOL_ERROR_NONE, ret, "Error occurred when "
                        "getting sound stream [%u] from the sound pool", id);
-       SP_INST_CHECK(_stream, SOUND_POOL_ERROR_INVALID_OPERATION);
 
        ret = _sound_stream_set_volume(_stream, volume);
        SP_RETVM_IF(ret != SOUND_POOL_ERROR_NONE, ret, "Error occurred when "
@@ -373,7 +364,6 @@ sound_pool_error_e sound_pool_stream_get_volume(sound_pool_h pool, unsigned id,
        sound_pool_error_e ret = _sound_pool_get_stream_by_id(_pool, id, &_stream);
        SP_RETVM_IF(ret != SOUND_POOL_ERROR_NONE, ret, "Error occurred when "
                        "getting sound stream [%u] from the sound pool", id);
-       SP_INST_CHECK(_stream, SOUND_POOL_ERROR_INVALID_OPERATION);
 
        ret = _sound_stream_get_volume(_stream, volume);
        SP_RETVM_IF(ret != SOUND_POOL_ERROR_NONE, ret, "Error occurred when "
@@ -393,7 +383,6 @@ sound_pool_error_e sound_pool_stream_set_priority(sound_pool_h pool,
        sound_pool_error_e ret = _sound_pool_get_stream_by_id(_pool, id, &_stream);
        SP_RETVM_IF(ret != SOUND_POOL_ERROR_NONE, ret, "Error occurred when "
                        "getting sound stream [%u] from the sound pool", id);
-       SP_INST_CHECK(_stream, SOUND_POOL_ERROR_INVALID_OPERATION);
 
        ret = _sound_stream_set_priority(_stream, priority);
        SP_RETVM_IF(ret != SOUND_POOL_ERROR_NONE, ret, "Error occurred when "
@@ -413,7 +402,6 @@ sound_pool_error_e sound_pool_stream_get_priority(sound_pool_h pool,
        sound_pool_error_e ret = _sound_pool_get_stream_by_id(_pool, id, &_stream);
        SP_RETVM_IF(ret != SOUND_POOL_ERROR_NONE, ret, "Error occurred when "
                        "getting sound stream [%u] from the sound pool", id);
-       SP_INST_CHECK(_stream, SOUND_POOL_ERROR_INVALID_OPERATION);
 
        ret = _sound_stream_get_priority(_stream, priority);
        SP_RETVM_IF(ret != SOUND_POOL_ERROR_NONE, ret, "Error occurred when "
@@ -459,7 +447,6 @@ sound_pool_error_e sound_pool_stream_set_state_change_callback(
        sound_pool_error_e ret = _sound_pool_get_stream_by_id(_pool, id, &_stream);
        SP_RETVM_IF(ret != SOUND_POOL_ERROR_NONE, ret, "Error occurred when "
                        "getting sound stream [%u] from the sound pool", id);
-       SP_INST_CHECK(_stream, SOUND_POOL_ERROR_INVALID_OPERATION);
 
        ret = _sound_stream_set_callback(_stream, callback, data);
        SP_RETVM_IF(ret != SOUND_POOL_ERROR_NONE, ret, "Error occurred when "
@@ -479,7 +466,6 @@ sound_pool_error_e sound_pool_stream_unset_state_change_callback(
        sound_pool_error_e ret = _sound_pool_get_stream_by_id(_pool, id, &_stream);
        SP_RETVM_IF(ret != SOUND_POOL_ERROR_NONE, ret, "Error occurred when "
                        "getting sound stream [%u] from the sound pool", id);
-       SP_INST_CHECK(_stream, SOUND_POOL_ERROR_INVALID_OPERATION);
 
        ret = _sound_stream_unset_callback(_stream);
        SP_RETVM_IF(ret != SOUND_POOL_ERROR_NONE, ret, "Error occurred when "