doc

Documentation

Index

• type Doc
  • func NewDoc() *Doc
  • func (d *Doc) AddAnchor(name string)
  • func (d *Doc) PopFold()
  • func (d *Doc) PopHighlight()
  • func (d *Doc) PopLink()
  • func (d *Doc) PushFold()
  • func (d *Doc) PushHighlight(group string)
  • func (d *Doc) PushLink(path string, line, column int)
  • func (d *Doc) PushLinkAnchor(path string, anchor string)
  • func (d *Doc) Write(p []byte) (int, error)
  • func (d *Doc) WriteLink(text string, path string, line, column int)
  • func (d *Doc) WriteLinkAnchor(text string, path, anchor string)
  • func (d *Doc) WriteString(s string) (int, error)
• type Manager
  • func NewManager(a *app.App) *Manager
  • func (m *Manager) Display(d *Doc, buf nvim.Buffer) error

Types

type Doc

type Doc struct {
	// contains filtered or unexported fields
}

Doc holds state used to create a documentation page.

func NewDoc

func NewDoc() *Doc

func (*Doc) AddAnchor

func (d *Doc) AddAnchor(name string)

func (*Doc) PopFold

func (d *Doc) PopFold()

func (*Doc) PopHighlight

func (d *Doc) PopHighlight()

func (*Doc) PopLink

func (d *Doc) PopLink()

func (*Doc) PushFold

func (d *Doc) PushFold()

func (*Doc) PushHighlight

func (d *Doc) PushHighlight(group string)

func (*Doc) PushLink

func (d *Doc) PushLink(path string, line, column int)

func (*Doc) PushLinkAnchor

func (d *Doc) PushLinkAnchor(path string, anchor string)

func (*Doc) Write

func (d *Doc) Write(p []byte) (int, error)

func (*Doc) WriteLink

func (d *Doc) WriteLink(text string, path string, line, column int)

func (*Doc) WriteLinkAnchor

func (d *Doc) WriteLinkAnchor(text string, path, anchor string)

func (*Doc) WriteString

func (d *Doc) WriteString(s string) (int, error)

type Manager

type Manager struct {
	// contains filtered or unexported fields
}

func NewManager

func NewManager(a *app.App) *Manager

func (*Manager) Display

func (m *Manager) Display(d *Doc, buf nvim.Buffer) error