X-Git-Url: http://repo.macrolet.net/gitweb/?a=blobdiff_plain;f=src%2Fpcl%2Fdocumentation.lisp;h=e992894e72770e39f9c927a9e83d6c5bde8e3373;hb=a2fd28fb6d0b3d8d230a7c933db352f80891ac1c;hp=281d94e3b0a210a59a4dcb2d75b8eb5d973f0f62;hpb=c593dc26733b179db6c12c7085ed76b762ac256b;p=sbcl.git

diff --git a/src/pcl/documentation.lisp b/src/pcl/documentation.lisp
index 281d94e..e992894 100644
--- a/src/pcl/documentation.lisp
+++ b/src/pcl/documentation.lisp
@@ -9,14 +9,14 @@
 (in-package "SB-PCL")
 
 (defun fun-doc (x)
-  (etypecase x
-    (generic-function
-     (slot-value x '%documentation))
-    #+sb-eval
-    (sb-eval:interpreted-function
-     (sb-eval:interpreted-function-documentation x))
-    (function
-     (%fun-doc x))))
+  (if (typep x 'generic-function)
+      (slot-value x '%documentation)
+      (%fun-doc x)))
+
+(defun (setf fun-doc) (new-value x)
+  (if (typep x 'generic-function)
+      (setf (slot-value x '%documentation) new-value)
+      (setf (%fun-doc x) new-value)))
 
 ;;; functions, macros, and special forms
 (defmethod documentation ((x function) (doc-type (eql 't)))
@@ -25,21 +25,29 @@
 (defmethod documentation ((x function) (doc-type (eql 'function)))
   (fun-doc x))
 
-(defmethod documentation ((x list) (doc-type (eql 'function)))
-  (and (legal-fun-name-p x)
-       (fboundp x)
-       (documentation (fdefinition x) t)))
-
 (defmethod documentation ((x list) (doc-type (eql 'compiler-macro)))
-  (random-documentation x '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)))
-  (or (fdocumentation x 'function)
-      ;; Try the pcl function documentation.
-      (and (fboundp x) (documentation (fdefinition 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)))
-  (random-documentation x 'compiler-macro))
+  (awhen (compiler-macro-function x)
+    (documentation it t)))
 
 (defmethod documentation ((x symbol) (doc-type (eql 'setf)))
   (fdocumentation x 'setf))
@@ -47,42 +55,27 @@
 (defmethod documentation ((x symbol) (doc-type (eql 'optimize)))
   (random-documentation x 'optimize))
 
-(defun (setf fun-doc) (new-value x)
-  (etypecase x
-    (generic-function
-     (setf (slot-value x '%documentation) new-value))
-    #+sb-eval
-    (sb-eval:interpreted-function
-     (setf (sb-eval:interpreted-function-documentation x)
-           new-value))
-    (function
-     (setf (focumentation (%fun-name x) 'function) new-value)))
-  new-value)
-
-
 (defmethod (setf documentation) (new-value (x function) (doc-type (eql 't)))
   (setf (fun-doc x) new-value))
 
-(defmethod (setf documentation) (new-value
-                                 (x function)
-                                 (doc-type (eql 'function)))
+(defmethod (setf documentation) (new-value (x function) (doc-type (eql 'function)))
   (setf (fun-doc x) new-value))
 
 (defmethod (setf documentation) (new-value (x list) (doc-type (eql 'function)))
-  (setf (fdocumentation x 'function) 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)))
-  (setf (random-documentation x 'compiler-macro) 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)))
-  (setf (fdocumentation x 'function) new-value))
+(defmethod (setf documentation) (new-value (x symbol) (doc-type (eql 'function)))
+  (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)))
-  (setf (random-documentation x 'compiler-macro) 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)))
 
 (defmethod (setf documentation) (new-value (x symbol) (doc-type (eql 'setf)))
   (setf (fdocumentation x 'setf) new-value))
@@ -220,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)
@@ -249,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.")