markdox

markdox copied to clipboard

Bumps [ejs](https://github.com/mde/ejs) from 1.0.0 to 2.7.1. Release notes *Sourced from [ejs's releases](https://github.com/mde/ejs/releases).* > ## v2.6.2 > * Correctly pass custom escape function to includes ([@​alecgibson](https://github.com/alecgibson)) > * Fixes for rmWhitespace...

dependabot[bot]

When I run: > markdox *.js src/**/*.js -o API.md I'm now getting the error: ``` node_modules/markdox/node_modules/dox/lib/dox.js:30 js = js.replace(/\r\n/gm, '\n'); ^ TypeError: Cannot read property 'replace' of undefined at Object.exports.parseComments...

liabru

Sort Comments by Type

1

I would like to do a PR to sort the comments within a document by type, such that the constructor would be forced to the top of the document, followed...

qbradq

Complex types are not escaped

1

If I have a complex type like `Promise`, it is passed verbatim to the Markdown layer as `**Promise.**` - this will be interpreted as an HTML tag ``, and won't...

wms

Parser compiles wrong comments

1

JSDocs, by default, should ignore: `/* ... */`, `/*** ... */`, etc. and parse only explicit `/** ... */` ( two asterisks ). Here, however, the parser is not ignoring...

nikola-kanacki

/* in code string being interpreted as comment for markdox

6

While making documentation for my gulpfile.js, the following code... ``` gulp.task('scripts', function() { gulp.src(root.src+dir.scripts+'**/*.js') .pipe(plugins.jslint({ undef: true, unused: true })) .pipe(plugins.browserify({ debug: true })) .pipe(gulp.dest(root.dest+dir.scripts)); }); ``` Gets parsed by...

hergaiety

method names with multiple underscore

2

I have a method that is called list_all_request but the _ in the method name are not escaped. Could you add that?

whoisstan

One can declare multiple `@see` annotations for an entity. This should be respected.

oliversalzburg

Comments (//) in single quotes break markdox

3

Hi cbou, please have a look at the following gist: https://gist.github.com/01Track1mp3/2155ba1df29e32a57034 TestBreaks.js does not compile correctly. I think markdox interprets something wrong with comments and single quotes. Please have a...

mischkew

Single and Double Quotes in code blocks get escaped

1

When I have the following code block: ``` javascript var pipe = new EventPipe(document, 'keydown', function(evt) { pipe.send(evt); }); ``` Markdox produces markdown with the single quotes changed to `'`...

joubertnel