The checkdoc command scans Go packages for comment and documentation related issues. https://mellium.im/checkdoc/
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Sam Whited a1272c1c25
all: use Codeberg CI (Woodpecker)
4 weeks ago
.woodpecker all: use Codeberg CI (Woodpecker) 4 weeks ago
.gitignore checkdoc: new tool to check for package level docs 3 years ago
LICENSE checkdoc: new tool to check for package level docs 3 years ago
README.md all: use Codeberg CI (Woodpecker) 4 weeks ago
analyzer.go all: use Codeberg CI (Woodpecker) 4 weeks ago
go.mod all: use Codeberg CI (Woodpecker) 4 weeks ago
go.sum all: use Codeberg CI (Woodpecker) 4 weeks ago
header.go all: use Codeberg CI (Woodpecker) 4 weeks ago
main.go all: use Codeberg CI (Woodpecker) 4 weeks ago
tools.go all: use Codeberg CI (Woodpecker) 4 weeks ago

README.md

checkdoc

Issue Tracker Docs Chat License

The checkdoc command scans Go packages for comment and documentation related lints. Currently the tool checks for:

  • Packages that are missing documentation comments
  • Exported identifiers that are missing documentation comments
  • Malformed or missing canonical import comments
  • Missing file header comments

If you'd like to contribute to the project, see CONTRIBUTING.md.

License

The package may be used under the terms of the BSD 2-Clause License a copy of which may be found in the file "LICENSE".