Add YARD documentation comments

[roback]

Documented all public methods/attributes using http://yardoc.org/

Started a yard server locally by running

bundle exec yard server --reload

Todo

• Rake task for generating documentation/starting server
• Update readme
• Answer the question: "should documentation be checked in or not?"

[roback]

should documentation be checked in or not?

I have no idea, some keeps it in the repo, some don't.

Im choosing not to as it's one more thing to remember to update each time you make a change. The YARD-comments in the code is still there which should be enough.

[dentarg]

I agree, we should not have the generated documentation in the repo

[dentarg]

👍

[jage]

Great job! 👍

[walro]

I think we can "is not" over "isn't" in our documentation, wdyt?

[roback]

Yes, that looks better.

[walro]

Awesome work, left a few minor comments

[roback]

Awesome work, left a few minor comments

"a few" 😛

[walro]

:) LGTM!