quickfix

README

quickfix

suppresses golint warnings by generating basic comments for functions, variables & structs

Documentation

Index

• Variables
• func FixAll()
• func GetHair(p Person) string
• func PreviewWarnings()
• type Person
  • func (p *Person) GetAge() uint
  • func (p Person) ValidateName() bool
• type Pet

Variables

var Age uint

Age defines the age var

var Color string

PetAge defines the age var

var Hair string

var Name string

var Nameickname string

Functions

func FixAll

func FixAll()

FixAll fixes all supported warnings

func GetHair

func GetHair(p Person) string

func PreviewWarnings

func PreviewWarnings()

PreviewWarnings displays all the warnings that will be fixed

Types

type Person

type Person struct {
	Name string `json:"name"`
	Age  uint   `json:"age"`
	Hair string `json:"hair"`
}

func (*Person) GetAge

func (p *Person) GetAge() uint

func (Person) ValidateName

func (p Person) ValidateName() bool

type Pet

type Pet struct {
	Nickname string `json:"nickname"`
	Color    string `json:"color"`
}