check

Documentation

Overview

Package check package contains the parsing and ruling utilities to report problems.

Index

• func RunCheck(filepath string, options *types.CLIOptions) ([]types.ReportedVar, error)

Functions

func RunCheck

func RunCheck(filepath string, options *types.CLIOptions) ([]types.ReportedVar, error)

RunCheck will run checks on an input file. this will report:

uncommented and undocumented functions
missing document sections in the comment
missing arguments declaration in the comment
missing global variables declaration in the comment
missing env variables declaration in the comment
missing output explanation in the comment
warn about incomplete documentation of the previous sections.