From 76ec6d3760157302b888f11001a406a5ededd8ba Mon Sep 17 00:00:00 2001 From: Stefan Sauer Date: Fri, 31 Jan 2014 23:27:03 +0100 Subject: [PATCH] docs: doc fixes for audio library Add sections docs for audiometa. Fix sections docs for audiochannels. Remove old mixerutil section. --- docs/libs/gst-plugins-base-libs-docs.sgml | 1 - docs/libs/gst-plugins-base-libs-sections.txt | 7 ------- gst-libs/gst/audio/audio-channels.c | 6 +++--- gst-libs/gst/audio/gstaudiometa.c | 11 ++++++++++- 4 files changed, 13 insertions(+), 12 deletions(-) diff --git a/docs/libs/gst-plugins-base-libs-docs.sgml b/docs/libs/gst-plugins-base-libs-docs.sgml index 78e4ad2940..734c46a483 100644 --- a/docs/libs/gst-plugins-base-libs-docs.sgml +++ b/docs/libs/gst-plugins-base-libs-docs.sgml @@ -59,7 +59,6 @@ - diff --git a/docs/libs/gst-plugins-base-libs-sections.txt b/docs/libs/gst-plugins-base-libs-sections.txt index f0b17b9173..d8498a445f 100644 --- a/docs/libs/gst-plugins-base-libs-sections.txt +++ b/docs/libs/gst-plugins-base-libs-sections.txt @@ -372,13 +372,6 @@ GST_AUDIO_FILTER_INFO GST_AUDIO_FILTER_RATE -
-gstaudiomixerutils -gst/audio/mixerutils.h -GstAudioMixerFilterFunc -gst_audio_default_registry_mixer_filter -
-
gstaudiosink gst/audio/gstaudiosink.h diff --git a/gst-libs/gst/audio/audio-channels.c b/gst-libs/gst/audio/audio-channels.c index 2f6f7a543b..e5d2a555c2 100644 --- a/gst-libs/gst/audio/audio-channels.c +++ b/gst-libs/gst/audio/audio-channels.c @@ -17,10 +17,10 @@ * Boston, MA 02110-1301, USA. */ /** - * SECTION:gstaudio - * @short_description: Support library for audio elements + * SECTION:gstaudiochannels + * @short_description: Support library for audio channel handling * - * This library contains some helper functions for audio elements. + * This library contains some helper functions for multichannel audio. */ #ifdef HAVE_CONFIG_H diff --git a/gst-libs/gst/audio/gstaudiometa.c b/gst-libs/gst/audio/gstaudiometa.c index b0a18459af..0cadc02bb4 100644 --- a/gst-libs/gst/audio/gstaudiometa.c +++ b/gst-libs/gst/audio/gstaudiometa.c @@ -17,6 +17,15 @@ * Boston, MA 02110-1301, USA. */ +/** + * SECTION:gstaudiometa + * @short_description: Buffer metadata for audio downmix matrix handling + * + * #GstAudioDownmixMeta defines an audio downmix matrix to be send along with + * audio buffers. These functions in this module help to create and attach the + * meta as well as extracting it. + */ + #include #include "gstaudiometa.h" @@ -103,7 +112,7 @@ gst_buffer_get_audio_downmix_meta_for_channels (GstBuffer * buffer, * @to_channels: The number of channels of the destination * @matrix: The matrix coefficients. * - * Attaches GstAudioDownmixMeta metadata to @buffer with the given parameters. + * Attaches #GstAudioDownmixMeta metadata to @buffer with the given parameters. * * @matrix is an two-dimensional array of @to_channels times @from_channels * coefficients, i.e. the i-th output channels is constructed by multiplicating