Updated documentation formatting

[lms] / ruby-lightmediascanner / lightmediascanner_parser.c

diff --git a/ruby-lightmediascanner/lightmediascanner_parser.c b/ruby-lightmediascanner/lightmediascanner_parser.c
index d23c66f..e48c5c5 100644 (file)
--- a/ruby-lightmediascanner/lightmediascanner_parser.c
+++ b/ruby-lightmediascanner/lightmediascanner_parser.c
@@ -26,9 +26,11 @@ typedef struct {
 } ParserRuby;
 
 /**
+ *
  * Native memory deletion function 
- * @param self The current Parser instance
+ *
  * @return nil
+ *
  */
 static VALUE parser_free(VALUE self) {
        ParserRuby *parser;
@@ -46,10 +48,13 @@ static VALUE parser_free(VALUE self) {
 #if 0
 // Obsolete
 /**
+ *
  * Add parser plugin, given its shared object path.
- * @param self The current Parser instance
+ *
  * @param name path to shared object (usable by dlopen(3)).
+ *
  * @return A new Parser
+ *
  */
 static VALUE scanner_add_parser(VALUE self, VALUE name) {
        lms_t *lms;
@@ -74,12 +79,17 @@ static VALUE scanner_add_parser(VALUE self, VALUE name) {
 #endif
 
 /**
+ *
  * Parser#new
+ *
  * constructor
- * @param obj The LightMediaScanner::Parser class
+ *
  * @param parent The Scanner to which the parser belongs
+ *
  * @param name path to shared object (usable by dlopen(3)).
+ *
  * @return A new Parser
+ *
  */
 static VALUE parser_new(VALUE obj, VALUE parent, VALUE name) {
        lms_t *lms;
@@ -106,6 +116,10 @@ static VALUE parser_new(VALUE obj, VALUE parent, VALUE name) {
        return Data_Wrap_Struct(lightmediascanner_parser, 0, parser_free, parser);
 }// scanner_new
 
+/**
+ * LightMediaScanner::Parser is a class to represent 
+ * a LightMediaScanner plugin.
+ */
 void Init_lightmediascanner_parser() {
        lightmediascanner_parser = rb_define_class_under(lightmediascanner_module, "Parser", rb_cObject);
        rb_define_singleton_method(lightmediascanner_parser, "new", parser_new, 2);