analytics: whitespace matters for gtk-doc syntax

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/6253>

diff --git a/subprojects/gst-plugins-bad/gst-libs/gst/analytics/gstanalyticsclassificationmtd.c b/subprojects/gst-plugins-bad/gst-libs/gst/analytics/gstanalyticsclassificationmtd.c
index 0748af2b187ab1bc5178b73d1b48dbf55aaf1d6e..59d5b569ef79a4a5055ac3477cee15ba25fd929f 100644 (file)
--- a/subprojects/gst-plugins-bad/gst-libs/gst/analytics/gstanalyticsclassificationmtd.c
+++ b/subprojects/gst-plugins-bad/gst-libs/gst/analytics/gstanalyticsclassificationmtd.c
@@ -71,6 +71,7 @@ struct _GstAnalyticsClsMtdData
 
 /**
  * gst_analytics_cls_mtd_get_mtd_type:
+ *
  * Get an id identifying #GstAnalyticsMtd type.
  *
  * Returns: opaque id of #GstAnalyticsMtd type

diff --git a/subprojects/gst-plugins-bad/gst-libs/gst/analytics/gstanalyticsmeta.c b/subprojects/gst-plugins-bad/gst-libs/gst/analytics/gstanalyticsmeta.c
index d97bbc3a2d0b462078b42d6bd1128bc933e56be1..bcec73470a236089b78e390bad78c4a8ba13b7e0 100644 (file)
--- a/subprojects/gst-plugins-bad/gst-libs/gst/analytics/gstanalyticsmeta.c
+++ b/subprojects/gst-plugins-bad/gst-libs/gst/analytics/gstanalyticsmeta.c
@@ -130,11 +130,11 @@ gst_analytics_relation_meta_get_mtd_data_internal (GstAnalyticsRelationMeta *
 
 /**
  * gst_analytics_mtd_get_mtd_type:
+ *
  * @instance: Instance of #GstAnalyticsMtd
  * Get analysis result type.
  *
  * Returns: opaque id of the type
- *
  * Since: 1.24
  */
 GstAnalyticsMtdType
@@ -152,10 +152,10 @@ gst_analytics_mtd_get_mtd_type (GstAnalyticsMtd * handle)
 /**
  * gst_analytics_mtd_get_id:
  * @instance: Instance of #GstAnalyticsMtd
+ *
  * Get instance id
  *
  * Returns: Id of @instance
- *
  * Since: 1.24
  */
 guint
@@ -171,7 +171,6 @@ gst_analytics_mtd_get_id (GstAnalyticsMtd * handle)
  * Get instance size
  *
  * Returns: Size (in bytes) of this instance or 0 on failure.
- *
  * Since: 1.24
  */
 gsize
@@ -195,7 +194,6 @@ gst_analytics_mtd_get_size (GstAnalyticsMtd * handle)
  * Gets the string version of the name of this type of analytics data
  *
  * Returns: the name
- *
  * Since: 1.24
  */
 const gchar *
@@ -218,7 +216,7 @@ gst_analytics_mtd_type_get_name (GstAnalyticsMtdType type)
  * Get number of relatable meta attached to instance
  *
  * Returns: Number of analysis-meta attached to this
- * instance.
+ *  instance.
  * Since: 1.24
  */
 gsize
@@ -259,11 +257,11 @@ gst_analytics_relation_adj_mat_create (gsize order)
  * @adj_mat: Adjcency-matrix (array or MxN)
  * @order: Order of the existing matrix
  * @new_order: Order of the matrix to create
+ *
  * Duplicate adj_mat to a newly allocated array new_order x new_order dimension
  * while keep values of adj_mat at the same indexes in the new array.
  *
  * Returns: New adjacency matrix with maintained values.
- *
  * Since: 1.24
  */
 static guint8 **
@@ -279,8 +277,8 @@ gst_analytics_relation_adj_mat_dup (guint8 ** adj_mat, gsize order,
 
 /**
  * gst_analytics_relation_meta_api_get_type:
- * Returns: GType of GstAnalyticsRelationMeta
  *
+ * Returns: GType of GstAnalyticsRelationMeta
  * Since: 1.24
  */
 GType
@@ -575,12 +573,11 @@ gst_analytics_relation_meta_get_next_id (GstAnalyticsRelationMeta * meta)
  * @an_meta_first_id: Id of first analysis-meta
  * @an_meta_second_id: Id of second  analysis-meta
  *
- * Returns: relation description between first and second analysis-meta.
- *
  * Get relations between first and second analysis-meta.
  * Ids (@an_meta_first_id and @an_meta_second_id) must be from a call to
  * @gst_analytics_mtd_get_id (handle).
  *
+ * Returns: relation description between first and second analysis-meta.
  * Since: 1.24
  */
 GstAnalyticsRelTypes
@@ -627,7 +624,6 @@ gst_analytics_relation_meta_get_relation (GstAnalyticsRelationMeta * meta,
  *    @gst_analytics_mtd_get_id(handle).
  *
  * Returns: TRUE on success and FALSE on failure.
- *
  * Since: 1.24
  */
 gboolean
@@ -674,7 +670,6 @@ gst_analytics_relation_meta_set_relation (GstAnalyticsRelationMeta * meta,
  *
  * Returns: TRUE if a relation between exit between @an_meta_first_id and
  *  @an_meta_second_id, otherwise FALSE.
- *
  * Since: 1.24
  */
 gboolean
@@ -803,7 +798,6 @@ gst_analytics_relation_meta_exist (GstAnalyticsRelationMeta * rmeta,
  * and providing the maximum number of analysis meta that will attached to a buffer.
  *
  * Returns: (transfer none) (nullable) : Newly attached #GstAnalyticsRelationMeta
- *
  * Since: 1.24
  */
 GstAnalyticsRelationMeta *
@@ -824,7 +818,6 @@ gst_buffer_add_analytics_relation_meta (GstBuffer * buffer)
  * analysis meta.
  *
  * Returns: (transfer none) (nullable) : Newly attached #GstAnalyticsRelationMeta
- *
  * Since: 1.24
  */
 GstAnalyticsRelationMeta *
@@ -876,7 +869,6 @@ gst_buffer_get_analytics_relation_meta (GstBuffer * buffer)
  * new struct sub-classing GstAnalyticsRelatableMtd.
  *
  * Returns: A pointer to a memory area of size @size where to put the data
- *
  * Since: 1.24
  */
 gpointer
@@ -959,7 +951,6 @@ gst_analytics_relation_meta_add_mtd (GstAnalyticsRelationMeta * meta,
  * otherwise this method return FALSE and @rlt is invalid.
  *
  * Returns: TRUE if successful.
- *
  * Since: 1.24
  */
 gboolean
@@ -1003,7 +994,6 @@ gst_analytics_relation_meta_get_mtd (GstAnalyticsRelationMeta * meta,
  * @an_meta_id: Id of GstAnalyticsMtd instance to retrieve
  *
  * Returns:(nullable): Analytics data pointer
- *
  * Since: 1.24
  */
 gpointer
@@ -1029,7 +1019,6 @@ gst_analytics_relation_meta_get_mtd_data (GstAnalyticsRelationMeta *
  * @rlt_mtd: Handle updated to directly related relatable meta.
  *
  * Returns: TRUE if @rlt_mtd was updated, other wise FALSE
- *
  * Since: 1.24
  */
 gboolean
@@ -1102,7 +1091,6 @@ gst_analytics_relation_meta_get_direct_related (GstAnalyticsRelationMeta * meta,
  * @rlt_mtd: Handle updated to iterated GstAnalyticsRelatableMtd.
  *
  * Returns: FALSE if end was reached and iteration is completed.
- *
  * Since: 1.24
  */
 gboolean

diff --git a/subprojects/gst-plugins-bad/gst-libs/gst/analytics/gstanalyticsmeta.h b/subprojects/gst-plugins-bad/gst-libs/gst/analytics/gstanalyticsmeta.h
index 7da1453c07e06154bbd852ee182d045717fe6fd9..3d9957fe9f6e40f4d973f4265e6e590dbe473906 100644 (file)
--- a/subprojects/gst-plugins-bad/gst-libs/gst/analytics/gstanalyticsmeta.h
+++ b/subprojects/gst-plugins-bad/gst-libs/gst/analytics/gstanalyticsmeta.h
@@ -33,6 +33,7 @@ G_BEGIN_DECLS
 
 /**
  * GST_INF_RELATION_SPAN:
+ *
  * Passes to functions asking for a relation span when the span is
  * infinite.
  *

diff --git a/subprojects/gst-plugins-bad/gst-libs/gst/analytics/gstanalyticsobjectdetectionmtd.c b/subprojects/gst-plugins-bad/gst-libs/gst/analytics/gstanalyticsobjectdetectionmtd.c
index f616352fbd630beb0368a3a44e817eb8aad92af8..29f607d881a683958869db4f42855f26eb34941e 100644 (file)
--- a/subprojects/gst-plugins-bad/gst-libs/gst/analytics/gstanalyticsobjectdetectionmtd.c
+++ b/subprojects/gst-plugins-bad/gst-libs/gst/analytics/gstanalyticsobjectdetectionmtd.c
@@ -105,6 +105,7 @@ static const GstAnalyticsMtdImpl od_impl = {
 
 /**
  * gst_analytics_od_mtd_get_mtd_type:
+ *
  * Get an id that represent object-detection metadata type
  *
  * Returns: Opaque id of the #GstAnalyticsMtd type

diff --git a/subprojects/gst-plugins-bad/gst-libs/gst/analytics/gstanalyticsobjecttrackingmtd.c b/subprojects/gst-plugins-bad/gst-libs/gst/analytics/gstanalyticsobjecttrackingmtd.c
index 78bb327312bd828c8da600d62cabbb112edd52ca..68c69d23049c3ca7e9569b1fd9a9278aeaddbfba 100644 (file)
--- a/subprojects/gst-plugins-bad/gst-libs/gst/analytics/gstanalyticsobjecttrackingmtd.c
+++ b/subprojects/gst-plugins-bad/gst-libs/gst/analytics/gstanalyticsobjecttrackingmtd.c
@@ -69,6 +69,7 @@ static const GstAnalyticsMtdImpl tracking_impl = {
 
 /**
  * gst_analytics_tracking_mtd_get_mtd_type:
+ *
  * Returns: id representing the type of GstAnalyticsRelatableMtd
  *
  * Get the opaque id identifying the relatable type