X-Git-Url: http://repo.macrolet.net/gitweb/?a=blobdiff_plain;f=src%2Fpcl%2Fdocumentation.lisp;h=e992894e72770e39f9c927a9e83d6c5bde8e3373;hb=6848a92fd4af23d0695eeaaed9efcbdfd9e1d9e5;hp=b06a53c01ca1687158df90111917b6d95e7b625c;hpb=f181ad9ffeeadf341b6a16c3591eadf0c1e3fa61;p=sbcl.git diff --git a/src/pcl/documentation.lisp b/src/pcl/documentation.lisp index b06a53c..e992894 100644 --- a/src/pcl/documentation.lisp +++ b/src/pcl/documentation.lisp @@ -25,17 +25,25 @@ (defmethod documentation ((x function) (doc-type (eql 'function))) (fun-doc x)) -(defmethod documentation ((x list) (doc-type (eql 'function))) - (when (and (legal-fun-name-p x) (fboundp x)) - (documentation (fdefinition x) t))) - (defmethod documentation ((x list) (doc-type (eql 'compiler-macro))) (awhen (compiler-macro-function x) (documentation it t))) +(defmethod documentation ((x list) (doc-type (eql 'function))) + (when (legal-fun-name-p x) + (or (random-documentation x 'function) + (when (fboundp x) + (fun-doc (fdefinition x)))))) + (defmethod documentation ((x symbol) (doc-type (eql 'function))) - (when (fboundp x) - (documentation (symbol-function x) t))) + (when (legal-fun-name-p x) + (or (random-documentation x 'function) + ;; Nothing under the name, check the function object. + (when (fboundp x) + (fun-doc (if (special-operator-p x) + (fdefinition x) + (or (macro-function x) + (fdefinition x)))))))) (defmethod documentation ((x symbol) (doc-type (eql 'compiler-macro))) (awhen (compiler-macro-function x) @@ -54,16 +62,16 @@ (setf (fun-doc x) new-value)) (defmethod (setf documentation) (new-value (x list) (doc-type (eql 'function))) - (when (and (legal-fun-name-p x) (fboundp x)) - (setf (documentation (fdefinition x) t) new-value))) + (when (legal-fun-name-p x) + (setf (random-documentation x 'function) new-value))) (defmethod (setf documentation) (new-value (x list) (doc-type (eql 'compiler-macro))) (awhen (compiler-macro-function x) (setf (documentation it t) new-value))) (defmethod (setf documentation) (new-value (x symbol) (doc-type (eql 'function))) - (when (and (legal-fun-name-p x) (fboundp x)) - (setf (documentation (symbol-function x) t) new-value))) + (when (legal-fun-name-p x) + (setf (random-documentation x 'function) new-value))) (defmethod (setf documentation) (new-value (x symbol) (doc-type (eql 'compiler-macro))) (awhen (compiler-macro-function x) @@ -205,7 +213,7 @@ ;;; default if DOC-TYPE doesn't match one of the specified types (defmethod documentation (object doc-type) - (warn "unsupported DOCUMENTATION: type ~S for object ~S" + (warn "unsupported DOCUMENTATION: type ~S for object of type ~S" doc-type (type-of object)) nil) @@ -234,6 +242,22 @@ ;;; set the documentation for the machinery for setting documentation. #+sb-doc (setf (documentation 'documentation 'function) - "Return the documentation string of Doc-Type for X, or NIL if - none exists. System doc-types are VARIABLE, FUNCTION, STRUCTURE, TYPE, - SETF, and T.") + "Return the documentation string of Doc-Type for X, or NIL if none +exists. System doc-types are VARIABLE, FUNCTION, STRUCTURE, TYPE, SETF, and T. + +Function documentation is stored separately for function names and objects: +DEFUN, LAMBDA, &co create function objects with the specified documentation +strings. + + \(SETF (DOCUMENTATION NAME 'FUNCTION) STRING) + +sets the documentation string stored under the specified name, and + + \(SETF (DOCUMENTATION FUNC T) STRING) + +sets the documentation string stored in the function object. + + \(DOCUMENTATION NAME 'FUNCTION) + +returns the documentation stored under the function name if any, and +falls back on the documentation in the function object if necessary.")