summaryrefslogtreecommitdiffstats
path: root/hugolib/handler_base.go
diff options
context:
space:
mode:
authorJorin Vogel <hi@jorin.me>2017-08-02 14:25:05 +0200
committerBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>2017-08-03 15:57:51 +0200
commit81c13171a985b89f2af6682dbd1d4b8766cb9af7 (patch)
treedb39d78bbe6da0ea3f3dd3d2f94c7e1571ad8fd6 /hugolib/handler_base.go
parent9891c0fb0eb274b8a95b62c40070a87a6e04088c (diff)
Add some missing doc comments
As pointed out by the linter, some exported functions and types are missing doc comments. The linter warnings have been reduced from 194 to 116. Not all missing comments have been added in this commit though.
Diffstat (limited to 'hugolib/handler_base.go')
-rw-r--r--hugolib/handler_base.go5
1 files changed, 5 insertions, 0 deletions
diff --git a/hugolib/handler_base.go b/hugolib/handler_base.go
index 99c15e15d..10698ea7a 100644
--- a/hugolib/handler_base.go
+++ b/hugolib/handler_base.go
@@ -17,6 +17,7 @@ import (
"github.com/gohugoio/hugo/source"
)
+// Handler is used for processing files of a specific type.
type Handler interface {
FileConvert(*source.File, *Site) HandledResult
PageConvert(*Page) HandledResult
@@ -24,14 +25,17 @@ type Handler interface {
Extensions() []string
}
+// Handle identifies functionality assosiated with certain file extentions.
type Handle struct {
extensions []string
}
+// Extensions returns a list of extentions.
func (h Handle) Extensions() []string {
return h.extensions
}
+// HandledResult describes the results of a file handling operation.
type HandledResult struct {
page *Page
file *source.File
@@ -55,6 +59,7 @@ func (h HandledResult) String() string {
return h.Error()
}
+// Page returns the affected page.
func (h HandledResult) Page() *Page {
return h.page
}