summaryrefslogtreecommitdiffstats
path: root/gst/udp/gstudpsink.c
diff options
context:
space:
mode:
authorStefan Kost <ensonic@users.sf.net>2009-01-28 12:29:42 +0200
committerStefan Kost <ensonic@users.sf.net>2009-01-28 12:32:59 +0200
commita99d3f8769ed3fd1266d5216ecefebfd1bdcf663 (patch)
tree4a5cf5e0f2f44b1f9ccea5344c38ef98f0a92990 /gst/udp/gstudpsink.c
parent00fdca0c14eb9a5fe6b8b9f2d5ce2313e3b32f23 (diff)
Update and add documentation for plugins with no deps (gst).
Link to properties. Correct titles for examples. Document a few trivial cases. Keep lists in section file and docs/plugins/Makefile.am alphabetically ordered.
Diffstat (limited to 'gst/udp/gstudpsink.c')
-rw-r--r--gst/udp/gstudpsink.c15
1 files changed, 14 insertions, 1 deletions
diff --git a/gst/udp/gstudpsink.c b/gst/udp/gstudpsink.c
index f808c3b5..a9666ed0 100644
--- a/gst/udp/gstudpsink.c
+++ b/gst/udp/gstudpsink.c
@@ -16,7 +16,20 @@
* Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA.
*/
-
+/**
+ * SECTION:element-udpsink
+ * @see_also: udpsrc, multifdsink
+ *
+ * udpsink is a network sink that sends UDP packets to the network.
+ * It can be combined with RTP payloaders to implement RTP streaming.
+ *
+ * <refsect2>
+ * <title>Examples</title>
+ * |[
+ * gst-launch -v audiotestsrc ! udpsink
+ * ]|
+ * </refsect2>
+ */
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif