fix doxygen header issues 60/317660/1 accepted/tizen_unified_dev accepted/tizen_unified_toolchain accepted/tizen/9.0/unified/20241030.233040 accepted/tizen/unified/20240919.163720 accepted/tizen/unified/dev/20240920.060415 accepted/tizen/unified/toolchain/20241004.102033 accepted/tizen/unified/x/20240920.053201 accepted/tizen/unified/x/asan/20241014.000433 tizen_9.0_m2_release
authorhjkim <backto.kim@samsung.com>
Fri, 13 Sep 2024 02:26:46 +0000 (11:26 +0900)
committerhjkim <backto.kim@samsung.com>
Fri, 13 Sep 2024 02:27:00 +0000 (11:27 +0900)
Change-Id: I5b2e07ffc5556c7a88ae595df18622d1c88ae1fd

include/media_packet.h

index 3f5ce4ee5e12eafaacd870795ad02e7d86da3548..dabc5594ff494e1bed90847be3866c66f83660ba 100644 (file)
@@ -194,7 +194,7 @@ int media_packet_create_alloc(media_format_h fmt, media_packet_finalize_cb fcb,
  *
  * @since_tizen 2.3
  *
- * @remarks The @c packet must be released by using media_packet_destroy().
+ * @remarks The @a packet must be released by using media_packet_destroy().
  * @param[in] fmt       The allocated #media_format_h by caller
  * @param[in] fcb       The media_packet_finalize_cb() to register
  * @param[in] fcb_data  The user data to be passed to the media_packet_finalize_cb() function
@@ -249,7 +249,7 @@ int media_packet_create(media_format_h fmt, media_packet_finalize_cb fcb, void *
  * @brief Creates a media packet handle.
  * @details It creates only media packet handle without allocated buffer.
  * @since_tizen 6.5
- * @remarks The @c packet must be released by using media_packet_unref().
+ * @remarks The @a packet must be released by using media_packet_unref().
  * @param[in] fmt      The #media_format_h allocated by the caller
  * @param[in] dcb      The media_packet_dispose_cb() to register. Use @c NULL to skip the callback.
  * @param[in] dcb_data The user data to be passed to the media_packet_dispose_cb() function
@@ -292,7 +292,7 @@ int media_packet_new_alloc(media_format_h fmt, media_packet_dispose_cb dcb, void
 /**
  * @brief Creates media packet handle and allocates buffer with #tbm_surface_h.
  * @since_tizen 6.5
- * @remarks The @c packet must be released by using media_packet_unref().
+ * @remarks The @a packet must be released by using media_packet_unref().
  * @param[in]  fmt      The #media_format_h allocated by caller
  * @param[in]  surface  The #tbm_surface_h by caller
  * @param[in]  dcb      The media_packet_dispose_cb() to register. Use @c NULL to skip the callback.
@@ -315,7 +315,7 @@ int media_packet_new_from_tbm_surface(media_format_h fmt, tbm_surface_h surface,
  * @brief Creates media packet handle with already allocated buffer.
  * @details It does not support video's #MEDIA_FORMAT_RAW type.
  * @since_tizen 6.5
- * @remarks The @c packet must be released by using media_packet_unref().
+ * @remarks The @a packet must be released by using media_packet_unref().
  * @param[in]  fmt      The allocated #media_format_h by caller
  * @param[in]  mem_ptr  The memory pointer which is created by external module
  * @param[in]  size     The buffer size value to set
@@ -367,7 +367,7 @@ int media_packet_unref(media_packet_h packet);
  *
  * @since_tizen 2.3
  *
- * @remarks The @c new_packet must be released by using media_packet_destroy().
+ * @remarks The @a new_packet must be released by using media_packet_destroy().
  * @remarks It will return #MEDIA_PACKET_ERROR_INVALID_OPERATION \n
  *          if the media packet handle is from media_packet_new(), \n
  *          media_packet_new_alloc(), media_packet_new_from_tbm_surface() \n
@@ -415,7 +415,7 @@ int media_packet_alloc(media_packet_h packet);
  *
  * @since_tizen 2.3
  *
- * @remarks The @c packet must be released by using media_packet_destroy().
+ * @remarks The @a packet must be released by using media_packet_destroy().
  * @param[in]   fmt       The allocated #media_format_h by caller
  * @param[in]   surface   The #tbm_surface_h by caller
  * @param[in]   fcb       The media_packet_finalize_cb() to register
@@ -474,7 +474,7 @@ int media_packet_create_from_tbm_surface(media_format_h fmt, tbm_surface_h surfa
  *
  * @since_tizen 2.4
  *
- * @remarks The @c packet must be released by using media_packet_destroy().
+ * @remarks The @a packet must be released by using media_packet_destroy().
  * @param[in]   fmt       The allocated #media_format_h by caller
  * @param[in]   mem_ptr   The memory pointer which is created by external module
  * @param[in]   size      The buffer size value to set
@@ -1055,7 +1055,7 @@ int media_packet_get_video_stride_height(media_packet_h packet, int plane_idx, i
  *
  * @since_tizen 2.4
  *
- * @remarks The @c plane_data_ptr must not be released by using free(). Note that It is released by media_packet_destroy() or tbm_surface_destroy().
+ * @remarks The @a plane_data_ptr must not be released by using free(). Note that It is released by media_packet_destroy() or tbm_surface_destroy().
  * @param[in]  packet   The media packet handle
  * @param[in]  plane_idx   The plane index value
  * @param[out] plane_data_ptr  The plane data pointer from tbm_surface