analytics: Add documentation to hotdoc build
authorOlivier Crête <olivier.crete@collabora.com>
Sun, 3 Mar 2024 23:35:09 +0000 (18:35 -0500)
committerTim-Philipp Müller <tim@centricular.com>
Mon, 4 Mar 2024 17:33:00 +0000 (17:33 +0000)
Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/6253>

subprojects/gst-plugins-bad/docs/libs/analytics/index.md [new file with mode: 0644]
subprojects/gst-plugins-bad/docs/libs/analytics/sitemap.txt [new file with mode: 0644]
subprojects/gst-plugins-bad/docs/meson.build
subprojects/gst-plugins-bad/gst-libs/gst/analytics/analytics-meta-prelude.h
subprojects/gst-plugins-bad/gst-libs/gst/analytics/meson.build

diff --git a/subprojects/gst-plugins-bad/docs/libs/analytics/index.md b/subprojects/gst-plugins-bad/docs/libs/analytics/index.md
new file mode 100644 (file)
index 0000000..7ef69e2
--- /dev/null
@@ -0,0 +1,3 @@
+# Analytics metadata library
+
+> NOTE: This library API is considered *unstable*
diff --git a/subprojects/gst-plugins-bad/docs/libs/analytics/sitemap.txt b/subprojects/gst-plugins-bad/docs/libs/analytics/sitemap.txt
new file mode 100644 (file)
index 0000000..4f91fcd
--- /dev/null
@@ -0,0 +1 @@
+gi-index
index 3b884e6af290e315b43b291c73277a578522ec66..e85fd6f56c7b423b8d4e8dd0c5a23237b6a652fa 100644 (file)
@@ -135,6 +135,7 @@ if build_gir
         {'name': 'cuda', 'gir': gst_cuda_gir, 'lib': gstcuda_dep, 'c_source_patterns': ['*.h', '*.cpp']},
         {'name': 'dxva', 'gir': dxva_gir, 'lib': gstdxva_dep, 'c_source_patterns': ['*.h', '*.cpp']},
         {'name': 'mse', 'gir': mse_gir, 'lib': gstmse_dep, 'suffix': 'lib'},
+        {'name': 'analytics', 'gir': analytics_gir, 'lib': gstanalytics_dep},
     ]
 
     if gstopencv_dep.found()
index 6b4ae3bf682fe0de66a89cd652072036a246c1f8..8c3b4a973f0ceace16cdd533c533bb8d8a6c22c5 100644 (file)
@@ -25,7 +25,7 @@
 #include <gst/gst.h>
 
 #ifndef GST_ANALYTICS_META_API
-# ifdef BUILDING_GST_ANALYTIC_META
+# ifdef BUILDING_GST_ANALYTICS
 #   define GST_ANALYTICS_META_API GST_API_EXPORT
 # else
 #   define GST_ANALYTICS_META_API GST_API_IMPORT
index 13b0eb261a4e4816a418b118209a14f746268dcf..a2886e28f7d24353ce30864e6914b798888758e3 100644 (file)
@@ -14,7 +14,7 @@ install_headers(analytics_headers, subdir : 'gstreamer-1.0/gst/analytics')
 pkg_name = 'gstreamer-analytics-1.0'
 gstanalytics = library('gstanalytics-' + api_version,
   analytics_sources,
-  c_args : gst_plugins_bad_args + ['-DGST_USE_UNSTABLE_API', '-DBUILDING_GST_ANALYTIC_META', '-DG_LOG_DOMAIN="Gstreamer-Analytic"'],
+  c_args : gst_plugins_bad_args + ['-DGST_USE_UNSTABLE_API', '-DBUILDING_GST_ANALYTICS', '-DG_LOG_DOMAIN="GStreamer-Analytics"'],
   include_directories : [configinc, libsinc],
   version : libversion,
   soversion : soversion,
@@ -47,9 +47,9 @@ if build_gir
   }
   library_def += {'gir': [gir]}
   if not static_build
-    analyticsmeta_gir = gnome.generate_gir(gstanalytics, kwargs: gir)
-    library_def += {'gir_targets':  library_def.get('gir_targets', []) + [analyticsmeta_gir]}
-    gen_sources += analyticsmeta_gir
+    analytics_gir = gnome.generate_gir(gstanalytics, kwargs: gir)
+    library_def += {'gir_targets':  library_def.get('gir_targets', []) + [analytics_gir]}
+    gen_sources += analytics_gir
   endif
 endif
 gst_libraries += [[pkg_name, library_def]]