summaryrefslogtreecommitdiff
path: root/modules
diff options
context:
space:
mode:
authorAlfred E. Heggestad <aeh@db.org>2015-06-20 10:52:08 +0200
committerAlfred E. Heggestad <aeh@db.org>2015-06-20 10:52:08 +0200
commitbe510a9b01e06bc6115c8a84b5231683bba91c8b (patch)
treea568f6873ff4f4d930b65225c022daf913991e87 /modules
parentee1e658235812740c2739bd2fe85f220128e4766 (diff)
module: add more documentation
Diffstat (limited to 'modules')
-rw-r--r--modules/menu/menu.c10
-rw-r--r--modules/mwi/mwi.c10
-rw-r--r--modules/opengl/opengl.m9
-rw-r--r--modules/opengles/opengles.c9
4 files changed, 35 insertions, 3 deletions
diff --git a/modules/menu/menu.c b/modules/menu/menu.c
index 08b17f7..5e38c5d 100644
--- a/modules/menu/menu.c
+++ b/modules/menu/menu.c
@@ -8,6 +8,16 @@
#include <baresip.h>
+/**
+ * @defgroup menu menu
+ *
+ * Interactive menu
+ *
+ * This module must be loaded if you want to use the interactive menu
+ * to control the Baresip application.
+ */
+
+
/** Defines the status modes */
enum statmode {
STATMODE_CALL = 0,
diff --git a/modules/mwi/mwi.c b/modules/mwi/mwi.c
index a04e6bf..c1670a0 100644
--- a/modules/mwi/mwi.c
+++ b/modules/mwi/mwi.c
@@ -1,13 +1,21 @@
/**
* @file mwi.c Message Waiting Indication (RFC 3842)
*
- * Copyright (C) 2010 Creytiv.com
+ * Copyright (C) 2010 - 2015 Creytiv.com
*/
#include <string.h>
#include <re.h>
#include <baresip.h>
+/**
+ * @defgroup mwi mwi
+ *
+ * Message Waiting Indication
+ *
+ */
+
+
struct mwi {
struct le le;
struct sipsub *sub;
diff --git a/modules/opengl/opengl.m b/modules/opengl/opengl.m
index 2ffa925..0006767 100644
--- a/modules/opengl/opengl.m
+++ b/modules/opengl/opengl.m
@@ -1,7 +1,7 @@
/**
* @file opengl.m Video driver for OpenGL on MacOSX
*
- * Copyright (C) 2010 Creytiv.com
+ * Copyright (C) 2010 - 2015 Creytiv.com
*/
#include <Cocoa/Cocoa.h>
#include <OpenGL/gl.h>
@@ -11,6 +11,13 @@
#include <baresip.h>
+/**
+ * @defgroup opengl opengl
+ *
+ * Video display module for OpenGL on MacOSX
+ */
+
+
struct vidisp_st {
const struct vidisp *vd; /**< Inheritance (1st) */
struct vidsz size; /**< Current size */
diff --git a/modules/opengles/opengles.c b/modules/opengles/opengles.c
index e435b1d..712f868 100644
--- a/modules/opengles/opengles.c
+++ b/modules/opengles/opengles.c
@@ -1,7 +1,7 @@
/**
* @file opengles.c Video driver for OpenGLES
*
- * Copyright (C) 2010 Creytiv.com
+ * Copyright (C) 2010 - 2015 Creytiv.com
*/
#include <re.h>
@@ -12,6 +12,13 @@
#include "opengles.h"
+/**
+ * @defgroup opengles opengles
+ *
+ * Video display module for OpenGLES on Android
+ */
+
+
static struct vidisp *vid;