Documentation
¶
Index ¶
- func Body(elements ...Documentation) *body
- func Divider() *divider
- func List(elements ...Documentation) *list
- func Ordinal(n int) string
- func Paragraph(elements ...Documentation) *paragraph
- func RenderDocumentation(d Documentation, w io.Writer)
- func Section(header string, body Documentation) *section
- func TableOfContents(names, hashes []string) *tableOfContents
- func Text(txt string) *text
- type Documentation
- type Documented
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Body ¶
func Body(elements ...Documentation) *body
func List ¶
func List(elements ...Documentation) *list
func Paragraph ¶
func Paragraph(elements ...Documentation) *paragraph
func RenderDocumentation ¶
func RenderDocumentation(d Documentation, w io.Writer)
func Section ¶
func Section(header string, body Documentation) *section
func TableOfContents ¶ added in v0.3.0
func TableOfContents(names, hashes []string) *tableOfContents
Types ¶
type Documentation ¶
type Documentation interface {
// contains filtered or unexported methods
}
type Documented ¶
type Documented interface {
Document() Documentation
}
Source Files
Click to show internal directories.
Click to hide internal directories.