diff options
author | Bjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com> | 2015-08-06 23:58:10 +0300 |
---|---|---|
committer | Bjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com> | 2015-08-06 23:58:10 +0300 |
commit | de7dd70bbc1ac533f137e5f788e1b337d6ba6b8c (patch) | |
tree | 9872ad066fabbe44e279b754f99f392700b3815a /helpers | |
parent | 1583d8d094f11b267ba7b9bd1ebbdfa460345beb (diff) |
Fix some Go code doc issues
Diffstat (limited to 'helpers')
-rw-r--r-- | helpers/content.go | 8 | ||||
-rw-r--r-- | helpers/content_renderer.go | 6 | ||||
-rw-r--r-- | helpers/path.go | 1 |
3 files changed, 7 insertions, 8 deletions
diff --git a/helpers/content.go b/helpers/content.go index 8e3fda505..11e2755d3 100644 --- a/helpers/content.go +++ b/helpers/content.go @@ -134,7 +134,7 @@ func BytesToHTML(b []byte) template.HTML { return template.HTML(string(b)) } -// GetHtmlRenderer creates a new Renderer with the given configuration. +// GetHTMLRenderer creates a new Blackfriday Renderer with the given configuration. func GetHTMLRenderer(defaultFlags int, ctx *RenderingContext) blackfriday.Renderer { renderParameters := blackfriday.HtmlRendererParameters{ FootnoteAnchorPrefix: viper.GetString("FootnoteAnchorPrefix"), @@ -172,12 +172,11 @@ func GetHTMLRenderer(defaultFlags int, ctx *RenderingContext) blackfriday.Render htmlFlags |= blackfriday.HTML_SMARTYPANTS_LATEX_DASHES } - return &HugoHtmlRenderer{ + return &hugoHtmlRenderer{ blackfriday.HtmlRendererWithParameters(htmlFlags, "", "", renderParameters), } } - func getMarkdownExtensions(ctx *RenderingContext) int { flags := 0 | blackfriday.EXTENSION_NO_INTRA_EMPHASIS | blackfriday.EXTENSION_TABLES | blackfriday.EXTENSION_FENCED_CODE | @@ -209,7 +208,7 @@ func markdownRenderWithTOC(ctx *RenderingContext) []byte { getMarkdownExtensions(ctx)) } -// mmark +// GetMmarkHtmlRenderer creates a new MMark Renderer with the given configuration. func GetMmarkHtmlRenderer(defaultFlags int, ctx *RenderingContext) mmark.Renderer { renderParameters := mmark.HtmlRendererParameters{ FootnoteAnchorPrefix: viper.GetString("FootnoteAnchorPrefix"), @@ -220,7 +219,6 @@ func GetMmarkHtmlRenderer(defaultFlags int, ctx *RenderingContext) mmark.Rendere if b && !ctx.getConfig().PlainIDAnchors { renderParameters.FootnoteAnchorPrefix = ctx.DocumentID + ":" + renderParameters.FootnoteAnchorPrefix - // renderParameters.HeaderIDSuffix = ":" + ctx.DocumentId } htmlFlags := defaultFlags diff --git a/helpers/content_renderer.go b/helpers/content_renderer.go index bb5b810ae..5f26963a1 100644 --- a/helpers/content_renderer.go +++ b/helpers/content_renderer.go @@ -8,12 +8,12 @@ import ( "github.com/spf13/viper" ) -// Wraps a blackfriday.Renderer, typically a blackfriday.Html -type HugoHtmlRenderer struct { +// hugoHtmlRenderer wraps a blackfriday.Renderer, typically a blackfriday.Html +type hugoHtmlRenderer struct { blackfriday.Renderer } -func (renderer *HugoHtmlRenderer) BlockCode(out *bytes.Buffer, text []byte, lang string) { +func (renderer *hugoHtmlRenderer) blockCode(out *bytes.Buffer, text []byte, lang string) { if viper.GetBool("PygmentsCodeFences") { str := html.UnescapeString(string(text)) out.WriteString(Highlight(str, lang, "")) diff --git a/helpers/path.go b/helpers/path.go index ba6d0e9d1..ce2005715 100644 --- a/helpers/path.go +++ b/helpers/path.go @@ -85,6 +85,7 @@ func MakePathToLower(s string) string { return strings.ToLower(MakePath(s)) } +// MakeTitle trims any space and replaces hypens with a single space. func MakeTitle(inpath string) string { return strings.Replace(strings.TrimSpace(inpath), "-", " ", -1) } |