huglib: Add even more missing GoDoc

See #2014

diff --git a/hugolib/hugo.go b/hugolib/hugo.go
index 0a912a7b460819a59c6091d8a7319323899b1e7a..77bf54802d74e59923e754aada888a10611b4184 100644 (file)
--- a/hugolib/hugo.go
+++ b/hugolib/hugo.go
@@ -15,13 +15,18 @@ package hugolib
 
 import (
        "fmt"
-       "github.com/spf13/hugo/helpers"
        "html/template"
+
+       "github.com/spf13/hugo/helpers"
 )
 
 var (
+       // CommitHash contains the current Git revision. Use make to build to make
+       // sure this gets set.
        CommitHash string
-       BuildDate  string
+
+       // BuildDate contains the date of the current build.
+       BuildDate string
 )
 
 var hugoInfo *HugoInfo

diff --git a/hugolib/pagesPrevNext.go b/hugolib/pagesPrevNext.go
index d30a928573fef3e2e904a776d4c95ea04ec337c6..bb474c499020ccf21bbed0aee7e8557ce0e07d3d 100644 (file)
--- a/hugolib/pagesPrevNext.go
+++ b/hugolib/pagesPrevNext.go
@@ -13,6 +13,7 @@
 
 package hugolib
 
+// Prev returns the previous page reletive to the given page.
 func (p Pages) Prev(cur *Page) *Page {
        for x, c := range p {
                if c.UniqueID() == cur.UniqueID() {
@@ -25,6 +26,7 @@ func (p Pages) Prev(cur *Page) *Page {
        return nil
 }
 
+// Next returns the next page reletive to the given page.
 func (p Pages) Next(cur *Page) *Page {
        for x, c := range p {
                if c.UniqueID() == cur.UniqueID() {

diff --git a/hugolib/planner.go b/hugolib/planner.go
index 41a1676f6aa05988ea4d73a6a1e0ef65cd57229a..22dd2586b97e7acadc56729ee578f5515040cd0e 100644 (file)
--- a/hugolib/planner.go
+++ b/hugolib/planner.go
@@ -18,6 +18,8 @@ import (
        "io"
 )
 
+// ShowPlan prints a build plan to the given Writer.
+// Useful for debugging.
 func (s *Site) ShowPlan(out io.Writer) (err error) {
        if s.Source == nil || len(s.Source.Files()) <= 0 {
                fmt.Fprintf(out, "No source files provided.\n")