doculint

Documentation

Overview

Package doculint contains the necessary logic for the doculint linter. The doculint linter ensures proper documentation on various types, functions, variables, constants, etc. in the form of comments.

Index

• Variables
• func NewAnalyzerWithOptions(_minFunLen int, ...) *analysis.Analyzer

Variables

var Analyzer = analysis.Analyzer{
	Name: name,
	Doc:  doc,
	Run:  doculint,
}

Analyzer exports the doculint analyzer (linter).

Functions

func NewAnalyzerWithOptions

func NewAnalyzerWithOptions(
	_minFunLen int, _validatePackages, _validateFunctions, _validateVariables, _validateConstants, _validateTypes bool) *analysis.Analyzer

NewAnalyzerWithOptions returns the Analyzer package-level variable, with the options that would have been defined via flags if this was ran as a vet tool. This is so the analyzers can be ran outside of the context of a vet tool and config can be gathered from elsewhere.