search

statgen / locuszoom

A Javascript/d3 embeddable plugin for interactively visualizing statistical genetic data from customizable sources.
https://statgen.github.io/locuszoom/
MIT License
154 stars 29 forks source link

JSDoc source code documentation #110

Closed abought closed 7 years ago

abought commented 7 years ago

⛷ Please squash during merge

Purpose

Add source code docstrings in the JSDoc format. There is a lot of good information about methods in the wiki, and this PR adds those descriptions directly to the code. I am also adding extra type annotations for methods.

With future improvements, this could be used to auto-generate cross-linked HTML docs that would complement the wiki prose/tutorials.

TODO

I've been annotating code as I work through the codebase (to capture my own notes). Some of these docstrings are tentative and will be firmed up as I go along (eg public/private APIs, method types). I'll keep adding docs as time/tasks allow.

Review note

I recommend merge-and-squash for this PR; the commit history is a reflection of process rather than need for separate commits.

abought commented 7 years ago

Did a final quick pass through and merged docs as they are.

There may be improvements warranted in the future, but I've merged as is to make room for future work in other PRs before this goes stale.