Jump to content

Brand New Phaser API Documentation in JSON format


Recommended Posts

Hi all,


I've been slowly working away on DocGen, our tool for generating the new Phaser API documentation. It was built to bridge the issues between Phaser and Pixi jsdoc format incompatibilities and to take the API docs to the next stage. Tonight I got it to a point where it's outputting everything as json data.


The json files contain every method and property for every class, including all inherited ones, properly formatted return types, inline help, line numbers and everything else you should need.


The next stage is to output them as markdown files, but I'd love if some of you can check the JSON structure and see if you can spot any mistakes or missing things. I figured having the API docs in a json format could be handy in lots of cases, especially with online game editors like MightyEditor. Plus it lets you write your own interface too, and maybe we could see a Sublime Editor code-completion plugin now  :)


You can get the JSON output from here: https://github.com/photonstorm/phaser/tree/dev/docgen/output


Please post your comments here.





Link to comment
Share on other sites

Join the conversation

You can post now and register later. If you have an account, sign in now to post with your account.
Note: Your post will require moderator approval before it will be visible.

Reply to this topic...

×   Pasted as rich text.   Paste as plain text instead

  Only 75 emoji are allowed.

×   Your link has been automatically embedded.   Display as a link instead

×   Your previous content has been restored.   Clear editor

×   You cannot paste images directly. Upload or insert images from URL.


  • Recently Browsing   0 members

    • No registered users viewing this page.
  • Create New...