transform: Add missing GoDoc
authorBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>
Wed, 6 Jul 2016 21:23:44 +0000 (23:23 +0200)
committerBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>
Wed, 6 Jul 2016 21:23:44 +0000 (23:23 +0200)
transform/chain.go
transform/hugogeneratorinject.go

index b566f54fa1aa6b4fd684c00b915fc090796a740a..7be38ccaa2bdc2a52b91a94b3bdaf3127eadff0c 100644 (file)
@@ -15,8 +15,9 @@ package transform
 
 import (
        "bytes"
-       bp "github.com/spf13/hugo/bufferpool"
        "io"
+
+       bp "github.com/spf13/hugo/bufferpool"
 )
 
 type trans func(rw contentTransformer)
@@ -25,10 +26,12 @@ type link trans
 
 type chain []link
 
+// NewChain creates a chained content transformer given the provided transforms.
 func NewChain(trs ...link) chain {
        return trs
 }
 
+// NewEmptyTransforms creates a new slice of transforms with a capacity of 20.
 func NewEmptyTransforms() []link {
        return make([]link, 0, 20)
 }
index fe82a2eaf92f7ed40ab32312fa0ea70cde83c888..a73227de7f8a5b0408a5e2e5bd6ded40d82672bc 100644 (file)
@@ -24,6 +24,7 @@ import (
 var metaTagsCheck = regexp.MustCompile(`(?i)<meta\s+name=['|"]?generator['|"]?`)
 var hugoGeneratorTag = fmt.Sprintf(`<meta name="generator" content="Hugo %s" />`, helpers.HugoVersion())
 
+// HugoGeneratorInject injects a meta generator tag for Hugo if none present.
 func HugoGeneratorInject(ct contentTransformer) {
        if metaTagsCheck.Match(ct.Content()) {
                ct.Write(ct.Content())