comments

Documentation

Index

• func OverrideLanguageCommentStyle(languages map[string]Language)
• type CommentStyle
  • func FileCommentStyle(filename string) *CommentStyle
  • func (style *CommentStyle) Validate() error
• type Language

Functions

func OverrideLanguageCommentStyle

func OverrideLanguageCommentStyle(languages map[string]Language)

Types

type CommentStyle

type CommentStyle struct {
	ID           string `yaml:"id"`
	After        string `yaml:"after"`
	Start        string `yaml:"start"`
	Middle       string `yaml:"middle"`
	End          string `yaml:"end"`
	EnsureAfter  string `yaml:"ensure_after"`
	EnsureBefore string `yaml:"ensure_before"`
}

func FileCommentStyle

func FileCommentStyle(filename string) *CommentStyle

func (*CommentStyle) Validate

func (style *CommentStyle) Validate() error

type Language

type Language struct {
	Type           string   `yaml:"type"`
	Extensions     []string `yaml:"extensions"`
	Filenames      []string `yaml:"filenames"`
	CommentStyleID string   `yaml:"comment_style_id"`
}