Fix typos in docstrings and function names.

[sbcl.git] / src / pcl / gray-streams-class.lisp

diff --git a/src/pcl/gray-streams-class.lisp b/src/pcl/gray-streams-class.lisp
index 2f4e3a9..0f2f5fb 100644 (file)
--- a/src/pcl/gray-streams-class.lisp
+++ b/src/pcl/gray-streams-class.lisp
@@ -16,39 +16,61 @@
     ((open-p :initform t
              :accessor stream-open-p))
     #+sb-doc
-    (:documentation "the base class for all CLOS streams")))
+    (:documentation "Base class for all Gray streams.")))
 
 ;;; Define the stream classes.
-(defclass fundamental-input-stream (fundamental-stream) nil)
+(defclass fundamental-input-stream (fundamental-stream) nil
+  #+sb-doc
+  (:documentation "Superclass of all Gray input streams."))
 
-(defclass fundamental-output-stream (fundamental-stream) nil)
+(defclass fundamental-output-stream (fundamental-stream) nil
+  #+sb-doc
+  (:documentation "Superclass of all Gray output streams."))
 
-(defclass fundamental-character-stream (fundamental-stream) nil)
+(defclass fundamental-character-stream (fundamental-stream) nil
+  #+sb-doc
+  (:documentation
+   "Superclass of all Gray streams whose element-type is a subtype of character."))
 
-(defclass fundamental-binary-stream (fundamental-stream) nil)
+(defclass fundamental-binary-stream (fundamental-stream) nil
+  #+sb-doc
+  (:documentation "Superclass of all Gray streams whose element-type
+is a subtype of unsigned-byte or signed-byte."))
 
 (defclass fundamental-character-input-stream
-    (fundamental-input-stream fundamental-character-stream) nil)
+    (fundamental-input-stream fundamental-character-stream) nil
+  #+sb-doc
+  (:documentation "Superclass of all Gray input streams whose element-type
+is a subtype of character."))
 
 (defclass fundamental-character-output-stream
-    (fundamental-output-stream fundamental-character-stream) nil)
+    (fundamental-output-stream fundamental-character-stream) nil
+  #+sb-doc
+  (:documentation "Superclass of all Gray output streams whose element-type
+is a subtype of character."))
 
 (defclass fundamental-binary-input-stream
-    (fundamental-input-stream fundamental-binary-stream) nil)
+    (fundamental-input-stream fundamental-binary-stream) nil
+  #+sb-doc
+  (:documentation "Superclass of all Gray input streams whose element-type
+is a subtype of unsigned-byte or signed-byte."))
 
 (defclass fundamental-binary-output-stream
-    (fundamental-output-stream fundamental-binary-stream) nil)
+    (fundamental-output-stream fundamental-binary-stream) nil
+  #+sb-doc
+  (:documentation "Superclass of all Gray output streams whose element-type
+is a subtype of unsigned-byte or signed-byte."))
 \f
-#|
-This is not in the gray-stream proposal, so it is left here
-as example code.
+;;; This is not in the Gray stream proposal, so it is left here
+;;; as example code.
+;;;
 ;;; example character input and output streams
-
+#|
 (defclass character-output-stream (fundamental-character-output-stream)
   ((lisp-stream :initarg :lisp-stream
-               :accessor character-output-stream-lisp-stream)))
+                :accessor character-output-stream-lisp-stream)))
 
 (defclass character-input-stream (fundamental-character-input-stream)
   ((lisp-stream :initarg :lisp-stream
-               :accessor character-input-stream-lisp-stream)))
+                :accessor character-input-stream-lisp-stream)))
 |#