docs: Build documentation with hotdoc

24 files changed, 49 insertions, 325 deletions

diff --git a/docs/libs/.gitignore b/docs/libs/.gitignore
deleted file mode 100644
index 83bf78579..000000000
--- a/docs/libs/.gitignore
+++ /dev/null
@@ -1,28 +0,0 @@
-Makefile
-Makefile.in
-
-*-decl.txt
-*-decl-list.txt
-*-undocumented.txt
-*-undeclared.txt
-*-unused.txt
-*.bak
-*.args
-*.hierarchy
-*.interfaces
-*.prerequisites
-*.signals
-
-gst-plugins-bad-libs.args.new
-gst-plugins-bad-libs.signals.new
-
-tmpl
-xml
-html
-
-gst-plugins-bad-libs-scan
-gst-plugins-bad-libs-scan.c
-*-registry.*
-
-*.stamp
-
diff --git a/docs/libs/Makefile.am b/docs/libs/Makefile.am
deleted file mode 100644
index 7ef62450f..000000000
--- a/docs/libs/Makefile.am
+++ /dev/null
@@ -1,72 +0,0 @@
-## Process this file with automake to produce Makefile.in
-
-# FIXME: fix the docs then remove this variable
-DOCS_ARE_INCOMPLETE_PLEASE_FIXME=yespleasedo
-
-# The name of the module, e.g. 'glib'.
-#DOC_MODULE=gst-plugins-libs-@GST_API_VERSION@
-DOC_MODULE=gst-plugins-bad-libs
-
-# for upload-doc.mak
-DOC=gst-plugins-bad-libs
-FORMATS=html
-html: html-build.stamp
-include $(top_srcdir)/common/upload-doc.mak
-
-# The top-level SGML file. Change it if you want.
-DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
-
-# The directory containing the source code.
-# gtk-doc will search all .c & .h files beneath here for inline comments
-# documenting functions and macros.
-DOC_SOURCE_DIR=$(top_srcdir)/gst-libs/gst
-
-# Extra options to supply to gtkdoc-scan.
-SCAN_OPTIONS=--deprecated-guards="GST_DISABLE_DEPRECATED" \
-  --ignore-decorators="GST_API|GST_BASE_API|GST_CHECK_API|GST_CONTROLLER_API|GST_NET_API|GST_ALLOCATORS_API|GST_APP_API|GST_AUDIO_API|GST_FFT_API|GST_GL_API|GST_PBUTILS_API|GST_RIFF_API|GST_RTP_API|GST_RTSP_API|GST_SDP_API|GST_TAG_API|GST_VIDEO_API|GST_ADAPTIVE_DEMUX_API|GST_AUDIO_BAD_API|GST_BASE_CAMERA_BIN_SRC_API|GST_CODEC_PARSERS_API|GST_INSERT_BIN_API|GST_ISOFF_API|GST_PHOTOGRAPHY_API|GST_MPEGTS_API|GST_OPENCV_API|GST_PLAYER_API|GST_URI_DOWNLOADER_API|GST_VIDEO_BAD_API|GST_WAYLAND_API|GST_WEBRTC_API"
-
-# Extra options to supply to gtkdoc-mkdb.
-MKDB_OPTIONS=--sgml-mode  --output-format=xml
-
-# Extra options to supply to gtkdoc-fixref.
-FIXXREF_OPTIONS=--extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html \
-	--extra-dir=$(GST_PREFIX)/share/gtk-doc/html
-
-# Used for dependencies.
-HFILE_GLOB=$(top_srcdir)/gst-libs/gst/*/*.h
-CFILE_GLOB=$(top_srcdir)/gst-libs/gst/*/*.c
-
-# Header files to ignore when scanning.
-IGNORE_HFILES = \
-	$(top_srcdir)/gst-libs/gst/mpegts/gstmpegts-private.h \
-	$(top_srcdir)/gst-libs/gst/player/gstplayer-signal-dispatcher-private.h \
-	$(top_srcdir)/gst-libs/gst/player/gstplayer-video-renderer-private.h \
-	$(top_srcdir)/gst-libs/gst/player/gstplayer-media-info-private.h
-
-# Images to copy into HTML directory.
-HTML_IMAGES =
-
-# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
-content_files = compiling.sgml
-
-# Other files to distribute.
-extra_files =
-
-# CFLAGS and LDFLAGS for compiling scan program. Only needed if your app/lib
-# contains GtkObjects/GObjects and you want to document signals and properties.
-GTKDOC_CFLAGS = -DGST_USE_UNSTABLE_API $(GST_PLUGINS_BAD_CFLAGS) $(GST_PLUGINS_BASE_CFLAGS) $(GST_BASE_CFLAGS)
-GTKDOC_LIBS = \
-	$(top_builddir)/gst-libs/gst/audio/libgstbadaudio-@GST_API_VERSION@.la \
-	$(top_builddir)/gst-libs/gst/codecparsers/libgstcodecparsers-@GST_API_VERSION@.la \
-	$(top_builddir)/gst-libs/gst/insertbin/libgstinsertbin-@GST_API_VERSION@.la \
-	$(top_builddir)/gst-libs/gst/mpegts/libgstmpegts-@GST_API_VERSION@.la \
-	$(top_builddir)/gst-libs/gst/player/libgstplayer-@GST_API_VERSION@.la \
-	$(top_builddir)/gst-libs/gst/webrtc/libgstwebrtc-@GST_API_VERSION@.la \
-  $(GST_BASE_LIBS)
-
-# If you need to override some of the declarations, place them in this file
-# and uncomment this line.
-DOC_OVERRIDES = $(DOC_MODULE)-overrides.txt
-
-include $(top_srcdir)/common/gtk-doc.mak
-
diff --git a/docs/libs/adaptivedemux/index.md b/docs/libs/adaptivedemux/index.md
new file mode 100644
index 000000000..946e868ec
--- /dev/null
+++ b/docs/libs/adaptivedemux/index.md
@@ -0,0 +1 @@
+# Adaptive Demux library
\ No newline at end of file
diff --git a/docs/libs/adaptivedemux/sitemap.txt b/docs/libs/adaptivedemux/sitemap.txt
new file mode 100644
index 000000000..e3577f116
--- /dev/null
+++ b/docs/libs/adaptivedemux/sitemap.txt
@@ -0,0 +1 @@
+c-index
diff --git a/docs/libs/base/index.md b/docs/libs/base/index.md
new file mode 100644
index 000000000..181db2229
--- /dev/null
+++ b/docs/libs/base/index.md
@@ -0,0 +1,3 @@
+# Base classes from -bad
+
+> NOTE: This library API is considered *unstable*
diff --git a/docs/libs/base/sitemap.txt b/docs/libs/base/sitemap.txt
new file mode 100644
index 000000000..4f91fcd8a
--- /dev/null
+++ b/docs/libs/base/sitemap.txt
@@ -0,0 +1 @@
+gi-index
diff --git a/docs/libs/codecparsers/index.md b/docs/libs/codecparsers/index.md
new file mode 100644
index 000000000..2383b894e
--- /dev/null
+++ b/docs/libs/codecparsers/index.md
@@ -0,0 +1,7 @@
+# Bitstream parsing Library
+
+This library should be linked to by getting cflags and libs from
+gstreamer-plugins-bad-{{ gst_api_version.md }}.pc and adding
+-lgstcodeparsers-{{ gst_api_version.md }} to the library flags.
+
+> NOTE: This library API is considered *unstable*
diff --git a/docs/libs/codecparsers/sitemap.txt b/docs/libs/codecparsers/sitemap.txt
new file mode 100644
index 000000000..e3577f116
--- /dev/null
+++ b/docs/libs/codecparsers/sitemap.txt
@@ -0,0 +1 @@
+c-index
diff --git a/docs/libs/compiling.sgml b/docs/libs/compiling.sgml
deleted file mode 100644
index e6f8662bd..000000000
--- a/docs/libs/compiling.sgml
+++ /dev/null
@@ -1,48 +0,0 @@
-<?xml version="1.0"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
-               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
-<!ENTITY % version-entities SYSTEM "version.entities">
-%version-entities;
-]>
-<refentry id="compiling" revision="17 Jan 2002">
-<refmeta>
-<refentrytitle>Compiling</refentrytitle>
-<manvolnum>3</manvolnum>
-<refmiscinfo>GStreamer-Bad Library</refmiscinfo>
-</refmeta>
-
-<refnamediv>
-<refname>Compiling against the bad plugins libraries</refname>
-<refpurpose>
-How to compile against the bad plugins libraries
-</refpurpose>
-</refnamediv>
-
-<refsect1>
-<title>Compiling against the bad plugins libraries</title>
-
-<para>
-To compile against these libraries, you need to tell the compiler where to
-find the header files and libraries. This is done with the
-<application>pkg-config</application> utility.
-</para>
-<para>
-The following interactive shell session demonstrates how
-<application>pkg-config</application> is used:
-<programlisting>
-$ pkg-config --cflags gstreamer-plugins-bad-&GST_API_VERSION;
--D_LARGEFILE_SOURCE -D_FILE_OFFSET_BITS=64 -pthread -I/usr/include/gstreamer-&GST_API_VERSION; -I/usr/include/glib-2.0 -I/usr/lib/glib-2.0/include -I/usr/include/libxml2
-$ pkg-config --libs gstreamer-plugins-bad-&GST_API_VERSION;
--Wl,--export-dynamic -pthread -lgstreamer-&GST_API_VERSION; -lgobject-2.0 -lgmodule-2.0 -ldl -lgthread-2.0 -lxml2 -lpthread -lz -lm -lglib-2.0
-</programlisting>
-</para>
-
-<para>
-Note that, because of the number of libraries provided in this package,
-the pkg-config information <emphasis>does not add -l flags</emphasis> itself
-to choose the libraries to link to.  You must add these yourself to select
-which of the libraries you want to use.
-</para>
-</refsect1>
-
-</refentry>
diff --git a/docs/libs/gst-plugins-bad-libs-docs.sgml b/docs/libs/gst-plugins-bad-libs-docs.sgml
deleted file mode 100644
index dc645c274..000000000
--- a/docs/libs/gst-plugins-bad-libs-docs.sgml
+++ /dev/null
@@ -1,102 +0,0 @@
-<?xml version="1.0"?>
-<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
-               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
-<!ENTITY % version-entities SYSTEM "version.entities">
-%version-entities;
-]>
-<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
-  <bookinfo>
-    <title>GStreamer Bad Plugins &GST_API_VERSION; Library Reference Manual</title>
-    <releaseinfo>
-      for GStreamer Bad Library &GST_API_VERSION; (&GST_VERSION;)
-      <ulink role="online-location" url="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-bad-libs/html/">http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-bad-libs/html/</ulink>.
-    </releaseinfo>
-  </bookinfo>
-
-  <part id="gstreamer-plugins-bad">
-    <title>GStreamer Bad Plugins Libraries</title>
-    <para>
-      This manual describes the libraries provided by the GStreamer Bad Plugins
-      package.
-    </para>
-    <xi:include href="compiling.sgml" />
-
-    <chapter id="codecparsers">
-      <title>Bitstream parsing Library</title>
-      <para>
-        This library should be linked to by getting cflags and libs from
-        <filename>gstreamer-plugins-bad-&GST_API_VERSION;.pc</filename> and adding
-        <filename>-lgstcodeparsers-&GST_API_VERSION;</filename> to the library flags.
-      </para>
-      <xi:include href="xml/gsth264parser.xml" />
-      <xi:include href="xml/gstjpegparser.xml" />
-      <xi:include href="xml/gstmpegvideoparser.xml" />
-      <xi:include href="xml/gstmpeg4parser.xml" />
-      <xi:include href="xml/gstvc1parser.xml" />
-      <xi:include href="xml/gstmpegvideometa.xml" />
-    </chapter>
-
-    <chapter id="mpegts">
-      <title>Mpeg TS helper library</title>
-      <para>
-        This library should be linked to by getting cflags and libs from
-        <filename>gstreamer-plugins-bad-&GST_API_VERSION;.pc</filename> and adding
-        <filename>-lgstmpegts-&GST_API_VERSION;</filename> to the library flags.
-      </para>
-      <xi:include href="xml/gstmpegts.xml" />
-      <xi:include href="xml/gstmpegtssection.xml" />
-      <xi:include href="xml/gstmpegtsdescriptor.xml" />
-      <xi:include href="xml/gst-atsc-section.xml" />
-      <xi:include href="xml/gst-dvb-section.xml" />
-      <xi:include href="xml/gst-atsc-descriptor.xml" />
-      <xi:include href="xml/gst-dvb-descriptor.xml" />
-      <xi:include href="xml/gst-isdb-descriptor.xml" />
-    </chapter>
-
-    <chapter id="tools">
-      <title>Useful elements</title>
-      <xi:include href="xml/gstinsertbin.xml" />
-    </chapter>
-
-    <chapter id="player">
-      <title>Player Library</title>
-      <xi:include href="xml/gstplayer.xml"/>
-      <xi:include href="xml/gstplayer-mediainfo.xml"/>
-      <xi:include href="xml/gstplayer-gmaincontextsignaldispatcher.xml"/>
-      <xi:include href="xml/gstplayer-videooverlayvideorenderer.xml"/>
-      <xi:include href="xml/gstplayer-visualization.xml"/>
-    </chapter>
-
-    <chapter id="webrtc">
-      <title>WebRTC Library</title>
-      <xi:include href="xml/gstwebrtc-dtlstransport.xml"/>
-      <xi:include href="xml/gstwebrtc-icetransport.xml"/>
-      <xi:include href="xml/gstwebrtc-receiver.xml"/>
-      <xi:include href="xml/gstwebrtc-sender.xml"/>
-      <xi:include href="xml/gstwebrtc-sessiondescription.xml"/>
-      <xi:include href="xml/gstwebrtc-transceiver.xml"/>
-    </chapter>
-
-    <chapter>
-      <title>Interfaces</title>
-      <xi:include href="xml/gstphotography.xml" />
-    </chapter>
-  </part>
-
-  <part id="gstreamer-libs-hierarchy">
-    <title>Object Hierarchy</title>
-    <xi:include href="xml/tree_index.sgml" />
-  </part>
-
-  <index id="api-index-full">
-    <title>Index</title>
-    <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
-  </index>
-  <index id="api-index-deprecated" role="deprecated">
-    <title>Index of deprecated API</title>
-    <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
-  </index>
-
-  <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
-</book>
-
diff --git a/docs/libs/gst-plugins-bad-libs-overrides.txt b/docs/libs/gst-plugins-bad-libs-overrides.txt
deleted file mode 100644
index e69de29bb..000000000
--- a/docs/libs/gst-plugins-bad-libs-overrides.txt
+++ /dev/null
diff --git a/docs/libs/gst-plugins-bad-libs.types b/docs/libs/gst-plugins-bad-libs.types
deleted file mode 100644
index 6785f45bc..000000000
--- a/docs/libs/gst-plugins-bad-libs.types
+++ /dev/null
@@ -1,75 +0,0 @@
-#include <gst/gst.h>
-
-#include <gst/codecparsers/gsth264parser.h>
-#include <gst/codecparsers/gstmpegvideoparser.h>
-#include <gst/insertbin/gstinsertbin.h>
-#include <gst/mpegts/mpegts.h>
-#include <gst/player/player.h>
-#include <gst/webrtc/webrtc.h>
-
-gst_mpegts_section_get_type
-gst_mpegts_section_type_get_type
-gst_mpegts_section_table_id_get_type
-
-gst_mpegts_descriptor_get_type
-gst_mpegts_cable_outer_fec_scheme_get_type
-gst_mpegts_modulation_type_get_type
-gst_mpegts_satellite_polarization_type_get_type
-gst_mpegts_satellite_rolloff_get_type
-gst_mpegts_dvb_code_rate_get_type
-gst_mpegts_descriptor_type_get_type
-gst_mpegts_iso639_audio_type_get_type
-gst_mpegts_running_status_get_type
-gst_mpegts_dvb_service_type_get_type
-gst_mpegts_stream_type_get_type
-
-gst_mpegts_section_atsc_table_id_get_type
-gst_mpegts_atsc_mgt_table_type_get_type
-gst_mpegts_atsc_vct_get_type
-gst_mpegts_atsc_vct_source_get_type
-gst_mpegts_atsc_mgt_get_type
-gst_mpegts_atsc_mgt_table_get_type
-gst_mpegts_atsc_string_segment_get_type
-gst_mpegts_atsc_mult_string_get_type
-gst_mpegts_atsc_eit_event_get_type
-gst_mpegts_atsc_eit_get_type
-gst_mpegts_atsc_ett_get_type
-gst_mpegts_atsc_stt_get_type
-
-gst_insert_bin_get_type
-
-
-gst_player_audio_info_get_type
-gst_player_color_balance_type_get_type
-gst_player_error_get_type
-gst_player_g_main_context_signal_dispatcher_get_type
-gst_player_get_type
-gst_player_media_info_get_type
-gst_player_signal_dispatcher_get_type
-gst_player_state_get_type
-gst_player_stream_info_get_type
-gst_player_subtitle_info_get_type
-gst_player_video_info_get_type
-gst_player_video_overlay_video_renderer_get_type
-gst_player_video_renderer_get_type
-gst_player_visualization_get_type
-
-
-gst_webrtc_dtls_setup_get_type
-gst_webrtc_dtls_transport_get_type
-gst_webrtc_dtls_transport_state_get_type
-gst_webrtc_ice_component_get_type
-gst_webrtc_ice_connection_state_get_type
-gst_webrtc_ice_gathering_state_get_type
-gst_webrtc_ice_role_get_type
-gst_webrtc_sdp_type_get_type
-gst_webrtc_ice_transport_get_type
-gst_webrtc_peer_connection_state_get_type
-gst_webrtc_rtp_receiver_get_type
-gst_webrtc_rtp_sender_get_type
-gst_webrtc_session_description_get_type
-gst_webrtc_signaling_state_get_type
-gst_webrtc_rtp_transceiver_direction_get_type
-gst_webrtc_rtp_transceiver_get_type
-gst_webrtc_stats_type_get_type
-
diff --git a/docs/libs/insertbin/index.md b/docs/libs/insertbin/index.md
new file mode 100644
index 000000000..435449afe
--- /dev/null
+++ b/docs/libs/insertbin/index.md
@@ -0,0 +1,7 @@
+---
+short-description: A library that contains a bin to insertally link filter-like elements.
+...
+
+# GstInsertBin
+
+> NOTE: This library API is considered *unstable*
diff --git a/docs/libs/insertbin/sitemap.txt b/docs/libs/insertbin/sitemap.txt
new file mode 100644
index 000000000..4f91fcd8a
--- /dev/null
+++ b/docs/libs/insertbin/sitemap.txt
@@ -0,0 +1 @@
+gi-index
diff --git a/docs/libs/mpegts/index.md b/docs/libs/mpegts/index.md
new file mode 100644
index 000000000..460ea9633
--- /dev/null
+++ b/docs/libs/mpegts/index.md
@@ -0,0 +1,7 @@
+# Mpeg TS helper library
+
+This library should be linked to by getting cflags and libs from
+gstreamer-plugins-bad-{{ gst_api_version.md }}.pc and adding
+-lgstmpegts-{{ gst_api_version.md }} to the library flags.
+
+> NOTE: This library API is considered *unstable*
diff --git a/docs/libs/mpegts/sitemap.txt b/docs/libs/mpegts/sitemap.txt
new file mode 100644
index 000000000..4f91fcd8a
--- /dev/null
+++ b/docs/libs/mpegts/sitemap.txt
@@ -0,0 +1 @@
+gi-index
diff --git a/docs/libs/player/index.md b/docs/libs/player/index.md
new file mode 100644
index 000000000..4e39bec44
--- /dev/null
+++ b/docs/libs/player/index.md
@@ -0,0 +1,3 @@
+# Player Library
+
+> NOTE: This library API is considered *unstable*
diff --git a/docs/libs/player/sitemap.txt b/docs/libs/player/sitemap.txt
new file mode 100644
index 000000000..4f91fcd8a
--- /dev/null
+++ b/docs/libs/player/sitemap.txt
@@ -0,0 +1 @@
+gi-index
diff --git a/docs/libs/tools/index.md b/docs/libs/tools/index.md
new file mode 100644
index 000000000..d21a8800c
--- /dev/null
+++ b/docs/libs/tools/index.md
@@ -0,0 +1,3 @@
+# Useful elements
+
+> NOTE: This library API is considered *unstable*
diff --git a/docs/libs/tools/sitemap.txt b/docs/libs/tools/sitemap.txt
new file mode 100644
index 000000000..4f91fcd8a
--- /dev/null
+++ b/docs/libs/tools/sitemap.txt
@@ -0,0 +1 @@
+gi-index
diff --git a/docs/libs/video/index.md b/docs/libs/video/index.md
new file mode 100644
index 000000000..9a1c20e2f
--- /dev/null
+++ b/docs/libs/video/index.md
@@ -0,0 +1,3 @@
+# Video helpers and baseclasses
+
+> NOTE: This library API is considered *unstable*
diff --git a/docs/libs/video/sitemap.txt b/docs/libs/video/sitemap.txt
new file mode 100644
index 000000000..4f91fcd8a
--- /dev/null
+++ b/docs/libs/video/sitemap.txt
@@ -0,0 +1 @@
+gi-index
diff --git a/docs/libs/webrtc/index.md b/docs/libs/webrtc/index.md
new file mode 100644
index 000000000..24d968e83
--- /dev/null
+++ b/docs/libs/webrtc/index.md
@@ -0,0 +1,6 @@
+# WebRTC Library
+
+This library should be linked to by getting cflags and libs from
+gstreamer-webrtc-{{ gst_api_version.md }}
+
+> NOTE: This library API is considered *unstable*
diff --git a/docs/libs/webrtc/sitemap.txt b/docs/libs/webrtc/sitemap.txt
new file mode 100644
index 000000000..4f91fcd8a
--- /dev/null
+++ b/docs/libs/webrtc/sitemap.txt
@@ -0,0 +1 @@
+gi-index