We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
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
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.
The text was updated successfully, but these errors were encountered:
This is because skipSingleStar:true is not being passed to options.dox (source). Fortunately you can add the option using markdox programmatically:
skipSingleStar:true
options.dox
const markdox = require('markdox') const options = { output: 'output.md', dox: { raw: true, skipSingleStar: true } } markdox.process('input.js', options, () => console.log('done'))
Sorry, something went wrong.
No branches or pull requests
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.
The text was updated successfully, but these errors were encountered: