summaryrefslogtreecommitdiff
path: root/ext/srtp
diff options
context:
space:
mode:
authorThibault Saunier <thibault.saunier@osg.samsung.com>2017-03-08 15:01:13 -0300
committerThibault Saunier <thibault.saunier@osg.samsung.com>2017-04-12 12:57:57 -0300
commit78022a6e0c05ce482b798cf638cbd3f901a5094e (patch)
tree9725b5939d840f6eb3e8f39e032866e82413cb83 /ext/srtp
parent90f766cc518b4fde651162d6e0c7d190373e3c61 (diff)
downloadgstreamer-plugins-bad-78022a6e0c05ce482b798cf638cbd3f901a5094e.tar.gz
docs: Port all docstring to gtk-doc markdown
Diffstat (limited to 'ext/srtp')
-rw-r--r--ext/srtp/gstsrtpdec.c6
-rw-r--r--ext/srtp/gstsrtpenc.c3
2 files changed, 5 insertions, 4 deletions
diff --git a/ext/srtp/gstsrtpdec.c b/ext/srtp/gstsrtpdec.c
index 9967dd543..e1be70e0a 100644
--- a/ext/srtp/gstsrtpdec.c
+++ b/ext/srtp/gstsrtpdec.c
@@ -46,6 +46,7 @@
/**
* SECTION:element-srtpdec
+ * @title: srtpdec
* @see_also: srtpenc
*
* gstrtpdec acts as a decoder that removes security from SRTP and SRTCP
@@ -95,8 +96,7 @@
* other means. If no rollover counter is provided by the user, 0 is
* used by default.
*
- * <refsect2>
- * <title>Example pipelines</title>
+ * ## Example pipelines
* |[
* gst-launch-1.0 udpsrc port=5004 caps='application/x-srtp, payload=(int)8, ssrc=(uint)1356955624, srtp-key=(buffer)012345678901234567890123456789012345678901234567890123456789, srtp-cipher=(string)aes-128-icm, srtp-auth=(string)hmac-sha1-80, srtcp-cipher=(string)aes-128-icm, srtcp-auth=(string)hmac-sha1-80' ! srtpdec ! rtppcmadepay ! alawdec ! pulsesink
* ]| Receive PCMA SRTP packets through UDP using caps to specify
@@ -105,7 +105,7 @@
* gst-launch-1.0 audiotestsrc ! alawenc ! rtppcmapay ! 'application/x-rtp, payload=(int)8, ssrc=(uint)1356955624' ! srtpenc key="012345678901234567890123456789012345678901234567890123456789" ! udpsink port=5004
* ]| Send PCMA SRTP packets through UDP, nothing how the SSRC is forced so
* that the receiver will recognize it.
- * </refsect2>
+ *
*/
#ifdef HAVE_CONFIG_H
diff --git a/ext/srtp/gstsrtpenc.c b/ext/srtp/gstsrtpenc.c
index c9ae98070..ff17fd03f 100644
--- a/ext/srtp/gstsrtpenc.c
+++ b/ext/srtp/gstsrtpenc.c
@@ -45,7 +45,8 @@
*/
/**
- * SECTION:gst-plugin-bad-plugins-srtpenc
+ * SECTION:element-srtpenc
+ * @title: srtpenc
* @see_also: srtpdec
*
* gstrtpenc acts as an encoder that adds security to RTP and RTCP