md

func GenerateDocumentTemplateBase ¶

func GenerateDocumentTemplateBase(doc markup.Document) markup.Document

Function that generates marfdown documentation from base.

func GenerateEmptyDocumentTemplate ¶

func GenerateEmptyDocumentTemplate(plangs []string) markup.Document

Function that generates empty markdown documentation file template.

func GenerateMergedDocument ¶

func GenerateMergedDocument(doc_base, doc_lang markup.Document) markup.Document

Function that merges two docs into the new one

func ParseDocument ¶

func ParseDocument(content string) markup.Document

Function that parses document into `Document` struct

func ParseDocumentationBlock ¶

func ParseDocumentationBlock(data string) markup.DocumentationBlock

Function that parses a single `DocumentationBlock`

func RenderArguments ¶

func RenderArguments(b *bytes.Buffer, args Arguments)

Function that renders `Argumanets` to markdown

func RenderCodeBlock ¶

func RenderCodeBlock(b *bytes.Buffer, code_block CodeBlock)

Function that renders single `CodeBlock` to markdown

func RenderComments ¶

func RenderComments(b *bytes.Buffer, comments []Comment)

Function that renders `Comment`s block

func RenderDescription ¶

func RenderDescription(b *bytes.Buffer, description Option[string])

Function that renders single description to markdown

func RenderDocument ¶

func RenderDocument(doc Document) string

func RenderDocumentationBlock ¶

func RenderDocumentationBlock(doc_block DocumentationBlock) string

Function that renders single documentation block

func RenderExamples ¶

func RenderExamples(b *bytes.Buffer, examples []Example)

Function that renders `Exaple`s block