Document all classes

[tmtmtmtm]

Problem

We now have documentation automatically being published at http://www.rubydoc.info/github/everypolitician/viewer-sinatra/ — but lots of things aren't documented yet:

Files:          13
Modules:         7 (    7 undocumented)
Classes:        21 (   19 undocumented)
Constants:       2 (    2 undocumented)
Attributes:     14 (    0 undocumented)
Methods:        70 (   52 undocumented)
 29.82% documented

Proposed Solution

Document everything!

Acceptance Criteria

yard doc reports 0 things as undocumented.

• Modules
• Classes
• Constants
• Attributes
• Methods

At a minimum, we should have a one-line description of each thing, and each public method should document its @params and @return.

Not Required

We don't need absolutely perfect documentation everywhere yet, or to deeply investigate all the fancy options that yard gives us. Better documentation is an ongoing process — this is just to get us to an acceptable baseline.

Prerequisites

• First steps towards documentation #15262

Related Issues

#15306