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

Missing JAVA_HOME envvar leads to confusing message #54

Closed
makkes opened this issue Sep 18, 2013 · 1 comment
Closed

Missing JAVA_HOME envvar leads to confusing message #54

makkes opened this issue Sep 18, 2013 · 1 comment
Assignees
Milestone

Comments

@makkes
Copy link

makkes commented Sep 18, 2013

The message "JAVA_HOME is not set. Jsdoc requires Java to run." is misleading since it implies that the missing JAVA_HOME envvar will cause JSDoc to fail which is not the case if the java executable is on the PATH (or similar for Windows).

I propose a change of the message that better reflects reality:

"JAVA_HOME is not set. Jsdoc may fail if it cannot find the java executable."

Better yet, grunt-jsdoc-plugin shouldn't check for a Java installation at all since the error message printed out by jsdoc itself is pretty self-explanatory:

>> node_modules/grunt-jsdoc/node_modules/jsdoc/jsdoc: 40: node_modules/grunt-jsdoc/node_modules/jsdoc/jsdoc: java: not found

This is related to #34.

@krampstudio
Copy link
Owner

Yes, totally agree. This is a mistake to check the JAVA_HOME and it caused a lot of confusion. I'll remove it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants