protodesc

Documentation

Index

• type Comment
  • func (c *Comment) GetDetached() []string
  • func (c *Comment) GetLeading() string
  • func (c *Comment) GetTrailing() string
  • func (c *Comment) String() string
• type Comments
  • func ParseComments(fd *descriptorpb.FileDescriptorProto) Comments

Types

type Comment

type Comment struct {
	Leading  string
	Trailing string
	Detached []string
}

Comment describes the leading, trailing, and detached comments for a proto object.

func (*Comment) GetDetached

func (c *Comment) GetDetached() []string

GetDetached returns the detached leading comments.

func (*Comment) GetLeading

func (c *Comment) GetLeading() string

GetLeading returns the leading comments.

func (*Comment) GetTrailing

func (c *Comment) GetTrailing() string

GetTrailing returns the leading comments.

func (*Comment) String

func (c *Comment) String() string

String returns the leading and trailing comments joined by 2 line breaks (`\n\n`). If either are empty, the line breaks are removed.

type Comments

type Comments map[string]*Comment

Comments is a map of source location paths to values.

func ParseComments

func ParseComments(fd *descriptorpb.FileDescriptorProto) Comments

ParseComments parses all comments within a proto file. The locations are encoded into the map by joining the paths with a "." character. E.g. `4.2.3.0`.

Leading/trailing spaces are trimmed for each comment type (leading, trailing, detached).