source

Documentation

Index

• Constants
• func Extensions() (list []string)
• type Opts
• type Source
  • func New(filename string, opts Opts) (s Source, err error)

Constants

const (
	SDID         = `\d+`
	SDIgnore     = "ignore"
	SDOmitNotice = "omit-notice"
)

source directives (SD)

Functions

func Extensions

func Extensions() (list []string)

Types

type Opts

type Opts struct {
	DoxNoticeFileUrl string
	StripComments    bool
	TrimSpace        bool
}

type Source

type Source interface {
	Extensions() []string
	File() string
	ID() string
	Ignore() bool
	IsRootPage() bool
	Matches(string) bool
	Output() string
	SetID(string) error
	Title() string
	// contains filtered or unexported methods
}

func New

func New(filename string, opts Opts) (s Source, err error)