Updated documentation formatting

[lms] / ruby-lightmediascanner / ruby-lightmediascanner.c

diff --git a/ruby-lightmediascanner/ruby-lightmediascanner.c b/ruby-lightmediascanner/ruby-lightmediascanner.c
index b707af1..54f243f 100644 (file)
--- a/ruby-lightmediascanner/ruby-lightmediascanner.c
+++ b/ruby-lightmediascanner/ruby-lightmediascanner.c
@@ -20,6 +20,14 @@
 
 #include "ruby-lightmediascanner.h"
 
+/**
+ * LightMediaScanner is the outer module of the 
+ * LightMediaScanner Ruby extension.
+ *
+ * It doesn't currently perform any function other than 
+ * namespacing. You probably want to see LightMediaScanner::Scanner 
+ * and LightMediaScanner::Parser .
+ */
 void Init_lightmediascanner() {
        lightmediascanner_module = rb_define_module("LightMediaScanner");
        Init_lightmediascanner_scanner();