Javascript documentation is generated with docco viewable online here.
The boxflow GitHub repository can be found here.
main.js : Toplevel entry point
JS classes independent of fabric.js
nodes.js : Nodes hold semantic and visual state.
graph.js : A Graph holds nodes and edges.
commlink.js : Commlink links the graph to the server.
utils.js : Simple set of utilities injected into underscore.
JS classes coupled with fabric.js
Drawing:
view.js : The View manages graphical state.
boxes.js : Boxes are the visual representation of nodes.
Interactive tools:
tools.js : Tools respond to interactive events.
connector.js : The connection tool has its own file.
1 - Clone the repository into the top-level docs directory.
bash
$ git clone https://github.com/ioam/boxflow.git docs
2 - Move into the new docs directory and checkout gh-pages.
bash
$ cd docs
$ git checkout gh-pages
3 - Generate/update the contents of the js-docs directory using:
bash
$ docco -o js-docs ../boxflow/js/*