Regular block comments (instead of javadoc-style /**) work, but /* shows up in the documentation

[hazeledmands]

If your javascript looks like this:

/*
Does a thing
*/
MyLibrary.prototype.thing = function() {
  return console.log("Thing done!");
};

(Note the single asterisk after the slash, instead of two.) Then you end up with documentation that looks like this:

With the uncomfortable /* in there.

This is perhaps only an issue because ### block comments in CoffeeScript become /*-style JavaScript block comments.

[hazeledmands]

This could be fixed by modifying doctrine. I've submitted a pull request to that project: Constellation/doctrine#14.

But maybe we would rather ignore regular block comments and only parse the jsdoc ones?

[dtao]

So, looks like your change got merged into doctrine—nice! I took another look and, strangely, couldn't figure out why I had ever wrapped comments in /* and */ in the first place. Doctrine seems to parse without them just fine (and looking at your PR, it's easy to see why: it was just stripping them out anyway). So I took out that logic and the problem seems to have gone away.

[hazeledmands]

Yay, right on! :D