Complete "tsdocs" tasks to download plugins + improve ts doc + grunt:jsdoc #1559
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
If there was a comment formatted with "//" before a member name in the d.ts file, the property name was not extracted correctly to get the comments from jsdoc
Complete the tsdocs task to download automatically the phaser-plugins and scan their comments to add them in the phaser.comments.d.ts where the plugins classes are defined.
Replace builddoc and exportdocjson grunt tasks with grunt-jsdoc. To avoid an error I added a fake comment to a @todo param in the p2.js file.
vbornand
changed the title
Update from photonstorm
photonstorm
added a commit
that referenced
this pull request
Feb 3, 2015
Complete "tsdocs" tasks to download plugins + improve ts doc + grunt:jsdoc
|
👍 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
A little fix:
-The most important part:
Complete the tsdocs task to download automatically the phaser-plugins (with gitclone) and scan their comments to add them in the phaser.comments.d.ts where the plugins classes are defined.
To have more comments from the plugins, the pull request 8 (phaserjs/phaser-ce-plugins#8) on the project phaser-plugins should be merged.
I didn't put the updates of the phaser.comments.d.ts file in this pull request. Tell me if you want I include it ,but I think it's better to refresh it periodically.
-Another import thing:
I replace builddoc and exportdocjson grunt tasks with grunt-jsdoc.
To avoid an error I added a fake comment to a @todo param in the p2.js file. I didn't find a way to configure grunt-jsdoc to ignore the warnings, and even with a look in the source code there is no option.