adoc

Documentation

Overview

package adoc renders go/doc comemnts as asciidoc

Provides objects specifically for documentation korrel8r domain packages.

Index

• type Domain
  • func NewDomain(dir string) (*Domain, error)
  • func (p *Domain) Asciidoc(headingLevel int) string
  • func (p *Domain) Printer() *Printer
• type Printer
  • func NewPrinter(p *comment.Printer) *Printer
  • func (p *Printer) Asciidoc(d *comment.Doc) string

Types

type Domain

type Domain struct {
	*doc.Package
	// contains filtered or unexported fields
}

func NewDomain

func NewDomain(dir string) (*Domain, error)

func (*Domain) Asciidoc

func (p *Domain) Asciidoc(headingLevel int) string

Asciidoc formats the domain documentation in Asciidoc. Heading level 0 is a section heading "=".

func (*Domain) Printer

func (p *Domain) Printer() *Printer

type Printer

type Printer struct {
	*comment.Printer
	// contains filtered or unexported fields
}

Printer prints go/doc comments in asciidoc format.

Based on comment.MarkdownPrinter

func NewPrinter

func NewPrinter(p *comment.Printer) *Printer

func (*Printer) Asciidoc

func (p *Printer) Asciidoc(d *comment.Doc) string

Asciidoc returns a Asciidoc formatting of a comment.Doc object. See the comment.Printer documentation for ways to customize the Asciidoc output.