Revise description - function names are stated explicitly 38/230738/1
authorSangchul Lee <sc11.lee@samsung.com>
Tue, 14 Apr 2020 02:05:47 +0000 (11:05 +0900)
committerSangchul Lee <sc11.lee@samsung.com>
Tue, 14 Apr 2020 02:49:33 +0000 (11:49 +0900)
Change-Id: I15834188e1b8b92aee0ff32e4eb37f689894777e
Signed-off-by: Sangchul Lee <sc11.lee@samsung.com>
include/media_streamer.h

index b1b3fa9..592fb3c 100644 (file)
@@ -1112,7 +1112,7 @@ int media_streamer_node_link(media_streamer_node_h src_node, const char *src_pad
  * @retval #MEDIA_STREAMER_ERROR_INVALID_STATE Invalid state
  * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
- * @pre Create a node handle by calling media_streamer_node_createxxx().
+ * @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
  */
@@ -1130,7 +1130,7 @@ int media_streamer_node_set_pad_format(media_streamer_node_h node, const char *p
  * @retval #MEDIA_STREAMER_ERROR_INVALID_STATE Invalid state
  * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
- * @pre Create a node handle by calling media_streamer_node_createxxx().
+ * @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
  */
@@ -1153,7 +1153,7 @@ int media_streamer_node_get_pad_format(media_streamer_node_h node, const char *p
  * @retval #MEDIA_STREAMER_ERROR_NONE Successful
  * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
- * @pre Create a node handle by calling media_streamer_node_createxxx().
+ * @pre Create a node handle by calling media_streamer_node_create(), media_streamer_node_create_src(), or media_streamer_node_create_sink().
  * @see media_streamer_node_create()
  * @see media_streamer_node_create_src()
  * @see media_streamer_node_create_sink()
@@ -1176,7 +1176,7 @@ int media_streamer_node_get_pad_name(media_streamer_node_h node, char ***src_pad
  * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
  * @retval #MEDIA_STREAMER_ERROR_PERMISSION_DENIED Permission denied
- * @pre Create a node handle by calling media_streamer_node_createXXX().
+ * @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()
  * @see media_streamer_node_create_src()
@@ -1197,7 +1197,7 @@ int media_streamer_node_set_params(media_streamer_node_h node, bundle *param_lis
  * @retval #MEDIA_STREAMER_ERROR_INVALID_STATE Invalid state
  * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
- * @pre Create a node handle by calling media_streamer_node_createXXX().
+ * @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()
  * @see media_streamer_node_create_src()
@@ -1223,7 +1223,7 @@ int media_streamer_node_get_params(media_streamer_node_h node, bundle **param_li
  * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
  * @retval #MEDIA_STREAMER_ERROR_PERMISSION_DENIED Permission denied
- * @pre Create a node handle by calling media_streamer_node_createXXX().
+ * @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()
  * @see media_streamer_node_create_src()
@@ -1248,7 +1248,7 @@ int media_streamer_node_set_param(media_streamer_node_h node,
  * @retval #MEDIA_STREAMER_ERROR_INVALID_STATE Invalid state
  * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
- * @pre Create a node handle by calling media_streamer_node_createXXX().
+ * @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()
  * @see media_streamer_node_create_src()