Blockly: generated API docs

Created on 30 Jun 2015  Â·  4Comments  Â·  Source: google/blockly

Reviewing the source code, it is well documented, however, I don't see any auto generated API docs. What is the preferred method for reviewing the API? Shouldn't a JSDoc type doc be generated along with the build? This would easily allow one to wire up the documentation to view it inline in their IDE or to review in browser etc.

Most helpful comment

All 4 comments

I agree, the available documentation is missing a lot, would be really nice to get some API docs generated with the build.

I ran JSDoc on the codebase a while back, this was the result: https://dl.dropboxusercontent.com/u/23141976/blockly-documentation/index.html

Seems like it'd be a pretty-straightforward thing to do.

Hey there!

Getting this set up is on my to-do list, but so are a lot of bugs. I'm working on figuring out where these will live. Big thanks for @acbart for his docs in the meantime.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

msprotz picture msprotz  Â·  7Comments

BeksOmega picture BeksOmega  Â·  5Comments

zhouxiaobo1990 picture zhouxiaobo1990  Â·  5Comments

rachel-fenichel picture rachel-fenichel  Â·  4Comments

moniika picture moniika  Â·  3Comments