diff options
author | Jorin Vogel <hi@jorin.me> | 2017-08-02 14:25:05 +0200 |
---|---|---|
committer | Bjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com> | 2017-08-03 15:57:51 +0200 |
commit | 81c13171a985b89f2af6682dbd1d4b8766cb9af7 (patch) | |
tree | db39d78bbe6da0ea3f3dd3d2f94c7e1571ad8fd6 /helpers/content.go | |
parent | 9891c0fb0eb274b8a95b62c40070a87a6e04088c (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 'helpers/content.go')
-rw-r--r-- | helpers/content.go | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/helpers/content.go b/helpers/content.go index 4c053a84d..3c81fcd31 100644 --- a/helpers/content.go +++ b/helpers/content.go @@ -42,6 +42,7 @@ var SummaryLength = 70 // SummaryDivider denotes where content summarization should end. The default is "<!--more-->". var SummaryDivider = []byte("<!--more-->") +// ContentSpec provides functionality to render markdown content. type ContentSpec struct { blackfriday map[string]interface{} footnoteAnchorPrefix string @@ -50,6 +51,8 @@ type ContentSpec struct { cfg config.Provider } +// NewContentSpec returns a ContentSpec initialized +// with the appropriate fields from the given config.Provider. func NewContentSpec(cfg config.Provider) *ContentSpec { return &ContentSpec{ blackfriday: cfg.GetStringMap("blackfriday"), |