Add @remarks for release information of parameters

[Version] 0.1.80
[Issue Type] Doxygen

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

diff --git a/include/media_streamer.h b/include/media_streamer.h
index efd9dda..682c1d3 100644 (file)
--- a/include/media_streamer.h
+++ b/include/media_streamer.h
@@ -782,7 +782,7 @@ int media_streamer_sink_unset_eos_cb(media_streamer_node_h sink);
  * @brief Creates an instance of media streamer and
  *        passes the handle to the caller.
  * @since_tizen 3.0
- * @remarks You must release @a streamer using media_streamer_destroy()
+ * @remarks The @a streamer should be released using media_streamer_destroy().
  * @param[out] streamer    Media streamer handle
  * @return @c 0 on success,
  *         otherwise a negative error value
@@ -1021,7 +1021,7 @@ int media_streamer_node_push_packet(media_streamer_node_h src, media_packet_h pa
  * @brief Creates media streamer sink node.
  * @since_tizen 3.0
  * @remarks The internet privilege(%http://tizen.org/privilege/internet) should be added if any URIs are used to transmit the output data.
- *          You can release @a sink node using media_streamer_node_destroy()
+ *          You can release @a sink node using media_streamer_node_destroy().
  * @remarks If @a type is #MEDIA_STREAMER_NODE_SINK_TYPE_ADAPTIVE, the HTTP server will be started and the server will be able to transmit the output data to the other device.
  *          The application must have an authentication responsibility between a server and client because the data transmission is not secure.
  * @param[in]  type     Type of sink node to be created
@@ -1042,6 +1042,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 type node.
  * @since_tizen 3.0
+ * @remarks The @a packet should be released using media_packet_destroy().
  * @param[in] sink      Media streamer sink node handle
  * @param[out] packet   Media packet handle
  * @return @c 0 on success,
@@ -1194,6 +1195,7 @@ int media_streamer_node_set_pad_format(media_streamer_node_h node, const char *p
 /**
  * @brief Gets media format for pad of media streamer node.
  * @since_tizen 3.0
+ * @remarks The @a fmt should be released using media_format_unref().
  * @param[in] node        Media streamer node handle
  * @param[in] pad_name    Pad name
  * @param[out] fmt        Media format handle
@@ -1212,7 +1214,7 @@ int media_streamer_node_get_pad_format(media_streamer_node_h node, const char *p
 /**
  * @brief Gets name of node pads.
  * @since_tizen 3.0
- * @remarks After using the src_pad_name and sink_pad_name, it has to be freed.
+ * @remarks The @a src_pad_name and the @a sink_pad_name should be released using free().
  *          src_pad_name or sink_pad_name can be null according to the node type.
  *          In case of source type node, sink_pad_name will be null.
  *          In case of sink type node, src_pad_name will be null.
@@ -1255,12 +1257,13 @@ int media_streamer_node_get_pad_name(media_streamer_node_h node, char ***src_pad
  * @see media_streamer_node_create_src()
  * @see media_streamer_node_create_sink()
  * @see media_streamer_node_get_params()
+ * @see #bundle
  */
 int media_streamer_node_set_params(media_streamer_node_h node, bundle *param_list);
 /**
  * @brief Gets node parameter list.
  * @since_tizen 3.0
- * @remarks After using param_list, it has to be freed by calling bundle_free() in bundle.h
+ * @remarks The @a param_list should be released using bundle_free().
  *          Refer to the "Parameter information of node" in this file to get info.
  * @param[in]  node         Media streamer node handle
  * @param[out] param_list   Key value array of media streamer node parameters
@@ -1277,6 +1280,7 @@ int media_streamer_node_set_params(media_streamer_node_h node, bundle *param_lis
  * @see media_streamer_node_create_sink()
  * @see media_streamer_node_set_params()
  * @see media_streamer_node_set_param()
+ * @see #bundle
  */
 int media_streamer_node_get_params(media_streamer_node_h node, bundle **param_list);
 
@@ -1311,6 +1315,7 @@ int media_streamer_node_set_param(media_streamer_node_h node,
  * @brief Gets value of parameter.
  * @details Gets parameter one by one without creating param bundle.
  * @since_tizen 3.0
+ * @remarks The @a param_value should be released using free().
  * @param[in] node         Media streamer node handle
  * @param[in] param_name   Param name of node
  * @param[out] param_value Param value of node

diff --git a/packaging/capi-media-streamer.spec b/packaging/capi-media-streamer.spec
index 906654d..dd71710 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.79
+Version:    0.1.80
 Release:    0
 Group:      Multimedia/API
 License:    Apache-2.0