Skip to content

Correct error message from generate-info.js #3020

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

Merged
merged 2 commits into from
Dec 12, 2014
Merged

Correct error message from generate-info.js #3020

merged 2 commits into from
Dec 12, 2014

Conversation

tschaub
Copy link
Member

@tschaub tschaub commented Dec 8, 2014

This provides a better error message if there is a failure walking the externs dir.

@ahocevar I came across this minor issue when looking into reworking this task for Windows support. Curious why externs/geojson.js gets special treatment here. Would things work if we treated all externs/*.js equally (meaning we pass all to the jsdoc task if any are newer than the info.json file)?

@ahocevar
Copy link
Member

This change looks good, please merge.

The reason why externs/geojson.js gets special treatment is because it is the only extern that provides types that we expose to the API. I restricted jsdoc generation for externs to olx.js and geojson.js because externs/webgl-debug.js has annotations that cause the jsdoc task to fail, like this one here:

ERROR: The @description tag requires a value. File: webgl-debug.js, line: 31

If the whole externs directory is included, these annotations need to be fixed first. The resulting externs file would be the same, so it might make sense to go down that route, resulting in a more straightforward generate-info task. The only downside is that whenever we add externs, we'll have to make sure that all jsdoc annotations are valid.

tschaub added a commit that referenced this pull request Dec 12, 2014
Correct error message from generate-info.js.
@tschaub tschaub merged commit 7fd0178 into openlayers:master Dec 12, 2014
@tschaub tschaub deleted the err-message branch December 12, 2014 20:06
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

Successfully merging this pull request may close these issues.

2 participants