Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Parser compiles wrong comments #45

Open
nikola-kanacki opened this issue Oct 12, 2015 · 1 comment
Open

Parser compiles wrong comments #45

nikola-kanacki opened this issue Oct 12, 2015 · 1 comment

Comments

@nikola-kanacki
Copy link

JSDocs, by default, should ignore: /* ... */, /*** ... */, etc. and parse only explicit /** ... */ ( two asterisks ).

Here, however, the parser is not ignoring those invalid JSDocs comments. As a result, ugly files are outputted.

@Lokua
Copy link

Lokua commented Dec 30, 2015

This is because skipSingleStar:true is not being passed to options.dox (source). Fortunately you can add the option using markdox programmatically:

const markdox = require('markdox')

const options = {
  output: 'output.md',
  dox: {
    raw: true,
    skipSingleStar: true
  }
}

markdox.process('input.js', options, () => console.log('done'))

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants