Modify API descriptions regarding the ACR-1355 50/207950/1
authorhj kim <backto.kim@samsung.com>
Fri, 14 Jun 2019 07:02:28 +0000 (16:02 +0900)
committerhj kim <backto.kim@samsung.com>
Fri, 14 Jun 2019 07:02:28 +0000 (16:02 +0900)
Change-Id: I65e03ec0e0c7c18277708cf46d8b2e2e65fec4c0

include/media_controller_metadata.h

index b0e14bb..441a0e0 100755 (executable)
@@ -106,12 +106,12 @@ int mc_metadata_destroy(mc_metadata_h metadata);
 int mc_metadata_get(mc_metadata_h metadata, mc_meta_e attribute, char **value);
 
 /**
- * @brief Encodes the season data for use in metadata.
- * @details You can set various metadata information by using functions such as mc_server_set_metadata() and mc_server_add_item_to_playlist().
- *             However, if you want to set metadata information regarding the season,\n
- *             you should encode the season information with this function and then set the encoded data.\n
- *             Otherwise, you will receive an error. \n
- *             @a season_title can be NULL. If it is NULL, the decoded season_title will also be NULL.\n
+ * @brief Encodes the season metadata of the media.
+ * @details You can set various metadata with functions such as mc_server_set_metadata() and mc_server_add_item_to_playlist().
+ *             If you want to set the season,\n
+ *             you should encode the season with this function and then set the encoded data.\n
+ *             Otherwise, the setting function returns an error. \n
+ *             @a season_title can be NULL. If it is NULL, the decoded season title will also be NULL.\n
  * @since_tizen 5.5
  *
  * @remarks The @a encoded_season should be released using free(). \n
@@ -134,12 +134,12 @@ int mc_metadata_get(mc_metadata_h metadata, mc_meta_e attribute, char **value);
 int mc_metadata_encode_season(int season_num, const char *season_title, char **encoded_season);
 
 /**
- * @brief Encodes the episode data for use in metadata.
- * @details You can set various metadata information by using functions such as mc_server_set_metadata() and mc_server_add_item_to_playlist().
- *             However, if you want to set metadata information regarding the episode,\n
- *             you should encode the episode information with this function and then set the encoded data.\n
- *             Otherwise, you will receive an error. \n
- *             @a episode_title can be NULL. If it is NULL, the decoded episode_title will also be NULL.\n
+ * @brief Encodes the episode metadata of the media.
+ * @details You can set various metadata with functions such as mc_server_set_metadata() and mc_server_add_item_to_playlist().
+ *             If you want to set the episode,\n
+ *             you should encode the episode with this function and then set the encoded data.\n
+ *             Otherwise, the setting function returns an error. \n
+ *             @a episode_title can be NULL. If it is NULL, the decoded episode title will also be NULL.\n
  * @since_tizen 5.5
  *
  * @remarks The @a encoded_episode should be released using free(). \n
@@ -162,11 +162,11 @@ int mc_metadata_encode_season(int season_num, const char *season_title, char **e
 int mc_metadata_encode_episode(int episode_num, const char *episode_title, char **encoded_episode);
 
 /**
- * @brief Encodes the resolution data for use in metadata.
- * @details You can set various metadata information by using functions such as mc_server_set_metadata() and mc_server_add_item_to_playlist().
- *             However, if you want to set metadata information regarding the resolution,\n
- *             you should encode the resolution information with this function and then set the encoded data.\n
- *             Otherwise, you will receive an error. \n
+ * @brief Encodes the resolution metadata of the media.
+ * @details You can set various metadata with functions such as mc_server_set_metadata() and mc_server_add_item_to_playlist().
+ *             If you want to set the resolution,\n
+ *             you should encode the resolution with this function and then set the encoded data.\n
+ *             Otherwise, the setting function returns an error. \n
  * @since_tizen 5.5
  *
  * @remarks The @a encoded_resolution should be released using free(). \n
@@ -189,11 +189,11 @@ int mc_metadata_encode_episode(int episode_num, const char *episode_title, char
 int mc_metadata_encode_resolution(unsigned int width, unsigned int height, char **encoded_resolution);
 
 /**
- * @brief Decodes the season data.
- * @details You can get various metadata information by using mc_metadata_get().
- *             However, if you want to get proper season number and season title,\n
- *             you should use this function on results of calling mc_metadata_get().\n
- *             Otherwise, you will operate on an unreadable value. \n
+ * @brief Decodes the season of the media.
+ * @details You can get various metadata using mc_metadata_get().
+ *             If you want to get the proper season number and season title,\n
+ *             you should decode the metadata values gotten by mc_metadata_get() with this function.\n
+ *             Otherwise, the values are illegible. \n
  * @since_tizen 5.5
  *
  * @remarks The @a season_title should be released using free(). \n
@@ -217,11 +217,11 @@ int mc_metadata_encode_resolution(unsigned int width, unsigned int height, char
 int mc_metadata_decode_season(const char *encoded_season, int *season_num, char **season_title);
 
 /**
- * @brief Decodes the episode data.
- * @details You can get various metadata information by using mc_metadata_get().
- *             However, if you want to get proper episode number and episode title,\n
- *             you should use this function on results of calling mc_metadata_get().\n
- *             Otherwise, you will operate on an unreadable value. \n
+ * @brief Decodes the episode of the media.
+ * @details You can get various metadata using mc_metadata_get().
+ *             If you want to get the proper episode number and episode title,\n
+ *             you should decode the metadata values gotten by mc_metadata_get() with this function.\n
+ *             Otherwise, the values are illegible. \n
  * @since_tizen 5.5
  *
  * @remarks The @a episode_title should be released using free(). \n
@@ -245,11 +245,11 @@ int mc_metadata_decode_season(const char *encoded_season, int *season_num, char
 int mc_metadata_decode_episode(const char *encoded_episode, int *episode_num, char **episode_title);
 
 /**
- * @brief Decodes the resolution data.
- * @details You can get various metadata information by using mc_metadata_get().
- *             However, if you want to get proper resolution, \n
- *             you should use this function on results of calling mc_metadata_get().\n
- *             Otherwise, you will operate on an unreadable value. \n
+ * @brief Decodes the resolution of the media.
+ * @details You can get various metadata using mc_metadata_get().
+ *             If you want to get the proper resolution, \n
+ *             you should decode the metadata values gotten by mc_metadata_get() with this function.\n
+ *             Otherwise, the values are illegible. \n
  * @since_tizen 5.5
  *
  * @param[in] encoded_resolution    The encoded resolution information