comparison implementations/midi/classes.lisp @ 134:5e362d998f29

More documentation

darcs-hash:20070828101524-f76cc-6add2c3c254befc3cf767ac69706865b7830bc6a.gz

 (cl:in-package #:amuse-midi) 
 
-(defclass midi-object (amuse:amuse-object) ())
+(defclass midi-object (amuse:amuse-object) ()
+  (:documentation "MIDI base class"))
 
 (defclass midi-composition (amuse:composition midi-object)
   ((time-signatures :initarg :time-signatures
 		    :initform 'nil
 		    :accessor %midi-time-signatures)

    (key-signatures  :initarg :key-signatures
 		    :initform 'nil
 		    :accessor %midi-key-signatures)
    (misc-controllers :initarg :controllers
 		      :initform 'nil
-		      :accessor %midi-misc-controllers)))
+		      :accessor %midi-misc-controllers))
+  (:documentation "Class for midi compositions, with time
+  signatures, tempi, key signatures and other controllers as
+  lists in slots"))
 
 (defclass midi-message (midi-object) ;?
   ((channel :accessor %midi-message-channel :initarg :channel)
    (track :accessor %midi-message-track :initarg :track)))
 
 (defclass midi-pitched-event (chromatic-pitched-event midi-message)
   ((velocity :initarg :velocity
 	     :accessor %midi-pitched-event-velocity)
    (patch :initarg :patch
-	  :accessor %midi-pitched-event-patch)))
+	  :accessor %midi-pitched-event-patch))
+  (:documentation "Adds MIDI information to chromatic-pitched-event"))
 
 (defclass midi-percussive-event (percussive-event midi-message)
   ((velocity :initarg :velocity
 	     :accessor %midi-percussive-event-velocity)
    (patch :initarg :patch
 	  :accessor %midi-percussive-event-patch)
    (sound :initarg :sound
-	  :accessor %midi-percussive-event-sound)))
+	  :accessor %midi-percussive-event-sound))
+  (:documentation "Adds MIDI information to percussive-event"))