bashdoc

README

bashdoc

API Doc Generator for Bash Libraries

Documentation

Index

• func LoadLinesWithCode(reader io.Reader) ([]syntax.Pos, error)
• func SortedFunctions(functions []Function)
• type Comment
• type CommentsByLine
  • func LoadCommentsFromSource(reader io.Reader) (*CommentsByLine, error)
  • func (c *CommentsByLine) LinesWithComments() []uint
• type Function
  • func LoadFunctionsFromSource(reader io.Reader) ([]Function, error)
  • func (f *Function) IsWithinDeclaration(pos syntax.Pos) bool

Functions

func LoadLinesWithCode

func LoadLinesWithCode(reader io.Reader) ([]syntax.Pos, error)

func SortedFunctions

func SortedFunctions(functions []Function)

Types

type Comment

type Comment struct {
	syntax.Comment
}

type CommentsByLine

type CommentsByLine struct {
	Comments map[uint]Comment
}

func LoadCommentsFromSource

func LoadCommentsFromSource(reader io.Reader) (*CommentsByLine, error)

func (*CommentsByLine) LinesWithComments

func (c *CommentsByLine) LinesWithComments() []uint

type Function

type Function struct {
	Name  string
	Start syntax.Pos
	End   syntax.Pos
}

func LoadFunctionsFromSource

func LoadFunctionsFromSource(reader io.Reader) ([]Function, error)

func (*Function) IsWithinDeclaration

func (f *Function) IsWithinDeclaration(pos syntax.Pos) bool