Mercurial > hg > amuse
changeset 147:8156c30c0c53
More docstrings
darcs-hash:20071025114102-f76cc-cc282e2eb642343ce42bfb1113ac41c7f373a4d7.gz
| author | David Lewis <d.lewis@gold.ac.uk> |
|---|---|
| date | Thu, 25 Oct 2007 12:41:02 +0100 |
| parents | a74494a94be9 |
| children | c8db9d1bd191 |
| files | base/classes.lisp |
| diffstat | 1 files changed, 17 insertions(+), 6 deletions(-) [+] |
line wrap: on
line diff
--- a/base/classes.lisp Mon Sep 24 17:04:43 2007 +0100 +++ b/base/classes.lisp Thu Oct 25 12:41:02 2007 +0100 @@ -6,7 +6,10 @@ ;; types of information-specifiers -(defclass identifier (amuse-object) ()) ;; for composition specification +(defclass identifier (amuse-object) () + (:documentation "Base class to allow specification of + composition to get. Must be subclassed.")) + (defclass moment (amuse-object) () (:documentation "Object indicating a point in time")) (defclass period (amuse-object) () @@ -163,8 +166,11 @@ ;; collections of more than one event -(defclass constituent (anchored-period) ()) -(defclass standard-constituent (constituent standard-anchored-period) ()) +(defclass constituent (anchored-period) () + (:documentation "Base class for constituents")) +(defclass standard-constituent (constituent standard-anchored-period) () + (:documentation "Base class for constituents using standard + time representation")) (defclass time-ordered-constituent (constituent list-slot-sequence) ;; this won't work if lisp implementation doesn't support extensible ;; sequences. @@ -175,8 +181,13 @@ ;; this won't work if lisp implementation doesn't support extensible ;; sequences. ()) -(defclass composition (time-ordered-constituent) ()) +(defclass composition (time-ordered-constituent) () + (:documentation "Base class for compositions")) (defclass standard-composition (composition - standard-time-ordered-constituent) ()) -(defclass monody (composition) ()) + standard-time-ordered-constituent) () + (:documentation "Base class for compositions using standard + time representation")) +(defclass monody (composition) () + (:documentation "Class for indicating suitability for analysis + requiring a monody")) (defclass standard-monody (monody standard-composition) ())