Leiningen Plugin that lints your Clojure project and checks that every public var is documented.
Add docstring-checker
to your :plugins
in your project.clj
:
:plugins [[docstring-checker "1.0.3"]]
Optionally specify which namespace regex patterns to :include
and :exclude
in your project.clj
:
:docstring-checker {:include [#"^my-project\.core"]
:exclude [#"test"
#"^my-project\.secret"]}
Then run the linter with
$ lein docstring-checker
The linter will fail if any public vars in namespaces that match the specified patterns are undocumented.
Docstring Checker has a few small Leiningen projects in the test-projects
directory that are used to make sure things are working correctly.
You can run the shell script to test them:
./run-tests.sh
These tests run on CircleCI whenever a new commit is pushed.
Copyright © 2018 Cam Saul
Distributed under the 3-Clause BSD License.
Can you improve this documentation? These fine people already did:
Cam Saül & Cam SaulEdit on GitHub
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close