Fix typos in docstrings and function names.
[sbcl.git] / src / pcl / gray-streams-class.lisp
index 58301b5..0f2f5fb 100644 (file)
@@ -9,44 +9,68 @@
 ;;;; warranty. See the COPYING and CREDITS files for more information.
 
 (in-package "SB-GRAY")
-
-(sb-int:file-comment
-  "$Header$")
 \f
 ;;; Bootstrap the FUNDAMENTAL-STREAM class.
 (let ((sb-pcl::*pcl-class-boot* 'fundamental-stream))
   (defclass fundamental-stream (standard-object stream)
-    ()
+    ((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.
+;;;
 ;;; 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)))
+|#