After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 564139 - Documentation of TCP plugins
Documentation of TCP plugins
Status: RESOLVED FIXED
Product: GStreamer
Classification: Platform
Component: gst-plugins-base
0.10.x
Other All
: Normal minor
: 0.10.23
Assigned To: Stefan Sauer (gstreamer, gtkdoc dev)
GStreamer Maintainers
Depends on:
Blocks:
 
 
Reported: 2008-12-11 16:22 UTC by Steman Allfan
Modified: 2009-03-23 15:04 UTC
See Also:
GNOME target: ---
GNOME version: ---



Description Steman Allfan 2008-12-11 16:22:18 UTC
It seems that there is no documentation for all TCP plugins but the tcpserversink plugin as seen in the gst-plugins-base-plugins documentation [http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-plugins/html/].

But in the overview of all available plugins [http://gstreamer.freedesktop.org/documentation/plugins.html] they get listed.

tcp	transfer data over the network via TCP
  	multifdsink	Send data to multiple filedescriptors
  	tcpclientsink	Send data as a client over the network via TCP
  	tcpclientsrc	Receive data as a client over the network via TCP
  	tcpserversink	Send data as a server over the network via TCP
  	tcpserversrc	Receive data as a server over the network via TCP

Is their a chance, that someone who is familiar with those, could write a documentation for the missing ones?
Comment 1 Wim Taymans 2008-12-16 20:17:26 UTC
        * docs/plugins/Makefile.am:
        * docs/plugins/gst-plugins-base-plugins-docs.sgml:
        * docs/plugins/gst-plugins-base-plugins-sections.txt:
        * gst/tcp/gsttcpclientsink.c:
        * gst/tcp/gsttcpclientsrc.c:
        * gst/tcp/gsttcpserversrc.c:
        Add minimal docs to make the remaining tcp elements show up.
        Fixes #564139.
Comment 2 Stefan Sauer (gstreamer, gtkdoc dev) 2009-03-20 21:32:30 UTC
Having gst-launch lines would be nice too. Will try to add them next week.
Comment 3 Stefan Sauer (gstreamer, gtkdoc dev) 2009-03-23 15:04:49 UTC
commit 3d20bad4ba3fd382b4520331e247053ccf6fbbfe
Author: Stefan Kost <ensonic@users.sf.net>
Date:   Mon Mar 23 16:19:11 2009 +0200

    docs: add examples for tcp elements, also use correct section name. Fixes #564139
    
    Updated the examples in the README to actually work. Add them to api docs. Tests
    the api-docs and fix the section names to make the docs actualy show up.
    The example for "tcpserversrc" needs review (might be an element bug).