docs: adding godoc package comments

[serbrech]

Reason for Change:

Add missing godoc comments on packages where missing

Issue Fixed:

fix #29

[serbrech]

FYI the generated files break the linting unfortunately :

golint $(go list ./... | grep -v /vendor/) | grep comment
/go/src/github.com/Azure/aks-engine/pkg/engine/templates_generated.go:1:1: package comment should be of the form "Package engine ..."
/go/src/github.com/Azure/aks-engine/pkg/i18n/translations_generated.go:1:1: package comment should be of the form "Package i18n ..."

[tariq1890]

Thanks @serbrech ! I've provided my comment

[tariq1890]

/lgtm

[codecov]

Codecov Report

Merging #502 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #502   +/-   ##
=======================================
  Coverage   54.35%   54.35%           
=======================================
  Files          96       96           
  Lines       14552    14552           
=======================================
  Hits         7910     7910           
  Misses       5969     5969           
  Partials      673      673

[mboersma]

Does godoc pick up all these comments? I remember in 4324 I had to make the // Package comment on the first line to satisfy both godoc and our license checking script...

[tariq1890]

I believe it should not a problem. Kubernetes and Prometheus open source projects follow the pattern of license header first and then the Package doc. Their godocs seem to populate as expected.

[mboersma]

I ran godoc -http=:6060 on this branch and I don't see package comments for some of those where we've put the copyright header first. cmd for example:

[mboersma]

This looks like my local problem somehow. (The doc comment rendering doesn't get updated for me even when I make local modifications.) @serbrech showed me his renders correctly and I think @tariq1890's guidance is correct.

[mboersma]

/lgtm

[acs-bot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: mboersma, serbrech, tariq1890

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

• OWNERS [mboersma,tariq1890]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment