diff options
| author | Stefan Kost <ensonic@users.sf.net> | 2009-01-28 17:46:06 +0200 |
|---|---|---|
| committer | Stefan Kost <ensonic@users.sf.net> | 2009-01-28 18:05:09 +0200 |
| commit | 9cf73bdd8f18505269fa4b6d1d80127945e735b1 (patch) | |
| tree | 799b0f7efa6d37844173fbd636bc58254cbccd78 /ext/pulse | |
| parent | 1f32369451bd5ddf7a59defef7900d508ee144da (diff) | |
Update and add documentation for plugins with deps (ext).
Link to properties. Correct titles for examples. Document a few trivial cases. Keep lists in section file and docs/plugins/Makefile.am alphabetically ordered. Fix warnings that gtk-doc points out.
Diffstat (limited to 'ext/pulse')
| -rw-r--r-- | ext/pulse/pulsemixer.c | 6 | ||||
| -rw-r--r-- | ext/pulse/pulsesink.c | 22 | ||||
| -rw-r--r-- | ext/pulse/pulsesrc.c | 14 |
3 files changed, 14 insertions, 28 deletions
diff --git a/ext/pulse/pulsemixer.c b/ext/pulse/pulsemixer.c index 3a0de9da..5ced971b 100644 --- a/ext/pulse/pulsemixer.c +++ b/ext/pulse/pulsemixer.c @@ -21,16 +21,14 @@ /** * SECTION:element-pulsemixer - * @short_description: Element to control sound input and output levels for the PulseAudio sound server * @see_also: pulsesrc, pulsesink * - * <refsect2> - * <para> * This element lets you adjust sound input and output levels for the * PulseAudio sound server. It supports the GstMixer interface, which can be * used to obtain a list of available mixer tracks. Set the mixer element to * READY state before using the GstMixer interface on it. - * </para> + * + * <refsect2> * <title>Example pipelines</title> * <para> * pulsemixer can't be used in a sensible way in gst-launch. diff --git a/ext/pulse/pulsesink.c b/ext/pulse/pulsesink.c index df774990..b41dba50 100644 --- a/ext/pulse/pulsesink.c +++ b/ext/pulse/pulsesink.c @@ -21,28 +21,20 @@ /** * SECTION:element-pulsesink - * @short_description: Output audio to a PulseAudio sound server * @see_also: pulsesrc, pulsemixer * + * This element outputs audio to a + * <ulink href="http://www.pulseaudio.org">PulseAudio sound server</ulink>. + * * <refsect2> - * <para> - * This element outputs audio to a PulseAudio sound server. - * </para> * <title>Example pipelines</title> - * <para> - * <programlisting> + * |[ * gst-launch -v filesrc location=sine.ogg ! oggdemux ! vorbisdec ! audioconvert ! audioresample ! pulsesink - * </programlisting> - * Play an Ogg/Vorbis file. - * </para> - * <para> - * <programlisting> + * ]| Play an Ogg/Vorbis file. + * |[ * gst-launch -v audiotestsrc ! audioconvert ! volume volume=0.4 ! pulsesink - * </programlisting> - * Play a 440Hz sine wave. - * </para> + * ]| Play a 440Hz sine wave. * </refsect2> - * */ #ifdef HAVE_CONFIG_H diff --git a/ext/pulse/pulsesrc.c b/ext/pulse/pulsesrc.c index 0e1ca20e..08fec595 100644 --- a/ext/pulse/pulsesrc.c +++ b/ext/pulse/pulsesrc.c @@ -21,20 +21,16 @@ /** * SECTION:element-pulsesrc - * @short_description: Capture audio from a PulseAudio sound server * @see_also: pulsesink, pulsemixer * + * This element captures audio from a + * <ulink href="http://www.pulseaudio.org">PulseAudio sound server</ulink>. + * * <refsect2> - * <para> - * This element captures audio from a PulseAudio sound server. - * </para> * <title>Example pipelines</title> - * <para> - * <programlisting> + * |[ * gst-launch -v pulsesrc ! audioconvert ! vorbisenc ! oggmux ! filesink location=alsasrc.ogg - * </programlisting> - * Record from a sound card using ALSA and encode to Ogg/Vorbis. - * </para> + * ]| Record from a sound card using ALSA and encode to Ogg/Vorbis. * </refsect2> */ |