mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2024-11-26 11:41:09 +00:00
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>
This commit is contained in:
parent
a6a8a13608
commit
67656c5eeb
6 changed files with 14 additions and 31 deletions
|
@ -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'),
|
||||
|
|
|
@ -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,
|
||||
|
|
|
@ -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.
|
||||
|
|
|
@ -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,
|
||||
|
|
|
@ -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,
|
||||
|
|
|
@ -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",
|
||||
|
|
Loading…
Reference in a new issue