Revise descriptions - Reorder returned values

[Version] 0.1.67
[Issue Type] Doxygen

Change-Id: I3b32b4e3948609c9f8a0171f9a90f8bb60d7be87
Signed-off-by: Sangchul Lee <sc11.lee@samsung.com>

diff --git a/include/media_streamer.h b/include/media_streamer.h
index ed9ed4e..9213a56 100644 (file)
--- a/include/media_streamer.h
+++ b/include/media_streamer.h
@@ -795,9 +795,9 @@ int media_streamer_create(media_streamer_h *streamer);
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #MEDIA_STREAMER_ERROR_NONE Successful
- * @retval #MEDIA_STREAMER_ERROR_INVALID_STATE Invalid state
  * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
+ * @retval #MEDIA_STREAMER_ERROR_INVALID_STATE Invalid state
  * @pre The media streamer state must be set to #MEDIA_STREAMER_STATE_IDLE
  *      by calling media_streamer_create() or media_streamer_unprepare().
  * @pre At least one source and one sink should be added and linked in the streamer
@@ -816,9 +816,9 @@ int media_streamer_prepare(media_streamer_h streamer);
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #MEDIA_STREAMER_ERROR_NONE Successful
- * @retval #MEDIA_STREAMER_ERROR_INVALID_STATE Invalid state
  * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
+ * @retval #MEDIA_STREAMER_ERROR_INVALID_STATE Invalid state
  * @pre The media streamer state should be higher than #MEDIA_STREAMER_STATE_IDLE.
  * @post The media streamer state will be #MEDIA_STREAMER_STATE_IDLE.
  * @see media_streamer_prepare()
@@ -833,9 +833,9 @@ int media_streamer_unprepare(media_streamer_h streamer);
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #MEDIA_STREAMER_ERROR_NONE Successful
- * @retval #MEDIA_STREAMER_ERROR_INVALID_STATE Invalid state
  * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
+ * @retval #MEDIA_STREAMER_ERROR_INVALID_STATE Invalid state
  * @pre The media streamer state must be set to #MEDIA_STREAMER_STATE_READY by calling media_streamer_prepare() or
  *      set to #MEDIA_STREAMER_STATE_PAUSED by calling media_streamer_pause().
  * @post The media streamer state will be #MEDIA_STREAMER_STATE_PLAYING.
@@ -852,9 +852,9 @@ int media_streamer_play(media_streamer_h streamer);
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #MEDIA_STREAMER_ERROR_NONE Successful
- * @retval #MEDIA_STREAMER_ERROR_INVALID_STATE Invalid state
  * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
+ * @retval #MEDIA_STREAMER_ERROR_INVALID_STATE Invalid state
  * @pre The media streamer state must be set to #MEDIA_STREAMER_STATE_PLAYING.
  * @post The media streamer state will be #MEDIA_STREAMER_STATE_PAUSED.
  * @see media_streamer_create()
@@ -869,9 +869,9 @@ int media_streamer_pause(media_streamer_h streamer);
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #MEDIA_STREAMER_ERROR_NONE Successful
- * @retval #MEDIA_STREAMER_ERROR_INVALID_STATE Invalid state
  * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
+ * @retval #MEDIA_STREAMER_ERROR_INVALID_STATE Invalid state
  * @pre The media streamer state must be set to #MEDIA_STREAMER_STATE_PLAYING by calling media_streamer_play() or
  *      set to #MEDIA_STREAMER_STATE_PAUSED by calling media_streamer_pause().
  * @post The media streamer state will be #MEDIA_STREAMER_STATE_READY.
@@ -893,9 +893,9 @@ int media_streamer_stop(media_streamer_h streamer);
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #MEDIA_STREAMER_ERROR_NONE Successful
- * @retval #MEDIA_STREAMER_ERROR_INVALID_STATE Invalid state
  * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
+ * @retval #MEDIA_STREAMER_ERROR_INVALID_STATE Invalid state
  * @pre Create a media streamer handle by calling media_streamer_create().
  * @post The media streamer state will be #MEDIA_STREAMER_STATE_NONE.
  * @see media_streamer_create()
@@ -914,9 +914,9 @@ int media_streamer_destroy(media_streamer_h streamer);
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #MEDIA_STREAMER_ERROR_NONE    Successful
- * @retval #MEDIA_STREAMER_ERROR_INVALID_STATE Invalid state
  * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
+ * @retval #MEDIA_STREAMER_ERROR_INVALID_STATE Invalid state
  * @retval #MEDIA_STREAMER_ERROR_SEEK_FAILED Seek operation failure
  * @pre The media streamer state must be one of these: #MEDIA_STREAMER_STATE_PAUSED, or #MEDIA_STREAMER_STATE_PLAYING.
  * @post It invokes media_streamer_set_play_position() when seek operation completes, if you set a callback.
@@ -933,9 +933,9 @@ int media_streamer_set_play_position(media_streamer_h streamer, int time,
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #MEDIA_STREAMER_ERROR_NONE Successful
- * @retval #MEDIA_STREAMER_ERROR_INVALID_STATE Invalid state
  * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
+ * @retval #MEDIA_STREAMER_ERROR_INVALID_STATE Invalid state
  * @pre The media streamer state must be one of these: #MEDIA_STREAMER_STATE_PAUSED, or #MEDIA_STREAMER_STATE_PLAYING.
  * @see media_streamer_set_play_position()
  */
@@ -951,9 +951,9 @@ int media_streamer_get_play_position(media_streamer_h streamer, int *time);
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #MEDIA_STREAMER_ERROR_NONE Successful
- * @retval #MEDIA_STREAMER_ERROR_INVALID_STATE Invalid state
  * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
+ * @retval #MEDIA_STREAMER_ERROR_INVALID_STATE Invalid state
  * @pre The media streamer state must be one of these: #MEDIA_STREAMER_STATE_PAUSED, or #MEDIA_STREAMER_STATE_PLAYING.
  */
 int media_streamer_get_duration(media_streamer_h streamer, int *duration);
@@ -985,10 +985,10 @@ int media_streamer_get_state(media_streamer_h streamer, media_streamer_state_e *
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #MEDIA_STREAMER_ERROR_NONE Successful
+ * @retval #MEDIA_STREAMER_ERROR_NOT_SUPPORTED Not supported
+ * @retval #MEDIA_STREAMER_ERROR_PERMISSION_DENIED Permission denied
  * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
- * @retval #MEDIA_STREAMER_ERROR_PERMISSION_DENIED Permission denied
- * @retval #MEDIA_STREAMER_ERROR_NOT_SUPPORTED Not supported
  * @see #media_streamer_node_src_type_e
  * @see media_streamer_node_destroy()
  */
@@ -1023,10 +1023,10 @@ int media_streamer_node_push_packet(media_streamer_node_h src, media_packet_h pa
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #MEDIA_STREAMER_ERROR_NONE Successful
+ * @retval #MEDIA_STREAMER_ERROR_NOT_SUPPORTED Not supported
+ * @retval #MEDIA_STREAMER_ERROR_PERMISSION_DENIED Permission denied
  * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
- * @retval #MEDIA_STREAMER_ERROR_PERMISSION_DENIED Permission denied
- * @retval #MEDIA_STREAMER_ERROR_NOT_SUPPORTED Not supported
  * @see #media_streamer_node_sink_type_e
  * @see media_streamer_node_destroy()
  */
@@ -1041,9 +1041,9 @@ int media_streamer_node_create_sink(media_streamer_node_sink_type_e type, media_
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #MEDIA_STREAMER_ERROR_NONE Successful
- * @retval #MEDIA_STREAMER_ERROR_INVALID_STATE Invalid state
  * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
+ * @retval #MEDIA_STREAMER_ERROR_INVALID_STATE Invalid state
  * @pre Create a sink node handle by calling media_streamer_node_create_sink().
  * @pre Set media_streamer_sink_data_ready_cb by calling media_streamer_sink_set_data_ready_cb().
  * @see #media_packet_h
@@ -1067,10 +1067,10 @@ int media_streamer_node_pull_packet(media_streamer_node_h sink, media_packet_h *
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #MEDIA_STREAMER_ERROR_NONE Successful
+ * @retval #MEDIA_STREAMER_ERROR_NOT_SUPPORTED Not supported
+ * @retval #MEDIA_STREAMER_ERROR_PERMISSION_DENIED Permission denied
  * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
- * @retval #MEDIA_STREAMER_ERROR_PERMISSION_DENIED Permission denied
- * @retval #MEDIA_STREAMER_ERROR_NOT_SUPPORTED Not supported
  * @see #media_streamer_node_type_e
  * @see #media_format_h
  * @see media_streamer_node_destroy()
@@ -1086,9 +1086,9 @@ int media_streamer_node_create(media_streamer_node_type_e type, media_format_h i
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #MEDIA_STREAMER_ERROR_NONE Successful
- * @retval #MEDIA_STREAMER_ERROR_INVALID_STATE Invalid state
  * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
+ * @retval #MEDIA_STREAMER_ERROR_INVALID_STATE Invalid state
  * @pre Create media streamer handle by calling media_streamer_create().
  * @pre Create node handle by calling media_streamer_node_create().
  * @see media_streamer_create()
@@ -1105,9 +1105,9 @@ int media_streamer_node_add(media_streamer_h streamer, media_streamer_node_h nod
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #MEDIA_STREAMER_ERROR_NONE Successful
- * @retval #MEDIA_STREAMER_ERROR_INVALID_STATE Invalid state
  * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
+ * @retval #MEDIA_STREAMER_ERROR_INVALID_STATE Invalid state
  * @pre Create node handle by calling media_streamer_node_create().
  * @pre If the node was added to media streamer, it has to be removed by calling media_streamer_node_remove().
  * @see media_streamer_node_create()
@@ -1127,9 +1127,9 @@ int media_streamer_node_destroy(media_streamer_node_h node);
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #MEDIA_STREAMER_ERROR_NONE Successful
- * @retval #MEDIA_STREAMER_ERROR_INVALID_STATE Invalid state
  * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
+ * @retval #MEDIA_STREAMER_ERROR_INVALID_STATE Invalid state
  * @pre Add node to streamer by calling media_streamer_node_add().
  * @see media_streamer_node_add()
  */
@@ -1153,9 +1153,9 @@ int media_streamer_node_remove(media_streamer_h streamer, media_streamer_node_h
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #MEDIA_STREAMER_ERROR_NONE Successful
- * @retval #MEDIA_STREAMER_ERROR_INVALID_STATE Invalid state
  * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
+ * @retval #MEDIA_STREAMER_ERROR_INVALID_STATE Invalid state
  * @pre Create node handles by calling media_streamer_node_create(), media_streamer_node_create_src(), or media_streamer_node_create_sink().
  *      And add the nodes into streamer by calling media_streamer_node_add().
  * @see media_streamer_node_create()
@@ -1175,9 +1175,9 @@ int media_streamer_node_link(media_streamer_node_h node1, const char *src_pad_na
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #MEDIA_STREAMER_ERROR_NONE Successful
- * @retval #MEDIA_STREAMER_ERROR_INVALID_STATE Invalid state
  * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
+ * @retval #MEDIA_STREAMER_ERROR_INVALID_STATE Invalid state
  * @pre Create a node handle by calling media_streamer_node_create(), media_streamer_node_create_src(), or media_streamer_node_create_sink().
  * @pre Get pad name by calling media_streamer_node_get_pad_name().
  * @see #media_format_h
@@ -1193,9 +1193,9 @@ int media_streamer_node_set_pad_format(media_streamer_node_h node, const char *p
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #MEDIA_STREAMER_ERROR_NONE Successful
- * @retval #MEDIA_STREAMER_ERROR_INVALID_STATE Invalid state
  * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
+ * @retval #MEDIA_STREAMER_ERROR_INVALID_STATE Invalid state
  * @pre Create a node handle by calling media_streamer_node_create(), media_streamer_node_create_src(), or media_streamer_node_create_sink().
  * @pre Get pad name by calling media_streamer_node_get_pad_name().
  * @see #media_format_h
@@ -1238,10 +1238,10 @@ int media_streamer_node_get_pad_name(media_streamer_node_h node, char ***src_pad
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #MEDIA_STREAMER_ERROR_NONE Successful
- * @retval #MEDIA_STREAMER_ERROR_INVALID_STATE Invalid state
+ * @retval #MEDIA_STREAMER_ERROR_PERMISSION_DENIED Permission denied
  * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
- * @retval #MEDIA_STREAMER_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #MEDIA_STREAMER_ERROR_INVALID_STATE Invalid state
  * @pre Create a node handle by calling media_streamer_node_create(), media_streamer_node_create_src(), or media_streamer_node_create_sink().
  * @pre Get param list to set by calling media_streamer_node_get_params().
  * @see media_streamer_node_create()
@@ -1260,9 +1260,9 @@ int media_streamer_node_set_params(media_streamer_node_h node, bundle *param_lis
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #MEDIA_STREAMER_ERROR_NONE Successful
- * @retval #MEDIA_STREAMER_ERROR_INVALID_STATE Invalid state
  * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
+ * @retval #MEDIA_STREAMER_ERROR_INVALID_STATE Invalid state
  * @pre Create a node handle by calling media_streamer_node_create(), media_streamer_node_create_src(), or media_streamer_node_create_sink().
  * @post Set params which are needed to set by calling media_streamer_node_set_params() or media_streamer_node_set_param().
  * @see media_streamer_node_create()
@@ -1285,10 +1285,10 @@ int media_streamer_node_get_params(media_streamer_node_h node, bundle **param_li
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #MEDIA_STREAMER_ERROR_NONE Successful
- * @retval #MEDIA_STREAMER_ERROR_INVALID_STATE Invalid state
+ * @retval #MEDIA_STREAMER_ERROR_PERMISSION_DENIED Permission denied
  * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
- * @retval #MEDIA_STREAMER_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #MEDIA_STREAMER_ERROR_INVALID_STATE Invalid state
  * @pre Create a node handle by calling media_streamer_node_create(), media_streamer_node_create_src(), or media_streamer_node_create_sink().
  * @pre Get param list to set by calling media_streamer_node_get_params().
  * @see media_streamer_node_create()
@@ -1310,9 +1310,9 @@ int media_streamer_node_set_param(media_streamer_node_h node,
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #MEDIA_STREAMER_ERROR_NONE Successful
- * @retval #MEDIA_STREAMER_ERROR_INVALID_STATE Invalid state
  * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
+ * @retval #MEDIA_STREAMER_ERROR_INVALID_STATE Invalid state
  * @pre Create a node handle by calling media_streamer_node_create(), media_streamer_node_create_src(), or media_streamer_node_create_sink().
  * @pre Get param list to know the param name by calling media_streamer_node_get_params().
  * @see media_streamer_node_create()

diff --git a/packaging/capi-media-streamer.spec b/packaging/capi-media-streamer.spec
index 766f7b9..3176aec 100644 (file)
--- a/packaging/capi-media-streamer.spec
+++ b/packaging/capi-media-streamer.spec
@@ -1,6 +1,6 @@
 Name:       capi-media-streamer
 Summary:    A Media Streamer API
-Version:    0.1.66
+Version:    0.1.67
 Release:    0
 Group:      Multimedia/API
 License:    Apache-2.0