summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAlfred E. Heggestad <aeh@db.org>2015-06-17 23:17:18 +0200
committerAlfred E. Heggestad <aeh@db.org>2015-06-17 23:17:18 +0200
commit2023026a65c2cd425154999a3b7981c8b1b28985 (patch)
treefd59e0bdb74dfc1040e4ff8eba8464096d881a6a
parent69d26555b437261be0d7e6c6337a4bc412c43988 (diff)
module: updated documentation
-rw-r--r--modules/auloop/auloop.c19
-rw-r--r--modules/avcapture/avcapture.m7
-rw-r--r--modules/contact/contact.c8
3 files changed, 30 insertions, 4 deletions
diff --git a/modules/auloop/auloop.c b/modules/auloop/auloop.c
index b432da9..c87b060 100644
--- a/modules/auloop/auloop.c
+++ b/modules/auloop/auloop.c
@@ -1,7 +1,7 @@
/**
* @file auloop.c Audio loop
*
- * Copyright (C) 2010 Creytiv.com
+ * Copyright (C) 2010 - 2015 Creytiv.com
*/
#include <string.h>
#include <re.h>
@@ -9,6 +9,23 @@
#include <baresip.h>
+/**
+ * @defgroup auloop auloop
+ *
+ * Application module for testing audio drivers
+ *
+ * The audio loop will connect the AUSRC device to the AUPLAY device
+ * so that a local loopback audio can be heard. Different audio parameters
+ * can be tested, such as sampling rate and number of channels.
+ *
+ * The following commands are available:
+ \verbatim
+ a Start audio-loop
+ A Stop audio-loop
+ \endverbatim
+ */
+
+
/* Configurable items */
#define PTIME 20
diff --git a/modules/avcapture/avcapture.m b/modules/avcapture/avcapture.m
index 7387b65..8f07e7d 100644
--- a/modules/avcapture/avcapture.m
+++ b/modules/avcapture/avcapture.m
@@ -9,6 +9,13 @@
#include <AVFoundation/AVFoundation.h>
+/**
+ * @defgroup avcapture avcapture
+ *
+ * Video source using OSX/iOS AVFoundation
+ */
+
+
static struct vidsrc *vidsrc;
diff --git a/modules/contact/contact.c b/modules/contact/contact.c
index 7068ac2..18bd9c0 100644
--- a/modules/contact/contact.c
+++ b/modules/contact/contact.c
@@ -1,15 +1,17 @@
/**
* @file modules/contact/contact.c Contacts module
*
- * Copyright (C) 2010 Creytiv.com
+ * Copyright (C) 2010 - 2015 Creytiv.com
*/
#include <string.h>
#include <re.h>
#include <baresip.h>
-/*
- * Contact module
+/**
+ * @defgroup contact contact
+ *
+ * Contact module reading contacts from a file
*
* - read contact entries from ~/.baresip/contacts
* - populate local database of contacts