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

failing to process source folders starting with underscore #308

Closed
vronk opened this issue Jan 17, 2013 · 4 comments
Closed

failing to process source folders starting with underscore #308

vronk opened this issue Jan 17, 2013 · 4 comments
Labels

Comments

@vronk
Copy link

vronk commented Jan 17, 2013

I experienced a weird(?) problem:
When any folder in the source path starts with an underscore (_), jsdoc runs without any complaints, but produces completely empty output.
removing the underscore from the name of the folder resolves the problem.

This is on a win-7 machine with jdk 1.6.0_37

@hegemonic
Copy link
Contributor

This behavior is intentional. The default configuration file is set up to exclude files and folder names that begin with an underscore.

To change the default behavior:

  1. Copy conf.json.EXAMPLE to a new file, conf.json. You can put it in the JSDoc directory or another directory. If you put it in another directory, you will need to use the -c option to tell JSDoc where to find it: jsdoc -c path/to/conf.json
  2. Open conf.json in a text editor.
  3. Find the source.excludePattern property, and change it to an empty string.

We could definitely use better docs for this, so I made a note on a related issue in the documentation project: jsdoc/jsdoc.github.io#4

Hope that helps!

@vronk
Copy link
Author

vronk commented Jan 21, 2013

oh, I see.
Thanks for the explanation.

@bobbwhy
Copy link

bobbwhy commented Feb 14, 2015

OK ... So I changed the conf.json and use -c to point to it.
I removed the underscore from source.excludePattern... and tried. It would not process the file.
I changed source.excludePattern to empty string. It would not process the file.
I put a bad character in the conf.json to verify that jsdoc was using the conf.json file i created. It threw a json error so it is the correct conf.json .. any ideas?

It still will not process that file

@bobbwhy
Copy link

bobbwhy commented Feb 14, 2015

and just like that... somehow it now works..

@jsdoc jsdoc locked and limited conversation to collaborators Feb 14, 2015
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

No branches or pull requests

3 participants