Add package documentation

[sheep] / src / main / docgen.lisp

diff --git a/src/main/docgen.lisp b/src/main/docgen.lisp
index 7142dfe4f6d6d65444fdacedb4c2ac57fd966675..bb1b7a9af5db6b5eeec33ac7e22971eb7c06a22c 100644 (file)
--- a/src/main/docgen.lisp
+++ b/src/main/docgen.lisp
@@ -1,5 +1,29 @@
 (in-package #:docgen)
 
-(defun validate-package (package))
+(define-condition validation-failure nil ((msg :initarg :msg :reader validation-failure-msg)))
 
-(defun export-package (package))
+(defun validate-package (pkg)
+ (macrolet
+  ((with-success-check (&rest f)
+    `(handler-case
+      (progn ,@f :success)
+      (validation-failure (v) (list :failure :msg (validation-failure-msg v))))))
+  (let
+   ((symbs nil))
+   (do-external-symbols (symb pkg) (push symb symbs))
+   (setf symbs (sort symbs #'string< :key #'symbol-name))
+   (remove :success
+    (append
+     (list (with-success-check (docgen-pkg:doc->ast pkg)))
+     (mapcar
+      (lambda (symb) (with-success-check (docgen-func:doc->ast symb)))
+      symbs))))))
+
+(defun export-package (pkg)
+ (let
+  ((symbs nil))
+  (do-external-symbols (symb pkg) (push symb symbs))
+  (setf symbs (sort symbs #'string< :key #'symbol-name))
+  (with-output-to-string (str)
+   (format str "~A~%~%" (docgen-pkg:ast->md (docgen-pkg:doc->ast (find-package pkg))))
+   (format str "~{~A~^~%~}" (mapcar (lambda (symb) (docgen-func:ast->md (docgen-func:doc->ast symb))) symbs)))))