summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--modules/celt/celt.c2
-rw-r--r--modules/dtmfio/dtmfio.c7
-rw-r--r--modules/libsrtp/sdes.c9
-rw-r--r--modules/libsrtp/sdes.h10
-rw-r--r--modules/libsrtp/srtp.c4
-rw-r--r--modules/oss/oss.c12
-rw-r--r--modules/portaudio/portaudio.c14
-rw-r--r--modules/sndio/sndio.c7
-rw-r--r--modules/srtp/sdes.c2
-rw-r--r--modules/srtp/sdes.h2
-rw-r--r--modules/syslog/syslog.c7
-rw-r--r--modules/winwave/winwave.c8
12 files changed, 67 insertions, 17 deletions
diff --git a/modules/celt/celt.c b/modules/celt/celt.c
index 8c89678..7460637 100644
--- a/modules/celt/celt.c
+++ b/modules/celt/celt.c
@@ -17,7 +17,7 @@
/**
* @defgroup celt celt
*
- * CELT audio codec
+ * CELT audio codec (deprecated, replaced by opus)
*
* @deprecated Replaced by the @ref opus module
*
diff --git a/modules/dtmfio/dtmfio.c b/modules/dtmfio/dtmfio.c
index a364c80..d05d15e 100644
--- a/modules/dtmfio/dtmfio.c
+++ b/modules/dtmfio/dtmfio.c
@@ -34,7 +34,12 @@
/*************************************************************************/
-/*
+/**
+ * @defgroup dtmfio dtmfio
+ *
+ * DTMF input/output module
+ *
+ *
* # DTMFIO Module
*
* ## Description
diff --git a/modules/libsrtp/sdes.c b/modules/libsrtp/sdes.c
index a750432..1a90f3f 100644
--- a/modules/libsrtp/sdes.c
+++ b/modules/libsrtp/sdes.c
@@ -1,5 +1,5 @@
/**
- * @file sdes.c SDP Security Descriptions for Media Streams (RFC 4568)
+ * @file libsrtp/sdes.c SDP Security Descriptions (RFC 4568)
*
* Copyright (C) 2010 Creytiv.com
*/
@@ -8,10 +8,11 @@
#include "sdes.h"
-const char sdp_attr_crypto[] = "crypto";
+static const char sdp_attr_crypto[] = "crypto";
-int sdes_encode_crypto(struct sdp_media *m, uint32_t tag, const char *suite,
+int libsrtp_sdes_encode_crypto(struct sdp_media *m, uint32_t tag,
+ const char *suite,
const char *key, size_t key_len)
{
return sdp_media_set_lattr(m, true, sdp_attr_crypto, "%u %s inline:%b",
@@ -22,7 +23,7 @@ int sdes_encode_crypto(struct sdp_media *m, uint32_t tag, const char *suite,
/* http://tools.ietf.org/html/rfc4568
* a=crypto:<tag> <crypto-suite> <key-params> [<session-params>]
*/
-int sdes_decode_crypto(struct crypto *c, const char *val)
+int libsrtp_sdes_decode_crypto(struct crypto *c, const char *val)
{
struct pl tag, key_prms;
int err;
diff --git a/modules/libsrtp/sdes.h b/modules/libsrtp/sdes.h
index 66cc2f1..8c2c1f9 100644
--- a/modules/libsrtp/sdes.h
+++ b/modules/libsrtp/sdes.h
@@ -1,5 +1,5 @@
/**
- * @file sdes.h SDP Security Descriptions for Media Streams (RFC 4568) API
+ * @file libsrtp/sdes.h SDP Security Descriptions (RFC 4568) API
*
* Copyright (C) 2010 Creytiv.com
*/
@@ -15,8 +15,8 @@ struct crypto {
struct pl sess_prms; /* optional */
};
-extern const char sdp_attr_crypto[];
-int sdes_encode_crypto(struct sdp_media *m, uint32_t tag, const char *suite,
- const char *key, size_t key_len);
-int sdes_decode_crypto(struct crypto *c, const char *val);
+int libsrtp_sdes_encode_crypto(struct sdp_media *m, uint32_t tag,
+ const char *suite,
+ const char *key, size_t key_len);
+int libsrtp_sdes_decode_crypto(struct crypto *c, const char *val);
diff --git a/modules/libsrtp/srtp.c b/modules/libsrtp/srtp.c
index 244d7cc..7cb2592 100644
--- a/modules/libsrtp/srtp.c
+++ b/modules/libsrtp/srtp.c
@@ -272,7 +272,7 @@ static int sdp_enc(struct menc_st *st, struct sdp_media *m,
if (err)
return err;
- return sdes_encode_crypto(m, tag, suite, key, olen);
+ return libsrtp_sdes_encode_crypto(m, tag, suite, key, olen);
}
@@ -309,7 +309,7 @@ static bool sdp_attr_handler(const char *name, const char *value, void *arg)
struct crypto c;
(void)name;
- if (sdes_decode_crypto(&c, value))
+ if (libsrtp_sdes_decode_crypto(&c, value))
return false;
if (0 != pl_strcmp(&c.key_method, "inline"))
diff --git a/modules/oss/oss.c b/modules/oss/oss.c
index 38d34f3..3a3e938 100644
--- a/modules/oss/oss.c
+++ b/modules/oss/oss.c
@@ -20,6 +20,18 @@
#endif
+/**
+ * @defgroup oss oss
+ *
+ * Open Sound System (OSS) audio driver module
+ *
+ *
+ * References:
+ *
+ * http://www.4front-tech.com/linux.html
+ */
+
+
struct ausrc_st {
struct ausrc *as; /* inheritance */
int fd;
diff --git a/modules/portaudio/portaudio.c b/modules/portaudio/portaudio.c
index 2da18fc..872c6af 100644
--- a/modules/portaudio/portaudio.c
+++ b/modules/portaudio/portaudio.c
@@ -11,10 +11,20 @@
#include <baresip.h>
-/*
- * portaudio v19 is required
+/**
+ * @defgroup portaudio portaudio
+ *
+ * Portaudio audio driver
+ *
+ * (portaudio v19 is required)
+ *
+ *
+ * References:
+ *
+ * http://www.portaudio.com/
*/
+
struct ausrc_st {
struct ausrc *as; /* inheritance */
PaStream *stream_rd;
diff --git a/modules/sndio/sndio.c b/modules/sndio/sndio.c
index 1b54a5a..f769481 100644
--- a/modules/sndio/sndio.c
+++ b/modules/sndio/sndio.c
@@ -12,6 +12,13 @@
#include <baresip.h>
+/**
+ * @defgroup sndio sndio
+ *
+ * This module implements audio driver for OpenBSD sndio
+ */
+
+
struct ausrc_st {
struct ausrc *as;
struct sio_hdl *hdl;
diff --git a/modules/srtp/sdes.c b/modules/srtp/sdes.c
index a750432..49b32aa 100644
--- a/modules/srtp/sdes.c
+++ b/modules/srtp/sdes.c
@@ -1,5 +1,5 @@
/**
- * @file sdes.c SDP Security Descriptions for Media Streams (RFC 4568)
+ * @file /srtp/sdes.c SDP Security Descriptions for Media Streams (RFC 4568)
*
* Copyright (C) 2010 Creytiv.com
*/
diff --git a/modules/srtp/sdes.h b/modules/srtp/sdes.h
index 66cc2f1..a5637bc 100644
--- a/modules/srtp/sdes.h
+++ b/modules/srtp/sdes.h
@@ -1,5 +1,5 @@
/**
- * @file sdes.h SDP Security Descriptions for Media Streams (RFC 4568) API
+ * @file /srtp/sdes.h SDP Security Descriptions for Media Streams API
*
* Copyright (C) 2010 Creytiv.com
*/
diff --git a/modules/syslog/syslog.c b/modules/syslog/syslog.c
index 31c6333..79e479d 100644
--- a/modules/syslog/syslog.c
+++ b/modules/syslog/syslog.c
@@ -9,6 +9,13 @@
#include <baresip.h>
+/**
+ * @defgroup syslog syslog
+ *
+ * This module implements a logging handler for output to syslog
+ */
+
+
#define DEBUG_MODULE ""
#define DEBUG_LEVEL 0
#include <re_dbg.h>
diff --git a/modules/winwave/winwave.c b/modules/winwave/winwave.c
index 279c73b..597f9f1 100644
--- a/modules/winwave/winwave.c
+++ b/modules/winwave/winwave.c
@@ -11,6 +11,14 @@
#include "winwave.h"
+/**
+ * @defgroup winwave winwave
+ *
+ * Windows audio driver module
+ *
+ */
+
+
static struct ausrc *ausrc;
static struct auplay *auplay;