X-Git-Url: http://repo.macrolet.net/gitweb/?a=blobdiff_plain;f=src%2Fpcl%2Fdocumentation.lisp;h=a382b9d2c0f171fdb01ffb69278d5c85c765a574;hb=d01d509257052e694365b76be5ab597fa06764ec;hp=7521653bd7467a7caaebb51ffb8d6c52a6f4b0f6;hpb=2e52fa0553c5a256f482ee14e30608acf55e5f48;p=sbcl.git diff --git a/src/pcl/documentation.lisp b/src/pcl/documentation.lisp index 7521653..a382b9d 100644 --- a/src/pcl/documentation.lisp +++ b/src/pcl/documentation.lisp @@ -18,6 +18,14 @@ (setf (slot-value x '%documentation) new-value) (setf (%fun-doc x) new-value))) +;;; FIXME: There's already fun-name in code/describe.lisp, but it's +;;; loaded after PCL, so it cannot be used, because we set +;;; some documentation at the end of this file. +(defun fun-name (x) + (if (typep x 'generic-function) + (sb-pcl:generic-function-name x) + (%fun-name x))) + (defun real-function-name (name) ;; Resolve the actual name of the function named by NAME ;; e.g. (setf (name-function 'x) #'car) @@ -34,10 +42,16 @@ (eq (car name) 'macro-function) (cadr name)))) (t - (sb-impl::fun-name (fdefinition name))))) + (fun-name (fdefinition name))))) + +(defun ignore-nil-doc (type) + (style-warn "Ignoring documentation of type ~a for ~a." + type nil)) (defun set-function-name-documentation (name documentation) - (cond ((not (legal-fun-name-p name)) + (cond ((not name) + (ignore-nil-doc 'function)) + ((not (legal-fun-name-p name)) nil) ((not (equal (real-function-name name) name)) (setf (random-documentation name 'function) documentation)) @@ -45,7 +59,8 @@ (setf (fun-doc (or (and (symbolp name) (macro-function name)) (fdefinition name))) - documentation)))) + documentation))) + documentation) ;;; functions, macros, and special forms (defmethod documentation ((x function) (doc-type (eql 't))) @@ -101,11 +116,19 @@ (set-function-name-documentation x new-value)) (defmethod (setf documentation) (new-value (x symbol) (doc-type (eql 'compiler-macro))) - (awhen (compiler-macro-function x) - (setf (documentation it t) new-value))) + (cond (x + (awhen (compiler-macro-function x) + (setf (documentation it t) new-value))) + (t + (ignore-nil-doc 'compiler-macro) + new-value))) (defmethod (setf documentation) (new-value (x symbol) (doc-type (eql 'setf))) - (setf (fdocumentation x 'setf) new-value)) + (cond (x + (setf (fdocumentation x 'setf) new-value)) + (t + (ignore-nil-doc 'setf) + new-value))) ;;; method combinations (defmethod documentation ((x method-combination) (doc-type (eql 't))) @@ -128,7 +151,11 @@ (defmethod (setf documentation) (new-value (x symbol) (doc-type (eql 'method-combination))) - (setf (random-documentation x 'method-combination) new-value)) + (cond (x + (setf (random-documentation x 'method-combination) new-value)) + (t + (ignore-nil-doc 'method-combination) + new-value))) ;;; methods (defmethod documentation ((x standard-method) (doc-type (eql 't))) @@ -227,7 +254,11 @@ (defmethod (setf documentation) (new-value (x symbol) (doc-type (eql 'structure))) - (setf (fdocumentation x 'structure) new-value)) + (cond (x + (setf (fdocumentation x 'structure) new-value)) + (t + (ignore-nil-doc 'structure) + new-value))) ;;; variables (defmethod documentation ((x symbol) (doc-type (eql 'variable))) @@ -236,7 +267,11 @@ (defmethod (setf documentation) (new-value (x symbol) (doc-type (eql 'variable))) - (setf (fdocumentation x 'variable) new-value)) + (cond (x + (setf (fdocumentation x 'variable) new-value)) + (t + (ignore-nil-doc 'variable) + new-value))) ;;; default if DOC-TYPE doesn't match one of the specified types (defmethod documentation (object doc-type)