formula: add/improve more API docs.

Shouldn't be anything controversial here but just want to get more @Homebrew/owners :eyes: on it. We're getting there (slowly).
Yeah, just this method. The instance methods on formula and softwarespec are ok.