summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorMathieu Duponchelle <mathieu@centricular.com>2019-06-01 01:42:51 +0200
committerThibault Saunier <tsaunier@gnome.org>2019-06-01 02:58:09 +0000
commit51ea6ec6b7f2d346eee02904f649ae190e738145 (patch)
tree510a63553068754b7f8a4dc29721c8158fff22f1 /docs
parent7e5ae06ffecc2cbb4409dcefe6914b404f19ed47 (diff)
docs: document gstreamer-bad-audio
And unprefix subproject paths, making a special case for webrtc, to not conflict with the webrtc plugin
Diffstat (limited to 'docs')
-rw-r--r--docs/libs/audio/index.md6
-rw-r--r--docs/libs/audio/sitemap.txt1
-rw-r--r--docs/meson.build7
3 files changed, 12 insertions, 2 deletions
diff --git a/docs/libs/audio/index.md b/docs/libs/audio/index.md
new file mode 100644
index 000000000..75152f83d
--- /dev/null
+++ b/docs/libs/audio/index.md
@@ -0,0 +1,6 @@
+# Bad Audio library
+
+This library should be linked to by getting cflags and libs from
+gstreamer-bad-audio{{ gst_api_version.md }}.pc
+
+> NOTE: This library API is considered *unstable*
diff --git a/docs/libs/audio/sitemap.txt b/docs/libs/audio/sitemap.txt
new file mode 100644
index 000000000..4f91fcd8a
--- /dev/null
+++ b/docs/libs/audio/sitemap.txt
@@ -0,0 +1 @@
+gi-index
diff --git a/docs/meson.build b/docs/meson.build
index 955ad23c2..4ecf45d72 100644
--- a/docs/meson.build
+++ b/docs/meson.build
@@ -99,7 +99,8 @@ if build_gir
{'name': 'insertbin', 'gir': insertbin_gir, 'lib': gstinsertbin_dep},
{'name': 'codecparsers', 'lib': gstcodecparsers_dep},
{'name': 'adaptivedemux', 'lib': gstadaptivedemux_dep},
- {'name': 'webrtc', 'gir': webrtc_gir, 'lib': gstwebrtc_dep},
+ {'name': 'webrtc', 'gir': webrtc_gir, 'lib': gstwebrtc_dep, 'suffix': 'lib'},
+ {'name': 'audio', 'gir': audio_gir, 'lib': gstbadaudio_dep, 'prefix': 'bad-'},
]
endif
@@ -112,7 +113,9 @@ foreach lib_def: libs
if lib_def.has_key('gir')
if has_gi_extension
gir = lib_def['gir']
- libs_doc += [hotdoc.generate_doc('gst-plugins-bad-' + name,
+ prefix = lib_def.get('prefix', '')
+ suffix = lib_def.get('suffix', '')
+ libs_doc += [hotdoc.generate_doc(prefix + name + suffix,
project_version: api_version,
gi_c_sources: [join_paths(root_rel, 'gst-libs/gst', name, '*.[hc]')],
gi_sources: gir[0].full_path(),