Remove unnecessary @since_tizen command in private headers 80/233180/2
authorSangchul Lee <sc11.lee@samsung.com>
Wed, 13 May 2020 01:20:18 +0000 (10:20 +0900)
committerSangchul Lee <sc11.lee@samsung.com>
Wed, 13 May 2020 01:36:47 +0000 (10:36 +0900)
[Version] 0.1.39
[Issue Type] Doxygen

Change-Id: I528b8ab30436d108398447fc1cff95a08df874d1
Signed-off-by: Sangchul Lee <sc11.lee@samsung.com>
include/media_streamer_gst.h
include/media_streamer_node.h
include/media_streamer_priv.h
include/media_streamer_util.h
packaging/capi-media-streamer.spec
src/media_streamer_node.c

index 9bafa7c..c1f77b1 100644 (file)
@@ -46,183 +46,132 @@ extern "C" {
 
 /**
  * @brief Generates dot files for GStreamer pipeline.
- *
- * @since_tizen 3.0
  */
 void __ms_generate_dots(GstElement *bin, gchar *name_tag);
 
 /**
  * @brief Creates GstElement by plugin name.
- *
- * @since_tizen 3.0
  */
 GstElement *__ms_element_create(const char *plugin_name, const char *name);
 
 /**
  * @brief Creates GstBin name for adaptive streaming.
- *
- * @since_tizen 3.0
  */
 GstElement *__ms_adaptive_element_create(void);
 
 /**
  * @brief Creates GstElement from specified node_plug_s structure.
- *
- * @since_tizen 3.0
  */
 GstElement *__ms_node_element_create(node_plug_s *plug_info, media_streamer_node_type_e type);
 
 /**
  * @brief Creates rtp container GstElement.
- *
- * @since_tizen 3.0
  */
 GstElement *__ms_rtp_element_create(void);
 
 /**
  * @brief Unlink all pads into GstElement.
- *
- * @since_tizen 3.0
  */
 gboolean __ms_element_unlink(GstElement *element);
 
 /**
  * @brief Remove GstElement from bin.
- *
- * @since_tizen 3.0
  */
 gboolean __ms_bin_remove_element(GstElement *element);
 
 /**
  * @brief Add GstElement into bin if not added before and refs it.
- *
- * @since_tizen 3.0
  */
 gboolean __ms_bin_add_element(GstElement *bin, GstElement *element, gboolean do_ref);
 
 /**
  * @brief Gets pad type of element pad.
- *
- * @since_tizen 3.0
  */
 const gchar *__ms_get_pad_type(GstPad *element_pad);
 /**
  * @brief Creates decodebin to link with sink part.
- *
- * @since_tizen 3.0
  */
 GstElement *__ms_decodebin_create(media_streamer_s *ms_streamer, char *name);
 
 /**
  * @brief Creates next element by klass or by properties and links with the previous one.
- *
- * @since_tizen 3.0
  */
 GstElement *__ms_combine_next_element(GstElement *previous_element, GstPad *prev_elem_src_pad, GstElement *bin_to_find_in, media_streamer_node_type_e node_type);
 
 /**
  * @brief Locks gst_element being contained in GValue data.
- *
- * @since_tizen 3.0
  */
 gboolean __ms_element_lock_state(const GValue *item, GValue *ret, gpointer user_data);
 
 /**
  * @brief Unlocks gst_element being contained in GValue data.
- *
- * @since_tizen 3.0
  */
 gboolean __ms_element_unlock_state(const GValue *item, GValue *ret, gpointer user_data);
 
 /**
  * @brief Gets state of media streamer.
- *
- * @since_tizen 3.0
  */
 void __ms_get_state(media_streamer_s *ms_streamer);
 
 /**
  * @brief Creates pipeline, bus and src/sink/transform bins.
- *
- * @since_tizen 3.0
  */
 int __ms_pipeline_create(media_streamer_s *ms_streamer);
 
 /**
  * @brief Prepares Media Streamer pipeline and autoplug nodes if needed.
  *
- * @since_tizen 3.0
  */
 int __ms_pipeline_prepare(media_streamer_s *ms_streamer);
 
 /**
  * @brief Unprepares Media Streamer pipeline and unlink nodes
  *        which user didn't link before.
- *
- * @since_tizen 3.0
  */
 int __ms_pipeline_unprepare(media_streamer_s *ms_streamer);
 
 /**
  * @brief Sets GstElement into state.
- *
- * @since_tizen 3.0
  */
 int __ms_element_set_state(GstElement *element, GstState state);
 
 /**
  * @brief Iterates pas inside gst element.
- *
- * @since_tizen 3.0
  */
 int __ms_element_pad_names(GstElement *element, GstPadDirection pad_type, char ***pad_name_array, int *pads_count);
 
 /**
  * @brief Gets mediaformat from the GstElement's pad by pad name.
- *
- * @since_tizen 3.0
  */
 int __ms_element_get_pad_fmt(GstElement *element, const char *pad_name, media_format_h *fmt);
 
 /**
  * @brief Sets mediaformat to the GstElement's pad.
- *
- * @since_tizen 3.0
  */
 int __ms_element_set_fmt(GstElement *element, const char *pad_name, media_format_h fmt);
 
 /**
  * @brief Creates GstCap's from mediaformat.
- *
- * @since_tizen 3.0
  */
 GstCaps *__ms_create_caps_from_fmt(media_format_h fmt);
 
 /**
  * @brief Seeks GstElement to according time value.
- *
- * @since_tizen 3.0
  */
 gboolean __ms_gst_seek(GstElement *element, gint64 g_time, GstSeekFlags seek_flag);
 
 /**
  * @brief Push the media packet buffer to the source element.
- *
- * @since_tizen 3.0
  */
 int __ms_element_push_packet(GstElement *src_element, media_packet_h packet);
 
 /**
  * @brief Pull the media packet buffer from sink element.
- *
- * @since_tizen 3.0
  */
 int __ms_element_pull_packet(GstElement *sink_element, media_packet_h *packet);
 
 /**
  * @brief Finds type of media
- *
- * @since_tizen 3.0
  */
 int __ms_find_type(media_streamer_s *ms_streamer, GstElement *element);
 
index 7f1cced..e39d424 100644 (file)
@@ -25,134 +25,96 @@ extern "C" {
 
 /**
  * @brief Gets Node's information by its type.
- *
- * @since_tizen 3.0
  */
 node_info_s *__ms_node_get_klass_by_its_type(media_streamer_node_type_e element_type);
 
 /**
  * @brief Creates media streamer node using input and output format.
- *
- * @since_tizen 3.0
  */
 int __ms_node_create(media_streamer_node_s *node, media_format_h in_fmt, media_format_h out_fmt);
 
 /**
  * @brief Creates media streamer source node.
- *
- * @since_tizen 3.0
  */
 int __ms_src_node_create(media_streamer_node_s *node);
 
 /**
  * @brief Creates media streamer sink node.
- *
- * @since_tizen 3.0
  */
 int __ms_sink_node_create(media_streamer_node_s *node);
 
 /**
  * @brief Destroys media streamer node.
- *
- * @since_tizen 3.0
  */
 void __ms_node_destroy(media_streamer_node_s *node);
 
 /**
  * @brief Adds node to bin
- *
- * @since_tizen 3.0
  */
 int __ms_add_node_into_bin(media_streamer_s *ms_streamer, media_streamer_node_s *node);
 
 /**
  * @brief Prepares source node for adaptive streaming.
- *
- * @since_tizen 3.0
  */
 int __ms_adaptive_src_node_prepare(media_streamer_node_s *node, bool auto_plug);
 
 /**
  * @brief Prepares sink node for adaptive streaming.
- *
- * @since_tizen 3.0
  */
 int __ms_adaptive_sink_node_prepare(media_streamer_s *ms_streamer, media_streamer_node_s *node);
 
 /**
  * @brief Prepares rtp node.
- *
- * @since_tizen 3.0
  */
 gboolean __ms_rtp_node_prepare(media_streamer_node_s *node);
 
 /**
  * @brief Prepares demux node.
- *
- * @since_tizen 3.0
  */
 int __ms_demux_node_prepare(media_streamer_s *ms_streamer, media_streamer_node_s *node);
 
 /**
  * @brief Inserts media streamer node into nodes table.
- *
- * @since_tizen 3.0
  */
 int __ms_node_insert_into_table(GHashTable *nodes_table, media_streamer_node_s *node);
 
 /**
  * @brief Removes media streamer node from nodes table.
- *
- * @since_tizen 3.0
  */
 void __ms_node_remove_from_table(void *data);
 
 /**
  * @brief Reads node parameters from user's bundle object.
- *
- * @since_tizen 3.0
  */
 int __ms_node_set_params_from_bundle(media_streamer_node_s *node, bundle *param_list);
 
 /**
  * @brief Writes GstElement properties into user's bundle object.
- *
- * @since_tizen 3.0
  */
 int __ms_node_write_params_into_bundle(media_streamer_node_s *node, bundle *param_list);
 
 /**
  * @brief Gets node's parameter by param_name.
- *
- * @since_tizen 3.0
  */
 int __ms_node_get_param(media_streamer_node_s *node, const char *param_name, param_s **param);
 
 /**
  * @brief Gets list of all node's parameters.
- *
- * @since_tizen 3.0
  */
 int __ms_node_get_param_list(media_streamer_node_s *node, GList **param_list);
 
 /**
  * @brief Gets string value of node's parameter.
- *
- * @since_tizen 3.0
  */
 int __ms_node_get_param_value(media_streamer_node_s *node, param_s *param, char **string_value);
 
 /**
  * @brief Sets parameter value into node's parameter.
- *
- * @since_tizen 3.0
  */
 int __ms_node_set_param_value(media_streamer_node_s *node, param_s *param, const gchar *param_value);
 
 /**
  * @brief Sets media format value into node's pad.
- *
- * @since_tizen 3.0
  */
 int __ms_node_set_pad_format(media_streamer_node_s *node, const char *pad_name, media_format_h fmt);
 
index 5f040df..585a981 100644 (file)
@@ -33,8 +33,6 @@ struct media_streamer_node_s;
 
 /**
  * @brief Media Streamer callbacks structure.
- *
- * @since_tizen 3.0
  */
 typedef struct {
        void *callback;
@@ -43,8 +41,6 @@ typedef struct {
 
 /**
  * @brief Media Streamer sink callbacks structure.
- *
- * @since_tizen 3.0
  */
 typedef struct {
        media_streamer_callback_s data_ready_cb;
@@ -53,8 +49,6 @@ typedef struct {
 
 /**
  * @brief Media Streamer param type handle.
- *
- * @since_tizen 3.0
  */
 typedef struct {
        char *param_name;
@@ -63,8 +57,6 @@ typedef struct {
 
 /**
  * @brief Media Streamer node_info type handle.
- *
- * @since_tizen 3.0
  */
 typedef struct {
        char *klass_name;
@@ -73,8 +65,6 @@ typedef struct {
 
 /**
  * @brief Media Streamer node_plug type handle.
- *
- * @since_tizen 3.0
  */
 typedef struct {
        node_info_s *info;
@@ -85,8 +75,6 @@ typedef struct {
 
 /**
  * @brief Media Streamer type handle.
- *
- * @since_tizen 3.0
  */
 typedef struct {
        media_streamer_ini_t ini;
@@ -122,8 +110,6 @@ typedef struct {
 
 /**
  * @brief Media Streamer node type handle.
- *
- * @since_tizen 3.0
  */
 typedef struct {
        GstElement *gst_element;
@@ -148,47 +134,33 @@ typedef struct _media_streamer_wl_info_s {
        gint parent_id;
 } media_streamer_wl_info_s;
 
-/* Private functions definition */
-
 /**
  * @brief Gets the play position of Media streamer element.
- *
- * @since_tizen 3.0
  */
 int __ms_get_position(media_streamer_s *ms_streamer, int *time);
 
 /**
  * @brief Gets the duration of Media streamer element.
- *
- * @since_tizen 3.0
  */
 int __ms_get_duration(media_streamer_s *ms_streamer, int *time);
 
 /**
  * @brief Seeks Media streamer element to the pointed position.
- *
- * @since_tizen 3.0
  */
 int __ms_seek(media_streamer_s *ms_streamer, int time, bool flag);
 
 /**
  * @brief Destroys media streamer structure.
- *
- * @since_tizen 3.0
  */
 int __ms_destroy(media_streamer_s *ms_streamer);
 
 /**
  * @brief Creates media streamer structure.
- *
- * @since_tizen 3.0
  */
 int __ms_create(media_streamer_s *ms_streamer);
 
 /**
  * @brief Changes state of media streamer.
- *
- * @since_tizen 3.0
  */
 int __ms_state_change(media_streamer_s *ms_streamer, media_streamer_state_e state);
 
index 9829bf6..eed28c6 100644 (file)
@@ -107,8 +107,6 @@ extern "C" {
 
 /**
  * @brief Media Streamer ini settings structure.
- *
- * @since_tizen 3.0
  */
 typedef struct __media_streamer_ini {
        /* general */
@@ -121,8 +119,6 @@ typedef struct __media_streamer_ini {
 
 /**
  * @brief Media Streamer format type handle.
- *
- * @since_tizen 3.0
  */
 typedef struct {
        media_format_mimetype_e format;
@@ -131,8 +127,6 @@ typedef struct {
 
 /**
  * @brief Media Streamer signal structure.
- *
- * @since_tizen 3.0
  */
 typedef struct {
        GObject *obj;
@@ -256,80 +250,58 @@ typedef struct {
 /**
  * @brief Loads media streamer settings from ini file.
  *        The default values will be used if error has occurred.
- *
- * @since_tizen 3.0
  */
 void __ms_load_ini_settings(media_streamer_ini_t *ini);
 
 /**
  * @brief Read and copy string reading from ini file.
- *
- * @since_tizen 3.0
  */
 gchar *__ms_ini_get_string(const char *ini_path, const char *default_str);
 
 /**
  * @brief Reads comma-separated string list from ini file.
- *
- * @since_tizen 3.0
  */
 void __ms_ini_read_list(const char *key, gchar ***list);
 
 /**
  * @brief Converts Media Format mime type into Caps media format string.
- *
- * @since_tizen 3.0
  */
 const gchar *__ms_convert_mime_to_string_format(media_format_mimetype_e mime);
 
 /**
  * @brief Converts Media Format mime type into rtp media type.
- *
- * @since_tizen 3.0
  */
 const gchar *__ms_convert_mime_to_rtp_format(media_format_mimetype_e mime);
 
 /**
  * @brief Converts Caps stream format into Media Format mime type.
- *
- * @since_tizen 3.0
  */
 media_format_mimetype_e __ms_convert_string_format_to_media_format(const char *format_type);
 
 /**
  * @brief Creates Media streamer signal structure,
  *        connects it to object and appends it to signal list.
- *
- * @since_tizen 3.0
  */
 void __ms_signal_create(GList **sig_list, GstElement *obj, const char *sig_name, GCallback cb, gpointer user_data);
 
 /**
  * @brief Disconnects signal from object and
  * destroys Media streamer signal object.
- *
- * @since_tizen 3.0
  */
 void __ms_signal_destroy(void *data);
 
 /**
  * @brief Destroys the which set as rtp node parameter.
- *
- * @since_tizen 3.0
  */
 void __ms_param_value_destroy(gpointer data);
 
 /**
  * @brief Check URI is valid file
- *
- * @since_tizen 3.0
  */
 int __ms_util_uri_path_check(const char *file_uri);
 
 /**
  * @brief Iterates func over all elements contained within a bin.
- *
- * @since_tizen 3.0
  */
 int __ms_bin_foreach_elements(GstBin *bin, GstIteratorFoldFunction func, void *user_data);
 
index f410d5a..aa38712 100644 (file)
@@ -1,6 +1,6 @@
 Name:       capi-media-streamer
 Summary:    A Media Streamer API
-Version:    0.1.38
+Version:    0.1.39
 Release:    0
 Group:      Multimedia/API
 License:    Apache-2.0
index d4d4303..6901b84 100644 (file)
@@ -1778,11 +1778,6 @@ _DONE:
        return ret;
 }
 
-/**
- * @brief Set display for video sink.
- *
- * @since_tizen 3.0
- */
 int __ms_node_set_display(media_streamer_node_s *node, const char *param_value)
 {
        int ret = MEDIA_STREAMER_ERROR_NONE;