Revise descriptions - Add missing punctuation mark in @details 89/236389/2
authorSangchul Lee <sc11.lee@samsung.com>
Tue, 16 Jun 2020 14:42:34 +0000 (23:42 +0900)
committerSangchul Lee <sc11.lee@samsung.com>
Wed, 17 Jun 2020 00:54:46 +0000 (09:54 +0900)
[Version] 0.1.68
[Issue Type] Doxygen

Change-Id: Ib6bb6e12f9c8fa1826531564c0c8a7f351bc199f
Signed-off-by: Sangchul Lee <sc11.lee@samsung.com>
include/media_streamer.h
packaging/capi-media-streamer.spec

index 9213a56..b2cb51a 100644 (file)
@@ -213,8 +213,8 @@ typedef enum {
 #define MEDIA_STREAMER_PARAM_IS_LIVE_STREAM "is-live"
 
 /**
- * @brief Definition for uri parameter of source node.
- * @details URI to read from
+ * @brief Definition for URI parameter of source node.
+ * @details URI to read from.
  *          Data type is string.
  * @since_tizen 3.0
  * @see media_streamer_node_get_params()
@@ -421,7 +421,7 @@ typedef enum {
 
 /**
  * @brief Definition for segment location parameter of adaptive sink node.
- * @details Path for writing playlist from
+ * @details Path for writing playlist from.
  *          Data type is string.
  * @since_tizen 3.0
  * @see media_streamer_node_get_params()
@@ -491,7 +491,7 @@ typedef void (*media_streamer_custom_buffer_status_cb)(media_streamer_node_h src
 
 /**
  * @brief Called when new data is available from custom sink.
- * @details This callback can be applied only to #MEDIA_STREAMER_NODE_SINK_TYPE_CUSTOM sink type
+ * @details This callback can be applied only to #MEDIA_STREAMER_NODE_SINK_TYPE_CUSTOM sink type node.
  * @since_tizen 3.0
  * @param[in] sink      Media streamer sink node handle
  * @param[in] user_data The user data passed from the code where
@@ -506,7 +506,7 @@ typedef void (*media_streamer_sink_data_ready_cb)(media_streamer_node_h sink, vo
 
 /**
  * @brief  Called when the end-of-stream has been reached.
- * @details This callback can be applied only to #MEDIA_STREAMER_NODE_SINK_TYPE_CUSTOM sink type
+ * @details This callback can be applied only to #MEDIA_STREAMER_NODE_SINK_TYPE_CUSTOM sink type node.
  * @since_tizen 3.0
  * @param[in] sink      Media streamer sink node handle
  * @param[in] user_data The user data passed from the code where
@@ -669,7 +669,7 @@ int media_streamer_unset_interrupted_cb(media_streamer_h streamer);
 
 /**
  * @brief Sets a callback function to be invoked when buffer underrun or overflow is occurred.
- * @details This function can be called only for #MEDIA_STREAMER_NODE_SRC_TYPE_CUSTOM source type
+ * @details This function can be called only for #MEDIA_STREAMER_NODE_SRC_TYPE_CUSTOM source type node.
  * @since_tizen 3.0
  * @remarks This function is used for media stream playback only.
  * @param[in] src       Media streamer source node handle
@@ -705,7 +705,7 @@ int media_streamer_src_unset_buffer_status_cb(media_streamer_node_h src);
 
 /**
  * @brief Sets a callback function to be called when the custom sink is ready for data processing.
- * @details This function can be called only for #MEDIA_STREAMER_NODE_SINK_TYPE_CUSTOM sink type
+ * @details This function can be called only for #MEDIA_STREAMER_NODE_SINK_TYPE_CUSTOM sink type node.
  * @since_tizen 3.0
  * @param[in] sink      Media streamer sink node handle
  * @param[in] callback  Callback function pointer
@@ -996,7 +996,7 @@ int media_streamer_node_create_src(media_streamer_node_src_type_e type, media_st
 
 /**
  * @brief Pushes packet into custom source node.
- * @details This function can be called only for #MEDIA_STREAMER_NODE_SRC_TYPE_CUSTOM.
+ * @details This function can be called only for #MEDIA_STREAMER_NODE_SRC_TYPE_CUSTOM type node.
  * @since_tizen 3.0
  * @param[in] src       Media streamer source node handle
  * @param[in] packet    Media packet handle
@@ -1034,7 +1034,7 @@ int media_streamer_node_create_sink(media_streamer_node_sink_type_e type, media_
 
 /**
  * @brief Pulls packet from custom sink node.
- * @details This function can be called only for #MEDIA_STREAMER_NODE_SINK_TYPE_CUSTOM
+ * @details This function can be called only for #MEDIA_STREAMER_NODE_SINK_TYPE_CUSTOM type node.
  * @since_tizen 3.0
  * @param[in] sink      Media streamer sink node handle
  * @param[out] packet   Media packet handle
@@ -1053,8 +1053,7 @@ int media_streamer_node_pull_packet(media_streamer_node_h sink, media_packet_h *
 
 /**
  * @brief Creates media streamer node except #MEDIA_STREAMER_NODE_TYPE_SRC and #MEDIA_STREAMER_NODE_TYPE_SINK.
- * @details Creates node specific @a type with specific format of input
- *          and output data.
+ * @details Creates node specific @a type with specific format of input and output data.
  * @since_tizen 3.0
  * @remarks The node type should not be #MEDIA_STREAMER_NODE_TYPE_SRC and #MEDIA_STREAMER_NODE_TYPE_SINK.
  *          To create source / sink type node, media_streamer_node_create_src() / media_streamer_node_create_sink() should be called.
index 3176aec..357471f 100644 (file)
@@ -1,6 +1,6 @@
 Name:       capi-media-streamer
 Summary:    A Media Streamer API
-Version:    0.1.67
+Version:    0.1.68
 Release:    0
 Group:      Multimedia/API
 License:    Apache-2.0