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/esd | |
| 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/esd')
| -rw-r--r-- | ext/esd/esdmon.c | 6 | ||||
| -rw-r--r-- | ext/esd/esdsink.c | 16 |
2 files changed, 10 insertions, 12 deletions
diff --git a/ext/esd/esdmon.c b/ext/esd/esdmon.c index 880af9d8..25b1201e 100644 --- a/ext/esd/esdmon.c +++ b/ext/esd/esdmon.c @@ -20,9 +20,10 @@ * Boston, MA 02111-1307, USA. */ /** - * SECTION:element-esdmod + * SECTION:element-esdmon + * @see_also: #GstAlsaSrc, #GstAutoAudioSrc * - * This element outputs sound to an already-running Enlightened Sound Daemon + * This element records sound from an already-running Enlightened Sound Daemon * (ESound Daemon, esd). Note that a sound daemon will never be auto-spawned * through this element (regardless of the system configuration), since this * is actively prevented by the element. If you must use esd, you need to @@ -38,6 +39,7 @@ * ]| Record from audioinput * </refsect2> */ + #ifdef HAVE_CONFIG_H #include "config.h" #endif diff --git a/ext/esd/esdsink.c b/ext/esd/esdsink.c index ed34d793..ddc84e6a 100644 --- a/ext/esd/esdsink.c +++ b/ext/esd/esdsink.c @@ -26,24 +26,20 @@ * SECTION:element-esdsink * @see_also: #GstAlsaSink, #GstAutoAudioSink * - * <refsect2> - * <para> * This element outputs sound to an already-running Enlightened Sound Daemon * (ESound Daemon, esd). Note that a sound daemon will never be auto-spawned * through this element (regardless of the system configuration), since this * is actively prevented by the element. If you must use esd, you need to * make sure it is started automatically with your session or otherwise. - * </para> - * <para> + * * TODO: insert some comments about how sucky esd is and that all the cool * kids use pulseaudio or whatever these days. - * </para> - * <para> - * Simple example pipeline that plays an Ogg/Vorbis file via esd: - * <programlisting> + * + * <refsect2> + * <title>Example launch line</title> + * |[ * gst-launch -v filesrc location=foo.ogg ! decodebin ! audioconvert ! audioresample ! esdsink - * </programlisting> - * </para> + * ]| play an Ogg/Vorbis audio file via esd * </refsect2> */ |