Invert singleStar option to skipSingleStar; Add --skipSingleStar flag;

Author: evindor

bin/dox

@@ -16,7 +16,8 @@ program
   .option('-r, --raw', 'output "raw" comments, leaving the markdown intact')
   .option('-a, --api', 'output markdown readme documentation')
   .option('-s, --skipPrefixes [prefixes]', 'skip comments prefixed with these prefixes, separated by commas')
-  .option('-d, --debug', 'output parsed comments for debugging');
+  .option('-d, --debug', 'output parsed comments for debugging')
+  .option('-S, --skipSingleStar', 'set to false to ignore `/* ... */` comments');
 
 // examples
 
@@ -41,7 +42,7 @@ var buf = '';
 process.stdin.setEncoding('utf8');
 process.stdin.on('data', function(chunk){ buf += chunk; });
 process.stdin.on('end', function(){
-  var obj = dox.parseComments(buf, { raw: program.raw || program.api, skipPrefixes: program.skipPrefix && program.skipPrefix.split(',') });
+  var obj = dox.parseComments(buf, { raw: program.raw || program.api, skipPrefixes: program.skipPrefix && program.skipPrefix.split(','), skipSingleStar: !!program.skipSingleStar });
   if (program.debug) {
     process.stdout.write(util.inspect(obj, false, Infinity, true) + '\n');
   } else if (program.api) {

lib/dox.js

@@ -54,9 +54,7 @@ exports.parseComments = function(js, options){
 
   var comments = []
     , raw = options.raw
-    , singleStar = options.singleStar === undefined
-                 ? true
-                 : options.singleStar
+    , skipSingleStar = options.skipSingleStar
     , comment
     , buf = ''
     , ignore
@@ -73,7 +71,7 @@ exports.parseComments = function(js, options){
   for (var i = 0, len = js.length; i < len; ++i) {
     // start comment
     if (!withinMultiline && !withinSingle && !withinString &&
-        '/' == js[i] && '*' == js[i+1] && (singleStar || js[i+2] == '*')) {
+        '/' == js[i] && '*' == js[i+1] && (!skipSingleStar || js[i+2] == '*')) {
       lineNumStarting = lineNum;
       // code following previous comment
       if (buf.trim().length) {

test/dox.test.js

@@ -623,9 +623,9 @@ module.exports = {
     });
   },
 
-  'test .parseComments() on single star comments with singleStar=false': function (done) {
+  'test .parseComments() on single star comments with skipSingleStar=true': function (done) {
     fixture('single.js', function(err, str){
-      var comments = dox.parseComments(str, { singleStar: false });
+      var comments = dox.parseComments(str, { skipSingleStar: true });
 
       comments.should.have.lengthOf(1);
       comments[0].tags.should.be.empty;