search

microsoft / tsdoc

A doc comment standard for TypeScript
https://tsdoc.org/
MIT License
4.74k stars 131 forks source link

TypeError: parse is not a function #264

Closed theADAMJR closed 3 years ago

theADAMJR commented 3 years ago 
npm i -D @microsoft/tsdoc
tsdoc -i
tsdoc

Then changing tsdoc.markdown.parser = "typescript"

Throws:

exec error: Error: Command failed: jsdoc /Users/adamj/Documents/Projects/Code/2pg-music/src/ -c C:\Users\adamj\Documents\Projects\Code\2pg-music\tsdoc.json -d /Users/adamj/Documents/Projects/Code/2pg-music/docs README.md
ERROR: Unrecognized Markdown parser "undefined". Markdown support is disabled.
C:\Users\adamj\AppData\Roaming\npm\node_modules\jsdoc\lib\jsdoc\readme.js:20
        this.html = parse(content);
                    ^

TypeError: parse is not a function

It also does not work with markdown parsers: "gfm", "flow", "typescript".

Repo: https://github.com/theADAMJR/2PG-Music

octogonz commented 3 years ago

@theADAMJR It appears that you were intending to use the TSDoc# package. Its name is similar to @microsoft/tsdoc, but they are different and unrelated projects. As far as I understood, TSDoc# was abandoned a long time ago; it hasn't been updated in 7 years.

octogonz commented 3 years ago

(I am closing this issue -- please reply or reopen if I misunderstood something. Thanks!)