From 81c13171a985b89f2af6682dbd1d4b8766cb9af7 Mon Sep 17 00:00:00 2001
From: Jorin Vogel <hi@jorin.me>
Date: Wed, 2 Aug 2017 14:25:05 +0200
Subject: 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.
---
 source/file.go     | 2 ++
 source/inmemory.go | 2 ++
 2 files changed, 4 insertions(+)

(limited to 'source')

diff --git a/source/file.go b/source/file.go
index e2322bc4c..cbd83d17b 100644
--- a/source/file.go
+++ b/source/file.go
@@ -24,6 +24,7 @@ import (
 	"github.com/gohugoio/hugo/helpers"
 )
 
+// SourceSpec abstracts language-specific file creation.
 type SourceSpec struct {
 	Cfg config.Provider
 	Fs  *hugofs.Fs
@@ -32,6 +33,7 @@ type SourceSpec struct {
 	defaultContentLanguage string
 }
 
+// NewSourceSpec initializes SourceSpec using languages from a given configuration.
 func NewSourceSpec(cfg config.Provider, fs *hugofs.Fs) SourceSpec {
 	defaultLang := cfg.GetString("defaultContentLanguage")
 	languages := cfg.GetStringMap("languages")
diff --git a/source/inmemory.go b/source/inmemory.go
index 431236a56..387bde3b8 100644
--- a/source/inmemory.go
+++ b/source/inmemory.go
@@ -13,6 +13,8 @@
 
 package source
 
+// ByteSource represents a source's name and content.
+// It's currently only used for testing purposes.
 type ByteSource struct {
 	Name    string
 	Content []byte
-- 
cgit v1.2.3