From d7e48c7c4043b4a0a24729149dbf1e6a4e7f9c65 Mon Sep 17 00:00:00 2001
From: Gerd Heber <gheber@hdfgroup.org>
Date: Thu, 6 Aug 2015 07:04:43 -0500
Subject: [PATCH] Documentation updates.

---
 exports.lisp             | 13 ++++++++++++
 src/chain-complexes.lisp | 25 ++++++++++++++++++++--
 src/classes.lisp         | 45 ++++++++++++++++++++++++++++++++++++++--
 3 files changed, 79 insertions(+), 4 deletions(-)

diff --git a/exports.lisp b/exports.lisp
index e054606..313b2a4 100644
--- a/exports.lisp
+++ b/exports.lisp
@@ -9,7 +9,10 @@
  ALL-OBJECTS
 
  BASIS
+ BASIS1
+ BSGN
  BUILD-CHCM
+ BUILD-MRPH
 
  CAT-INIT
  CHECK-CMBN
@@ -23,11 +26,19 @@
  CMBN-PRINT
  CMBN-ZERO-P
  CMPR
+ CMPR1
 
  DFFR
+ DFFR1
+
+ EFHM
 
  F-CMPR
 
+ GRMD
+
+ IDNM
+
  HOW-MANY-OBJECTS
 
  K
@@ -40,6 +51,8 @@
  NCMBN-ADD
  NTERM-ADD
 
+ ORGN
+
  S-CMPR
 
  TERM-CMBN
diff --git a/src/chain-complexes.lisp b/src/chain-complexes.lisp
index 6934561..b11d393 100644
--- a/src/chain-complexes.lisp
+++ b/src/chain-complexes.lisp
@@ -222,8 +222,29 @@ IDNUM or NIL, if it doesn't exist."
   "--------------------------------------------------------------[function-doc]
 BUILD-CHCM
 Args: (&key cmpr basis bsgn intr-dffr strt orgn)
-Returns an instance of CHAIN-COMPLEX. Use this function instead of creating
-instances via the standard constructor MAKE-INSTANCE.
+Returns an instance of CHAIN-COMPLEX. The keyword arguments are as follows:
+
+:CMPR CMPR, the comparison function for generators
+
+:BASIS BASIS, the function defining the basis of the freee Z-modules C_p or the
+              the keyword :LOCALLY-EFFECTIVE
+
+:BSGN BSGN, a generator, the base point of the underlying set
+
+:INTR-DFFR INTR-DFFR, a Lisp function defining the differential homomorphism
+                      for each p (d_p: C_p -> C_{p-1}
+
+:STRT STRT, one of the keywords :GNRT or :CMBN, defining the mapping strategy
+            of the differential homomorphism, either by generator or by
+            combination. The default is :GNRT
+
+:ORGN ORGN, a list containing a relevant and carefully chosen comment about
+            the origin of the chain complex. This comment should be unique
+            for a Kenzo session (between calls of CAT-INIT), as it is used
+            for caching purposes.
+
+Use this function instead of creating instances via the standard constructor
+MAKE-INSTANCE.
 ------------------------------------------------------------------------------"
   (the chain-complex
        (progn
diff --git a/src/classes.lisp b/src/classes.lisp
index 803ae01..7095b91 100644
--- a/src/classes.lisp
+++ b/src/classes.lisp
@@ -186,8 +186,14 @@ Intances of this class represent chain complexes. The class has 8 slots:
    caching purposes.
 ------------------------------------------------------------------------------"))
 
+
 ;; STRT = STRaTegy
-(DEFTYPE STRT () '(member :gnrt :cmbn))
+(DEFTYPE STRT ()
+   "-----------------------------------------------------------------[type-doc]
+STRT
+A derived type, which represents the mapping strategy of morphisms.
+------------------------------------------------------------------------------"
+  '(member :gnrt :cmbn))
 
 
 (DEFCLASS MORPHISM ()
@@ -213,7 +219,42 @@ Intances of this class represent chain complexes. The class has 8 slots:
    ;; IDentification NuMber
    (idnm :type fixnum :initform (incf *idnm-counter*) :reader idnm)
    ;; ORiGiN
-   (orgn :type list :initarg :orgn :reader orgn)))
+   (orgn :type list :initarg :orgn :reader orgn))
+  (:documentation
+   "-----------------------------------------------------------------[class-doc]
+MORPHISM
+Slots: (sorc trgt degr intr strt ???-clnm ?-clnm rslts idnm orgn)
+Intances of this class represent morphisms between chain complexes, and the
+differential homomorphism of a chain complex is treated as a morphism of
+degree -1. The class has 10 slots:
+
+1. SORC, an object of class CHAIN-COMPLEX, the source chain complex of this
+   morphism.
+
+2. TRGT, an object of class CHAIN-COMPLEX, the target chain complex of this
+   morphism.
+
+3. DEGR, an integer, the degree of the morphism.
+
+4. INTR, a Lisp function implementing the morphism, taking account of the
+   strategy STRT.
+
+5. STRT, a symbol, one of :GNRT or :CMBN.
+
+6. ???-CLNM, an integer updated by the system for internal statistics.
+
+7. ?-CLNM, another integer maintained by the system for internal pusposes.
+
+8. RSLTS, an array of length +MAXIMAL-DIMENSION+ reserved by the system for
+   caching intermediate results.
+
+9. IDNM, an integer, a system-generated identifier for this object.
+
+10. ORGN, a list containg a comment indicating the origin of the object. The
+    should be unique (per session), since it is used in the implementation for
+    caching purposes.
+------------------------------------------------------------------------------"))
+
 
 (DEFSTRUCT (RESULT (:print-function result-print))
   (gnrt nil :type gnrt)