X-Git-Url: https://code.consxy.com/gitweb/gitweb.cgi?p=sheep;a=blobdiff_plain;f=src%2Fmain%2Fpackage.lisp;h=c834cbd649ba4e03ce7b05e665edb85fd18be7a6;hp=3012351c0131fb2c702a06e941687b0719d57925;hb=0.2;hpb=683928f90e320bed84a816e8b59521b1c6714991 diff --git a/src/main/package.lisp b/src/main/package.lisp index 3012351..c834cbd 100644 --- a/src/main/package.lisp +++ b/src/main/package.lisp @@ -1,8 +1,19 @@ (defpackage #:docgen (:use :cl) - (:export #:validate-package #:export-package #:validation-failure)) + (: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-var (:use :cl) + (: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 #:ast->link #:ast->short-name #:ast->short-desc #:ast->category-name))