xerver Posted June 14, 2013 Share Posted June 14, 2013 I made this for you: https://github.com/englercj/ts-autodocs Basically I took Ezelia's script and went a little crazy with it. Basically, it will automatically generate document header stubs for all methods and members. It will mark the private stuff, the constructor, and will output correct types and return types. Unfortunately only stubs out the description area :/ I ran this script on a cloned phaser repo, like so: ./autodocs.js ../phaser/Phaser/ docs/./autodocs.js ../phaser/SpecialFX/ docs/Which generated documented files for all Typescript files in the Phaser directory, the files are attached as "docs_phaser.zip". Even files that already had documentation headers, had another put in, since I saw some of then didn't have all the info this generates. Hope this is helpful! I can simply run these in-place on the repo, and submit a PR if that would be easier for you to merge them in?docs_phaser.zip Link to comment Share on other sites More sharing options...
Ezelia Posted June 14, 2013 Share Posted June 14, 2013 @rolnaaba good job glad to see my code enhanced like this can you please put a line in your readme file with a link to this topic for original script ? I wanted to enhance it and share it on github but still didn't get time, so thank you for doing it Link to comment Share on other sites More sharing options...
rich Posted June 14, 2013 Author Share Posted June 14, 2013 This is excellent, thank you :) I look forward to running it over the 1.0 code base soon! Link to comment Share on other sites More sharing options...
kootoopas Posted July 14, 2013 Share Posted July 14, 2013 Hi guys. If you have written or plan to write the docs in markdown, daux.io is a very interesting tool to ouput them for the web. Link to comment Share on other sites More sharing options...
Recommended Posts