Component documentation #13

Closed
rybesh opened this Issue Mar 28, 2012 · 4 comments

2 participants

@rybesh

The various components could really use some documentation. This is something I am willing to help with; but I would like your input on how you think documentation should be handled. Generated using docco, perhaps?

@bergie
NoFlo member

Docco-Husky is something we already have a Cake task for. Just run:

$ cake doc

And it will regenerate the documentation. But indeed, the component docs need to be written!

@rybesh

I don't see a doc task in the Cakefile.

@bergie bergie added a commit that referenced this issue Apr 3, 2012
@bergie bergie Initial API docs, refs #13 fc97d45
@bergie
NoFlo member

Generated documentation can now be found from http://noflojs.org/docs/

@rybesh

Sweet. They look great!

@rybesh rybesh closed this Apr 3, 2012
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment