Add Licensing and Contributing

[sheep] / src / main / package.lisp

diff --git a/src/main/package.lisp b/src/main/package.lisp
index c45dd5cd186ade97fae074702cd7cbae84b93808..f058585f44f661afac5c4f08f1f1f6644d136ec7 100644 (file)
--- a/src/main/package.lisp
+++ b/src/main/package.lisp
@@ -1,2 +1,20 @@
-(defpackage #:docgen (:use :cl)
- (:export #:validate-package #:export-package))
+; Copyright 2022 Frank Duncan (frank@consxy.com) under AGPL3.  See distributed LICENSE.txt.
+(defpackage #:sheep (:use :cl)
+ (:export #:validate-package #:export-package #:validation-failure #:pretty-print-validate-packages)
+ (:documentation "Main sheep package.
+
+Use sheep to validate that documentation strings on external symbols adhere to
+a strict format and exist, so that they can be output to markdown format, while
+looking decent when used within a common lisp process."))
+
+(defpackage #:sheep-func (:use :cl)
+ (:export #:doc->ast #:ast->md #:ast->link #:ast->short-name #:ast->short-desc #:ast->category-name))
+
+(defpackage #:sheep-var (:use :cl)
+ (:export #:doc->ast #:ast->md #:ast->link #:ast->short-name #:ast->short-desc #:ast->category-name))
+
+(defpackage #:sheep-pkg (:use :cl)
+ (:export #:doc->ast #:ast->md))
+
+(defpackage #:sheep-struc (:use :cl)
+ (:export #:doc->ast #:ast->md #:ast->link #:ast->short-name #:ast->short-desc #:ast->category-name))