X-Git-Url: https://code.consxy.com/gitweb/gitweb.cgi?p=sheep;a=blobdiff_plain;f=src%2Fmain%2Fpackage.lisp;h=119922bc26a4f5849963add7f22d077b71fdd746;hp=00c3bb7faf1c23398001c795653870a98091018a;hb=1ba7b00;hpb=e9d1b7da236295700286b7564960d84f9c5f0dbe diff --git a/src/main/package.lisp b/src/main/package.lisp index 00c3bb7..119922b 100644 --- a/src/main/package.lisp +++ b/src/main/package.lisp @@ -1,11 +1,16 @@ (defpackage #:docgen (:use :cl) - (:export #:validate-package #:export-package #:validation-failure #:pretty-print-validate-packages)) + (:export #:validate-package #:export-package #:validation-failure #:pretty-print-validate-packages) + (:documentation "Main docgen package. + +Use docgen 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 #:docgen-func (:use :cl) - (:export #:doc->ast #:ast->md)) + (:export #:doc->ast #:ast->md #:ast->link #:ast->short-name #:ast->short-desc #:ast->category-name)) (defpackage #:docgen-pkg (:use :cl) (:export #:doc->ast #:ast->md)) (defpackage #:docgen-struc (:use :cl) - (:export #:doc->ast #:ast->md)) + (:export #:doc->ast #:ast->md #:ast->link #:ast->short-name #:ast->short-desc #:ast->category-name))