Figure out the best way to autogenerate documentation from the code.

[applmak]

There is probably some kind of standard for this.

[bmt]

FYI, this will be somewhat tricky for things like the network, game, and (future) titlecard APIs since those are generated dynamically for each module.

[applmak]

http://www.fusioncharts.com/blog/2013/12/jsdoc-vs-yuidoc-vs-doxx-vs-docco-choosing-a-javascript-documentation-generator/

[plural]

bmt, what do you mean? What is special about those APIs?

[bmt]

See: https://github.com/google/chicago-brick/blob/master/client/network/network.js#L43 https://github.com/google/chicago-brick/blob/master/client/title_card.js#L105

https://github.com/google/chicago-brick/blob/master/server/game/game.js#L193

They are all cases where there is a library that is used by the framework and exposes a subset of the functionality to a specific module since there are bits that need to be cleaned up after each module is torn down.

Not impossible to get working, but will require some refactoring for the auto-generated docs to actually see the real client APIs.

On Thu, Feb 11, 2016 at 10:30 AM plural [email protected] wrote:

bmt, what do you mean? What is special about those APIs?

— Reply to this email directly or view it on GitHub https://github.com/google/chicago-brick/issues/34#issuecomment-182944569 .