Roxygen Documentation Clean Up

[dblodgett-usgs]

User story

As a developer, I'd like a more consolidated and less repetitive Roxygen annotation set.

Preferred solution

I've been looking at some other packages, e.g. https://docs.ropensci.org/crul/reference/HttpClient.html, and like how there is a lot of boilerplate documentation at the top that is reused for parameters below and gives the overall class a richness of documentation.

I'd like to suggest that we consolidate all the class documentation into a more significant header section and only put specifics in the body of the class when we are overriding the default parameter definitions.

Another nice to have would be to make a reference page that provides some architectural hits as to how stores relate to groups, arrays, and attributes. How these different classes interrelate is a little confounding at first and some high level architectural documentation at the reference index level of documentation could be really helpful.