comment

Documentation

Index

• type Comment
  • func (c Comment) IsEmpty() bool
  • func (c Comment) Line() int
  • func (c Comment) Value() string
• type Parser
  • func NewParser(src []byte, filename string) (*Parser, error)
  • func (p *Parser) ParseCommentsForNode(rg hcl.Range) (startComment, leadComment Comment)

Types

type Comment

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

Comment - struct with comment value and its position on file

func (Comment) IsEmpty

func (c Comment) IsEmpty() bool

IsEmpty returns true if comment is empty, otherwise returns false

func (Comment) Line

func (c Comment) Line() int

Line returns the line comment starts

func (Comment) Value

func (c Comment) Value() string

Value returns comment value

type Parser

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

Parser represents a list of code tokens

func NewParser

func NewParser(src []byte, filename string) (*Parser, error)

NewParser parses the content of a file and return a parser with its tokens

func (*Parser) ParseCommentsForNode

func (p *Parser) ParseCommentsForNode(rg hcl.Range) (startComment, leadComment Comment)

ParseCommentsForNode returns a comment in the range given in rg, if exists