tcp: fix markup for example pipelines in docs
authorTim-Philipp Müller <tim@centricular.com>
Sat, 5 May 2018 16:02:16 +0000 (18:02 +0200)
committerTim-Philipp Müller <tim@centricular.com>
Sat, 5 May 2018 16:02:16 +0000 (18:02 +0200)
gtk-doc doesn't like the # it seems.

https://bugzilla.gnome.org/show_bug.cgi?id=795548

gst/tcp/gsttcpclientsink.c
gst/tcp/gsttcpclientsrc.c
gst/tcp/gsttcpserversink.c
gst/tcp/gsttcpserversrc.c

index 5e41e98..7a05dea 100644 (file)
  * @title: tcpclientsink
  * @see_also: #tcpclientsink
  *
- * ## Example launch line
+ * ## Example launch line (server):
  * |[
- * # server:
  * nc -l -p 3000
- * # client:
+ * ]|
+ * ## Example launch line (client):
+ * |[
  * gst-launch-1.0 fdsink fd=1 ! tcpclientsink port=3000
  * ]|
  *  everything you type in the client is shown on the server (fd=1 means
index e5e0299..beb20d1 100644 (file)
  * @title: tcpclientsrc
  * @see_also: #tcpclientsink
  *
- * ## Example launch line
+ * ## Example launch line (server):
  * |[
- * # server:
  * nc -l -p 3000
- * # client:
+ * ]|
+ * ## Example launch line (client):
+ * |[
  * gst-launch-1.0 tcpclientsrc port=3000 ! fdsink fd=2
  * ]|
  *  everything you type in the server is shown on the client.
index ef1a805..b00b02e 100644 (file)
  * @title: tcpserversink
  * @see_also: #multifdsink
  *
- * ## Example launch line
+ * ## Example launch line (server):
  * |[
- * # server:
  * gst-launch-1.0 fdsrc fd=1 ! tcpserversink port=3000
- * # client:
+ * ]|
+ * ## Example launch line (client):
+ * |[
  * gst-launch-1.0 tcpclientsrc port=3000 ! fdsink fd=2
  * ]|
  *
index fa9fe9b..a5155bf 100644 (file)
  * @title: tcpserversrc
  * @see_also: #tcpserversink
  *
- * ## Example launch line
+ * ## Example launch line (server):
  * |[
- * # server:
  * gst-launch-1.0 tcpserversrc port=3000 ! fdsink fd=2
- * # client:
+ * ]|
+ * ## Example launch line (client):
+ * |[
  * gst-launch-1.0 fdsrc fd=1 ! tcpclientsink port=3000
  * ]|
  *