summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAlfred E. Heggestad <aeh@db.org>2015-06-19 22:16:09 +0200
committerAlfred E. Heggestad <aeh@db.org>2015-06-19 22:16:09 +0200
commit92f52bf6180f03d0d148cd4db15e07dfb97a5d53 (patch)
tree97e1419735b695f80aef09b564a96488eec8201f
parent664089792dd38fcaff3e8b2ca9bd727d1ed79123 (diff)
module: add some more docs
-rw-r--r--modules/httpd/httpd.c17
-rw-r--r--modules/ilbc/ilbc.c6
-rw-r--r--modules/isac/isac.c6
-rw-r--r--modules/l16/l16.c9
4 files changed, 34 insertions, 4 deletions
diff --git a/modules/httpd/httpd.c b/modules/httpd/httpd.c
index 3d21203..fcf7d9e 100644
--- a/modules/httpd/httpd.c
+++ b/modules/httpd/httpd.c
@@ -1,12 +1,27 @@
/**
* @file httpd.c Webserver UI module
*
- * Copyright (C) 2010 Creytiv.com
+ * Copyright (C) 2010 - 2015 Creytiv.com
*/
#include <re.h>
#include <baresip.h>
+/**
+ * @defgroup httpd httpd
+ *
+ * HTTP Server module for the User-Interface
+ *
+ * Open your favourite web browser and point it to http://127.0.0.1:8000/
+ *
+ * Example URLs:
+ \verbatim
+ http://127.0.0.1:8000?h -- Print the Help menu
+ http://127.0.0.1:8000?d1234@target.com -- Make an outgoing call
+ \endverbatim
+ */
+
+
static struct http_sock *httpsock;
diff --git a/modules/ilbc/ilbc.c b/modules/ilbc/ilbc.c
index 549be4d..229dc28 100644
--- a/modules/ilbc/ilbc.c
+++ b/modules/ilbc/ilbc.c
@@ -10,7 +10,11 @@
#include <iLBC_encode.h>
-/*
+/**
+ * @defgroup ilbc ilbc
+ *
+ * iLBC audio codec
+ *
* This module implements the iLBC audio codec as defined in:
*
* RFC 3951 Internet Low Bit Rate Codec (iLBC)
diff --git a/modules/isac/isac.c b/modules/isac/isac.c
index b1aa96e..648031a 100644
--- a/modules/isac/isac.c
+++ b/modules/isac/isac.c
@@ -8,7 +8,11 @@
#include "isac.h"
-/*
+/**
+ * @defgroup isac isac
+ *
+ * iSAC audio codec
+ *
* draft-ietf-avt-rtp-isac-04
*/
diff --git a/modules/l16/l16.c b/modules/l16/l16.c
index c506f4b..a8dc97f 100644
--- a/modules/l16/l16.c
+++ b/modules/l16/l16.c
@@ -1,12 +1,19 @@
/**
* @file l16.c 16-bit linear codec
*
- * Copyright (C) 2010 Creytiv.com
+ * Copyright (C) 2010 - 2015 Creytiv.com
*/
#include <re.h>
#include <baresip.h>
+/**
+ * @defgroup l16 l16
+ *
+ * Linear 16-bit audio codec
+ */
+
+
enum {NR_CODECS = 8};