Merge pull request #46 from Lokua/skip-single-star

added options.dox.skipSingleStar:true, added/updated tests

lib/markdox.js

@@ -142,7 +142,8 @@ exports.parse = function(filepath, options, callback) {
   });
 
   options.dox = u.defaults(options.dox || {}, {
-    raw: true
+    raw: true,
+    skipSingleStar: true
   });
 
   fs.readFile(filepath, options.encoding, function(err, data){

test/comment-types-test.js

@@ -0,0 +1,26 @@
+var assert = require('assert');
+var should = require('should');
+var markdox = require('../index');
+
+describe('Markdox', function() {
+
+  it('should only parse valid jsdocs (coffee)', function(done) {
+    var file = __dirname + '/fixtures/comment-types.coffee';
+    markdox.process(file, function(err, output){
+      should.not.exist(err);
+      output.should.not.match(/nope/);
+      output.should.match(/yep/);
+      done();
+    });
+  });
+
+  it('should only parse valid jsdocs (js)', function(done) {
+    var file = __dirname + '/fixtures/comment-types.js';
+    markdox.process(file, function(err, output){
+      should.not.exist(err);
+      output.should.not.match(/nope/);
+      output.should.match(/yep/);
+      done();
+    });
+  });
+});

test/fixtures/comment-types.coffee

@@ -0,0 +1,17 @@
+###!
+ * nope
+ ###
+
+###
+ * nope
+ ###
+
+### nope ###
+
+# nope
+
+###*
+ * yep
+ ###
+
+###* yep ###

test/fixtures/comment-types.js

@@ -0,0 +1,17 @@
+/*!
+ * nope
+ */
+
+/*
+ * nope
+ */
+
+/* nope */
+
+// nope
+
+/**
+ * yep
+ */
+
+/** yep */

test/fixtures/transformTitle.coffee

@@ -1,8 +1,8 @@
-###
+###*
  * h1 My first title
 ###
 
-###
+###*
  * This method log a given message to the console.
  *
  * h2 My second title
@@ -11,4 +11,4 @@
  * @method
 ###
 helloworld = () ->
-  console.log('hello world!');
+  console.log('hello world!');