module documentation

1 files changed, 18 insertions, 0 deletions

diff --git a/modules/vidbridge/vidbridge.c b/modules/vidbridge/vidbridge.c
index 69aa41f..495264e 100644
--- a/modules/vidbridge/vidbridge.c
+++ b/modules/vidbridge/vidbridge.c
@@ -9,6 +9,24 @@
 #include "vidbridge.h"
 
 
+/**
+ * @defgroup vidbridge vidbridge
+ *
+ * Video bridge module
+ *
+ * This module can be used to connect two video devices together,
+ * so that all output to VIDISP device is bridged as the input to
+ * a VIDSRC device.
+ *
+ * Sample config:
+ *
+ \verbatim
+  video_display           vidbridge,pseudo0
+  video_source            vidbridge,pseudo0
+ \endverbatim
+ */
+
+
 static struct vidisp *vidisp;
 static struct vidsrc *vidsrc;