[mcclim-cvs] CVS mcclim/Drei

[thenriksen]

Update of /project/mcclim/cvsroot/mcclim/Drei
In directory clnet:/tmp/cvs-serv31563/Drei

Modified Files:
	drei.lisp packages.lisp syntax.lisp views.lisp 
Log Message:
Updated Drei documentation. Should now build, at least.


--- /project/mcclim/cvsroot/mcclim/Drei/drei.lisp	2008/01/11 02:44:13	1.25
+++ /project/mcclim/cvsroot/mcclim/Drei/drei.lisp	2008/01/13 10:33:09	1.26
@@ -345,7 +345,12 @@
 
 ;; Main redisplay entry point.
 (defgeneric display-drei (drei)
-  (:documentation "Display the given Drei instance."))
+  (:documentation "`Drei' must be an object of type `drei' and
+`frame' must be a CLIM frame containing the editor pane of
+`drei'. If you define a new subclass of `drei', you must define a
+method for this generic function. In most cases, methods defined
+on this function will merely be a trampoline to a function
+specific to the given Drei variant."))
 
 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 ;;;
--- /project/mcclim/cvsroot/mcclim/Drei/packages.lisp	2008/01/10 11:17:00	1.39
+++ /project/mcclim/cvsroot/mcclim/Drei/packages.lisp	2008/01/13 10:33:09	1.40
@@ -145,7 +145,7 @@
 
 (defpackage :drei-syntax
   (:use :clim-lisp :clim :drei-buffer :drei-base :flexichain :esa-utils)
-  (:export #:syntax #:syntax-command-tables #:update-parse #:syntaxp
+  (:export #:syntax #:syntax-command-tables #:updater-fns #:update-parse #:syntaxp
            #:define-syntax #:*default-syntax*
            #:syntax-command-table #:additional-command-tables #:define-syntax-command-table
            #:eval-option
--- /project/mcclim/cvsroot/mcclim/Drei/syntax.lisp	2008/01/13 10:32:11	1.13
+++ /project/mcclim/cvsroot/mcclim/Drei/syntax.lisp	2008/01/13 10:33:10	1.14
@@ -29,7 +29,14 @@
                    :reader command-table)
    (%updater-fns :initarg :updater-fns
                  :initform '()
-                 :accessor updater-fns))
+                 :accessor updater-fns
+                 :documentation "A list of functions that are
+called whenever a syntax function needs up-to-date syntax
+information. `Update-syntax' is never called directly by syntax
+commands. Each function should take two arguments, integer
+offsets into the buffer of the syntax delimiting the region that
+must have an up-to-date parse. These arguments should be passed
+on to a call to `update-syntax'."))
   (:metaclass modual-class)
   (:documentation "The base class for all syntaxes."))
 
--- /project/mcclim/cvsroot/mcclim/Drei/views.lisp	2008/01/11 02:44:13	1.17
+++ /project/mcclim/cvsroot/mcclim/Drei/views.lisp	2008/01/13 10:33:10	1.18
@@ -502,7 +502,9 @@
             :initform (make-instance 'drei-buffer)
             :initarg :buffer
             :type drei-buffer
-            :accessor buffer)
+            :accessor buffer
+            :documentation "The buffer that is observed by this
+buffer view.")
    (%top :accessor top
          :documentation "The top of the displayed buffer, that
 is, the mark indicating the first visible object in the buffer.")
@@ -533,7 +535,9 @@
 is, used for display right now."))
   (:metaclass modual-class)
   (:documentation "A view that contains a `drei-buffer'
-object."))
+object. The buffer is displayed on a simple line-by-line basis,
+with top and bot marks delimiting the visible region. These marks
+are automatically set if applicable."))
 
 (defmethod initialize-instance :after ((view drei-buffer-view) &rest initargs)
   (declare (ignore initargs))
@@ -566,7 +570,9 @@
         (invalidate-line-strokes line :modified t)))))
 
 (defclass drei-syntax-view (drei-buffer-view)
-  ((%syntax :accessor syntax)
+  ((%syntax :accessor syntax
+            :documentation "An instance of the syntax class used
+for this syntax view.")
    (%prefix-size :accessor prefix-size
                  :initform 0
                  :documentation "The number of unchanged objects
@@ -763,7 +769,11 @@
    (%dabbrev-expansion-mark :initform nil :accessor dabbrev-expansion-mark)
    (%overwrite-mode :initform nil :accessor overwrite-mode))
   (:metaclass modual-class)
-  (:default-initargs :use-editor-commands t))
+  (:default-initargs :use-editor-commands t)
+  (:documentation "The \"default\" Drei view class. It displays a
+textual representation of the buffer, possibly with syntax
+highlighting, and maintains point and mark marks into the buffer,
+in order to permit useful editing commands."))
 
 (defmethod create-view-cursors nconc ((output-stream extended-output-stream)
                                       (view textual-drei-syntax-view))