godox

README

GoDoX

GoDoX extracts comments from Go code based on keywords. This repository is fork of https://github.com/766b/godox but a lot of code has changed, this repository is updated and the code was adjusted for better integration with https://github.com/golangci/golangci-lint.

Installation

go get github.com/matoous/godox

Documentation

Index

• type Message
  • func Run(file *ast.File, fset *token.FileSet, keywords ...string) []Message

Types

type Message

type Message struct {
	Pos     token.Position
	Message string
}

Message contains a message and position

func Run

func Run(file *ast.File, fset *token.FileSet, keywords ...string) []Message

Run runs the godox linter on given file. Godox searches for comments starting with given keywords and reports them.