Add remarks regarding the specific error to the doxygen of wav_player_stop() 78/230778/2 accepted/tizen/unified/20200416.164716 submit/tizen/20200416.085903
authorSangchul Lee <sc11.lee@samsung.com>
Tue, 14 Apr 2020 06:10:18 +0000 (15:10 +0900)
committerSangchul Lee <sc11.lee@samsung.com>
Tue, 14 Apr 2020 06:35:31 +0000 (15:35 +0900)
@remarks
 If the playback of @a id has been already finished at the
 server side and wav_player_playback_completed_cb() is not
 invoked yet, WAV_PLAYER_ERROR_INVALID_OPERATION will be returned.

[Version] 0.3.1
[Issue Type] Doxygen

Change-Id: If45df2c54642bf69fb6de633cb2839d97acdc226
Signed-off-by: Sangchul Lee <sc11.lee@samsung.com>
include/wav_player.h
packaging/capi-media-wav-player.spec

index 8cf1251..96ecd56 100644 (file)
@@ -132,6 +132,10 @@ int wav_player_start_loop(const char *path, sound_stream_info_h stream_info, uns
 /**
  * @brief Stops playing the WAV file.
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ *
+ * @remarks If the playback of @a id has been already finished at the server side and\n
+ *     wav_player_playback_completed_cb() is not invoked yet, #WAV_PLAYER_ERROR_INVALID_OPERATION will be returned.
+ *
  * @param[in] id       The WAV player ID to stop
  *
  * @return 0 on success, otherwise a negative error value.
index 5197fbe..d440579 100755 (executable)
@@ -1,6 +1,6 @@
 Name:       capi-media-wav-player
 Summary:    A wav player library in Tizen C API
-Version:    0.3.0
+Version:    0.3.1
 Release:    0
 Group:      Multimedia/API
 License:    Apache-2.0