funcmaps

func FormatMarkdown ¶

func FormatMarkdown(in string, object any) string

FormatMarkdown carries out a formatting of inline markdown in comments that handles:

1. Reference-style markdown links: [text]: url
2. Godoc-style links: errors.Is, testing.T, etc.
3. Rearrange godoc sections so we extract Usage and Examples. Examples are matched with the generated testable examples and reinjected as go code in the "Testable Examples" tab.

func FuncMap ¶

func FuncMap() template.FuncMap

FuncMap returns the complete template function map for code and documentation generation.

func PrintReturns ¶

func PrintReturns(vars model.Parameters) string

PrintReturns print a collection of model.Parameters as values returned by a function.

func Titleize ¶

func Titleize(in string) string

Titleize transform a string into a title, upper-casing the first letter.