analyticsmeta: Make output struct annotation more explicit

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/8489>
This commit is contained in:
Olivier Crête 2025-02-16 20:08:58 -05:00 committed by GStreamer Marge Bot
parent 7b6ba90416
commit 3dc6abbe68
2 changed files with 6 additions and 6 deletions

View File

@ -465,7 +465,7 @@ new struct sub-classing GstAnalyticsRelatableMtd.</doc>
<doc xml:space="preserve" filename="../subprojects/gst-plugins-bad/gst-libs/gst/analytics/gstanalyticsmeta.c">Size required</doc>
<type name="gsize" c:type="gsize"/>
</parameter>
<parameter name="rlt_mtd" transfer-ownership="none">
<parameter name="rlt_mtd" direction="out" caller-allocates="1" transfer-ownership="none" nullable="1">
<doc xml:space="preserve" filename="../subprojects/gst-plugins-bad/gst-libs/gst/analytics/gstanalyticsmeta.c">Updated handle</doc>
<type name="Mtd" c:type="GstAnalyticsMtd*"/>
</parameter>
@ -777,7 +777,7 @@ otherwise this method return FALSE and @rlt is invalid.</doc>
to @an_meta_id will be set in @rlt_mtd. Doesn't need to be free.</doc>
<type name="gpointer" c:type="gpointer*"/>
</parameter>
<parameter name="rlt_mtd" transfer-ownership="none">
<parameter name="rlt_mtd" direction="out" caller-allocates="1" transfer-ownership="none">
<doc xml:space="preserve" filename="../subprojects/gst-plugins-bad/gst-libs/gst/analytics/gstanalyticsmeta.c">Handle updated to directly related relatable meta.</doc>
<type name="Mtd" c:type="GstAnalyticsMtd*"/>
</parameter>
@ -946,7 +946,7 @@ otherwise this method return FALSE and @rlt is invalid.</doc>
%GST_ANALYTICS_MTD_TYPE_ANY for any.</doc>
<type name="MtdType" c:type="GstAnalyticsMtdType"/>
</parameter>
<parameter name="rlt_mtd" transfer-ownership="none">
<parameter name="rlt_mtd" direction="out" caller-allocates="1" transfer-ownership="none">
<doc xml:space="preserve" filename="../subprojects/gst-plugins-bad/gst-libs/gst/analytics/gstanalyticsmeta.c">Handle updated to iterated GstAnalyticsRelatableMtd.</doc>
<type name="Mtd" c:type="GstAnalyticsMtd*"/>
</parameter>

View File

@ -882,7 +882,7 @@ gst_buffer_get_analytics_relation_meta (GstBuffer * buffer)
* @meta: Instance
* @impl: Implementation of relatable (#GstAnalyticsRelatableMtd)
* @size: Size required
* @rlt_mtd: Updated handle
* @rlt_mtd: (out caller-allocates)(nullable): Updated handle
*
* Add a relatable metadata to @meta. This method is meant to be used by
* new struct sub-classing GstAnalyticsRelatableMtd.
@ -1037,7 +1037,7 @@ gst_analytics_relation_meta_get_mtd_data (const GstAnalyticsRelationMeta *
* @state: (inout) (not nullable): Opaque data to store state of the query.
* If @state point to NULL, the first analytics-metadata directly related
* to @an_meta_id will be set in @rlt_mtd. Doesn't need to be free.
* @rlt_mtd: Handle updated to directly related relatable meta.
* @rlt_mtd: (out caller-allocates)(not nullable): Handle updated to directly related relatable meta.
*
* Returns: TRUE if @rlt_mtd was updated, other wise FALSE
* Since: 1.24
@ -1109,7 +1109,7 @@ gst_analytics_relation_meta_get_direct_related (GstAnalyticsRelationMeta * meta,
* free it.
* @type: Type of GstAnalyticsMtd to iterate on or use
* %GST_ANALYTICS_MTD_TYPE_ANY for any.
* @rlt_mtd: Handle updated to iterated GstAnalyticsRelatableMtd.
* @rlt_mtd: (out caller-allocates)(not nullable): Handle updated to iterated GstAnalyticsRelatableMtd.
*
* Returns: FALSE if end was reached and iteration is completed.
* Since: 1.24