docs: Add objc and objcpp files to hotdoc gst_c_sources

Hotdoc should be able to extract and parse comments out of these. Just
need to be careful to only add the glob in directories that actually
contain *.m (objc) and *.mm (objcpp) files.

Also fix some doc comments and remove redundant ones.

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

diff --git a/subprojects/gst-plugins-bad/docs/meson.build b/subprojects/gst-plugins-bad/docs/meson.build
index 88c149343d5f4776558aeb1bf09ec311f44b62c5..e3f952c187a75b00a44712c5bbcb788ddc8f7e78 100644 (file)
--- a/subprojects/gst-plugins-bad/docs/meson.build
+++ b/subprojects/gst-plugins-bad/docs/meson.build
@@ -228,9 +228,10 @@ foreach plugin_name: list_plugin_res.stdout().split(':')
         gst_index: 'plugins/index.md',
         gst_smart_index: true,
         gst_c_sources: [
-            join_paths(root_rel, 'sys/*/*.[ch]'),
+            join_paths(root_rel, 'sys/*/*.[cmh]'),
             join_paths(root_rel, 'sys/*/*.cpp'),
             join_paths(root_rel, 'sys/*/*.cc'),
+            join_paths(root_rel, 'sys/*/*.mm'),
             join_paths(root_rel, 'sys/*/*.hh'),
             join_paths(root_rel, 'ext/*/*.[ch]'),
             join_paths(root_rel, 'ext/*/*.cpp'),

diff --git a/subprojects/gst-plugins-bad/sys/applemedia/avfassetsrc.m b/subprojects/gst-plugins-bad/sys/applemedia/avfassetsrc.m
index 20478bda5a89796c15215c7d8273a177682340d7..a7d02c6b6346e4e0101f30e576a095852b2334de 100644 (file)
--- a/subprojects/gst-plugins-bad/sys/applemedia/avfassetsrc.m
+++ b/subprojects/gst-plugins-bad/sys/applemedia/avfassetsrc.m
@@ -22,7 +22,7 @@
  */
 
 /**
- * SECTION:element-plugin
+ * SECTION:element-avfassetsrc
  *
  * Read and decode samples from AVFoundation assets using the AVFAssetReader API
  *
@@ -149,12 +149,6 @@ gst_avf_asset_src_class_init (GstAVFAssetSrcClass * klass)
   gobject_class->get_property = gst_avf_asset_src_get_property;
   gobject_class->dispose = gst_avf_asset_src_dispose;
 
-  /**
-   * GstAVFAssetSrc:uri
-   *
-   * URI of the asset to read
-   *
-   **/
   g_object_class_install_property (gobject_class, PROP_URI,
       g_param_spec_string ("uri", "Asset URI",
           "URI of the asset to read", NULL,

diff --git a/subprojects/gst-plugins-bad/sys/applemedia/iosassetsrc.m b/subprojects/gst-plugins-bad/sys/applemedia/iosassetsrc.m
index 0ea3a0751f48194cca54d55729ead502b79f065f..8e7bf9b22c1151169fefb558dc18e3e5dedd1fcf 100644 (file)
--- a/subprojects/gst-plugins-bad/sys/applemedia/iosassetsrc.m
+++ b/subprojects/gst-plugins-bad/sys/applemedia/iosassetsrc.m
@@ -21,7 +21,7 @@
  * Boston, MA 02111-1307, USA.
  */
 /**
- * SECTION:element-ios_assetsrc
+ * SECTION:element-iosassetsrc
  * @see_also: #GstIOSAssetSrc
  *
  * Read data from an iOS asset from the media library.

diff --git a/subprojects/gst-plugins-base/docs/meson.build b/subprojects/gst-plugins-base/docs/meson.build
index 4cc5dc040430883316767d1710200060289195f9..328e5aaa4e5e1301b271c22838b53dffcb7e714d 100644 (file)
--- a/subprojects/gst-plugins-base/docs/meson.build
+++ b/subprojects/gst-plugins-base/docs/meson.build
@@ -211,10 +211,11 @@ foreach plugin_name: list_plugin_res.stdout().split(':')
         index: 'plugins/index.md',
         gst_index: 'plugins/index.md',
         gst_smart_index: true,
-        gst_c_sources: ['../sys/*/*.[ch]',
-                        '../ext/*/*.[ch]',
-                        '../gst/*/*.[ch]',
-                        ],
+        gst_c_sources: [
+          '../sys/*/*.[ch]',
+          '../ext/*/*.[cmh]',
+          '../gst/*/*.[ch]',
+        ],
         dependencies: [gst_dep, plugins],
         gst_order_generated_subpages: true,
         gst_cache_file: plugins_cache,

diff --git a/subprojects/gst-plugins-good/docs/meson.build b/subprojects/gst-plugins-good/docs/meson.build
index beed1ae125b40ddf591cc8a49aa90e1ea78bfb46..83c3a273fc6e59ffb0f188eaa5dc92031ca9cee9 100644 (file)
--- a/subprojects/gst-plugins-good/docs/meson.build
+++ b/subprojects/gst-plugins-good/docs/meson.build
@@ -92,10 +92,11 @@ foreach plugin_name: list_plugin_res.stdout().split(':')
       index: 'index.md',
       gst_index: 'index.md',
       gst_smart_index: true,
-      gst_c_sources: ['../sys/*/*.[ch]',
-                      '../ext/*/*.[ch]',
-                      '../gst/*/*.[ch]',
-                      ],
+      gst_c_sources: [
+        '../sys/*/*.[cmh]',
+        '../ext/*/*.[ch]',
+        '../gst/*/*.[ch]',
+      ],
       gst_c_source_filters: excludes,
       dependencies: [gst_dep, plugins],
       gst_order_generated_subpages: true,

diff --git a/subprojects/gst-plugins-good/sys/osxvideo/osxvideosink.m b/subprojects/gst-plugins-good/sys/osxvideo/osxvideosink.m
index accd55d29ce5c1794262fffe8f3949e3c672cae5..ef2ef3870c50ab5f84fa7a98593d1301d7fa6cf2 100644 (file)
--- a/subprojects/gst-plugins-good/sys/osxvideo/osxvideosink.m
+++ b/subprojects/gst-plugins-good/sys/osxvideo/osxvideosink.m
@@ -573,24 +573,10 @@ gst_osx_video_sink_class_init (GstOSXVideoSinkClass * klass)
   gstbasesink_class->propose_allocation = gst_osx_video_sink_propose_allocation;
   gstelement_class->change_state = gst_osx_video_sink_change_state;
 
-  /**
-   * GstOSXVideoSink:embed
-   *
-   * For ABI comatibility only, do not use
-   *
-   **/
-
   g_object_class_install_property (gobject_class, ARG_EMBED,
       g_param_spec_boolean ("embed", "embed", "For ABI compatibility only, do not use",
           FALSE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 
-  /**
-   * GstOSXVideoSink:force-aspect-ratio
-   *
-   * When enabled, scaling will respect original aspect ratio.
-   *
-   **/
-
   g_object_class_install_property (gobject_class, ARG_FORCE_PAR,
       g_param_spec_boolean ("force-aspect-ratio", "force aspect ration",
           "When enabled, scaling will respect original aspect ration",