Document code

[pjotrp]

At this point it is not too clear (to a newcomer) how the framework operates. I suggest to add a doment in ./doc/design.md which describes how interaction between components is achieved and what you would need to do to add another interactive component.

In the code itself we should put a short description above every function - unless it is totally self-explanatory. For example, in dataframe.js it should state what a dataframe is, what it does and how it interacts, so that people can understand the code beneath without going into detail.

If we document this project well, the chance is higher that other people will start using and contributing to the source base.

[domitry]

I try to add document about design, but I am going to change API from now, so before finishing gsoc term, sciruby blog will be useful instead of document. Thank you.

The progress of documented code: ./src/view

• [x] pane.js

./src/view/diagrams

• [x] bar.js
• [x] box.js
• [x] scatter.js
• [x] venn.js
• [x] line.js
• [x] histogram.js
• [x] diagrams.js
• [x] heatmap.js
• [x] multiple_venn.js
• [x] vectors.js

./src/view/components

• [x] axis.js
• [x] filter.js
• [x] legend_area.js
• [x] simple_legend.js
• [x] scale.js
• [x] tooltip.js
• [x] color_bar.js

./src/core/

• [x] extension.js
• [x] manager.js
• [x] parse.js

./src/utils

• [x] dataframe.js
• [x] simplex.js
• [x] color.js
• [x] ua_info.js

[domitry]

Finished writing comments for documentation :)