summaryrefslogtreecommitdiff
path: root/modules/vidloop
diff options
context:
space:
mode:
authorAlfred E. Heggestad <aeh@db.org>2015-11-29 09:48:26 +0100
committerAlfred E. Heggestad <aeh@db.org>2015-11-29 09:48:26 +0100
commit3e04c639549873f752dc077d8a0e5cf58fa12c7b (patch)
treece203c05017199b19ed63454dbad16a934efaeac /modules/vidloop
parent8497126045f34963b04e79cd900f82049a857f37 (diff)
modules: update documentation header
Diffstat (limited to 'modules/vidloop')
-rw-r--r--modules/vidloop/vidloop.c20
1 files changed, 20 insertions, 0 deletions
diff --git a/modules/vidloop/vidloop.c b/modules/vidloop/vidloop.c
index 381e97c..ff38281 100644
--- a/modules/vidloop/vidloop.c
+++ b/modules/vidloop/vidloop.c
@@ -11,6 +11,26 @@
#include <baresip.h>
+/**
+ * @defgroup vidloop vidloop
+ *
+ * A video-loop module for testing
+ *
+ * Simple test module that loops back the video frames from a
+ * video-source to a video-display, optionally via a video codec.
+ *
+ * Example usage without codec:
+ \verbatim
+ baresip -ev
+ \endverbatim
+ *
+ * Example usage with codec:
+ \verbatim
+ baresip -evv
+ \endverbatim
+ */
+
+
/** Internal pixel-format */
#ifndef VIDLOOP_INTERNAL_FMT
#define VIDLOOP_INTERNAL_FMT (VID_FMT_YUV420P)