Add documentation and docgen

[wolf] / src / main / package.lisp

diff --git a/src/main/package.lisp b/src/main/package.lisp
index 31eb3e33214a4fd5f94e026cc8a6eacf5ba0412c..504f2ac29cc216cc0e7170b95eadab1106f84cee 100644 (file)
--- a/src/main/package.lisp
+++ b/src/main/package.lisp
@@ -1,2 +1,9 @@
 (defpackage #:syntax-checker (:use :cl)
- (:export #:check-file #:check-directory #:pretty-print-check-directory))
+ (:export #:check-file #:check-directory #:pretty-print-check-directory)
+ (:documentation
+  "Enforces arbitrary set of style guidelines.
+
+This package walks over common lisp code to make sure it adheres to a set
+of syntactic guidelines designed to ensure a semblance of uniformity.  No
+current one was found that could be configured to work the way this one does,
+so instead of writing a configurable tool, another unconfigurable one was born."))