summaryrefslogtreecommitdiff
path: root/modules/srtp
diff options
context:
space:
mode:
authorAlfred E. Heggestad <aeh@db.org>2015-11-29 19:01:31 +0100
committerAlfred E. Heggestad <aeh@db.org>2015-11-29 19:01:31 +0100
commit82dd23761e6b2631987bf10e167bb37552fd60cb (patch)
treea8982ac127972645975cd73d078e731c32ee9cb8 /modules/srtp
parent02c01eaf685e078955018b33ef3934f04d15bc0c (diff)
srtp: add documentation block
Diffstat (limited to 'modules/srtp')
-rw-r--r--modules/srtp/srtp.c17
1 files changed, 17 insertions, 0 deletions
diff --git a/modules/srtp/srtp.c b/modules/srtp/srtp.c
index cd8fbf6..c0c9c36 100644
--- a/modules/srtp/srtp.c
+++ b/modules/srtp/srtp.c
@@ -8,6 +8,23 @@
#include "sdes.h"
+/**
+ * @defgroup srtp srtp
+ *
+ * Secure Real-time Transport Protocol module
+ *
+ * This module implements media encryption using SRTP and SDES.
+ *
+ * SRTP can be enabled in ~/.baresip/accounts:
+ *
+ \verbatim
+ <sip:user@domain.com>;mediaenc=srtp
+ <sip:user@domain.com>;mediaenc=srtp-mand
+ \endverbatim
+ *
+ */
+
+
#define SRTP_MASTER_KEY_LEN 30