search

ctumolosus / jsdoc-jsx

A JSDoc plugin that automatically parses JSX source files with esprima before it is processed by JSDoc.
7 stars 0 forks source link

Doesn't seem to work with jsdoc 3.40-dev #1

Closed quantizor closed 8 years ago

quantizor commented 9 years ago

So I set up my config file as you suggested:

{
    "plugins": [
        "../node_modules/jsdoc-jsx"
    ],
    "jsx": {
        "es6": true,
        "es6module": true
    }
}

My directory structure looks like this:

/
    docs/
        jsdoc.json
        api/ <- docs go here
    node_modules/
    package.json

Invocation looks like:

./node_modules/.bin/jsdoc -d docs/api -c docs/jsdoc.json

When I run jsdoc, the parsing completes as normal (no errors), but the JSX-based files aren't part of the generated bundle.

This is with jsdoc v3.4.0-dev - when you get a chance, could you let me know if I did something wrong?

JuneChiu commented 9 years ago

I got the same problem as you ...

ewaldman commented 9 years ago

Anyone have an answer how to generate documentation for js files that are using react.js? I thought I would use jsdoc-jsx, but as the previous posts explain, it doesn't work. any other ideas? Thanks

ctumolosus commented 8 years ago

This works fine for me with jsdoc@3.4.0. I have a feeling it was a problem with jsdoc itself while it was in dev.