markup

type Arguments struct {
	// Map where keys are arguments and values are definitions
	Args map[string]string
}

type CodeBlock struct {
	// Programming language
	Lang string

	// Code
	Snippet string
}

type Comment struct {
	// Name of the comment paragraph, like "Example" in `Example`
	Name string

	// Optional description of the <`Name`> comment
	Description Option[string]

	// Code of the <`Name`> comment
	Code CodeBlock
}

type Document struct {
	// File content
	Content string

	// Map of `DocumentationBlock`s
	Blocks map[string]DocumentationBlock
}

type DocumentationBlock struct {
	HashKey     string
	Status      FeatureStatus
	Code        CodeBlock
	Description Option[string]
	Arguments   Arguments
	Examples    []Example
	Comments    []Comment
}

type Example struct {
	// Optional descripton of the example
	Description Option[string]

	// Code of the example
	Code CodeBlock
}

type FeatureStatus string