From: Bjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>
Date: Thu, 7 Apr 2016 14:05:23 +0000 (+0200)
Subject: huglib: Add even more missing GoDoc
X-Git-Tag: v0.16~115
X-Git-Url: http://git.maquefel.me/?a=commitdiff_plain;h=05b88887;p=brevno-suite%2Fhugo

huglib: Add even more missing GoDoc

See #2014
---

diff --git a/hugolib/hugo.go b/hugolib/hugo.go
index 0a912a7b..77bf5480 100644
--- 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 d30a9285..bb474c49 100644
--- 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 41a1676f..22dd2586 100644
--- 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")