r9747: Version 2.11.13

       * doc/ref-ooddl.lisp: documentation additions
        * doc/ref-oodml.lisp: Add purpose to functions

diff --git a/ChangeLog b/ChangeLog
index e6db1dd1568a2e4f7674f46b696aa76162bbb708..82ea5c1bfb401071bc7a354d98e36c56d0d6a6ac 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,7 +1,10 @@
-8 Jul 2004 Kevin Rosenberg <kevin@rosenberg.net>
-       * sql/fdml.lisp: Apply patch from  Kim Minh Kaplan 
+9 Jul 2004 Kevin Rosenberg <kevin@rosenberg.net>
+       * Version 2.11.13
+       * sql/fdml.lisp: Apply patch from Kim Minh Kaplan 
        to change escaping of single quotes. Mild optimizations
        for escaped string output.
+       * doc/ref-ooddl.lisp: documentation additions
+       * doc/ref-oodml.lisp: Add purpose to functions
        * TODO: Add need to test single quote escaping
        
 7 Jul 2004 Kevin Rosenberg <kevin@rosenberg.net>

diff --git a/doc/ref-ooddl.xml b/doc/ref-ooddl.xml
index e61a1cc014b5fec90321e10653973288e0f8c776..54a7d8c3646701d64a88eacf192e760f7f145767 100644 (file)
--- a/doc/ref-ooddl.xml
+++ b/doc/ref-ooddl.xml
@@ -494,6 +494,15 @@
        and a column type <parameter>VARCHAR2(100)</parameter> in
        &oracle;
       </para>
+      <para>
+       The actual lisp type for a slot may be different than the
+       value specified by the <parameter>:type</parameter> attribute.
+       For example, a slot declared with "<parameter>:type (string
+       30)</parameter>" actually sets the slots Lisp type as
+       <parameter>(or null string)</parameter>. This is to allow a
+       &nil; value or a string shorter than 30 characters to be
+       stored in the slot.
+      </para>
     </refsect1>
   </refentry>
 
@@ -687,6 +696,4 @@
   </refentry>
 
 
-
-
 </reference> 

diff --git a/doc/ref-oodml.xml b/doc/ref-oodml.xml
index 4a5900cf6a300d27cc301d197ac5b220db59a70a..9b17eba7ee7da5c5a129e771fcad51b98ad6d228 100644 (file)
--- a/doc/ref-oodml.xml
+++ b/doc/ref-oodml.xml
@@ -189,8 +189,8 @@
   <refentry id="instance-refreshed">
     <refnamediv>
       <refname>INSTANCE-REFRESHED</refname>
-      <refpurpose><!-- purpose --></refpurpose>
-      <refclass>Function</refclass>
+      <refpurpose>Hook to call on object refresh</refpurpose>
+      <refclass>Generic function</refclass>
     </refnamediv>
     <refsect1>
       <title>Syntax</title>
@@ -200,7 +200,14 @@
     <refsect1>
       <title>Arguments and Values</title>
       <variablelist>
-        <!-- arguments and values --> 
+        <varlistentry>
+          <term><parameter>object</parameter></term>
+          <listitem>
+            <para>
+             The view class object which is being refreshed.
+            </para>
+          </listitem>
+        </varlistentry>
       </variablelist>
     </refsect1>
     <refsect1>
@@ -238,7 +245,7 @@
     <refsect1>
       <title>Exceptional Situations</title>
       <para>
-        <!-- execeptional situations -->
+       None.
       </para>
     </refsect1>
     <refsect1>
@@ -260,13 +267,13 @@
   <refentry id="update-instance-from-records">
     <refnamediv>
       <refname>UPDATE-INSTANCE-FROM-RECORDS</refname>
-      <refpurpose><!-- purpose --></refpurpose>
+      <refpurpose>Update slot values from database.</refpurpose>
       <refclass>Function</refclass>
     </refnamediv>
     <refsect1>
       <title>Syntax</title>
       <synopsis>
-      <function> (UPDATE-INSTANCE-FROM-RECORDS OBJECT &amp;KEY DATABASE) [generic]</function> => <returnvalue><!-- result --></returnvalue></synopsis>
+      <function>(update-instance-from-records object &amp;key database)</function> => <returnvalue><!-- result --></returnvalue></synopsis>
     </refsect1>
     <refsect1>
       <title>Arguments and Values</title>
@@ -329,13 +336,13 @@
   <refentry id="update-objects-joins">
     <refnamediv>
       <refname>UPDATE-OBJECTS-JOINS</refname>
-      <refpurpose><!-- purpose --></refpurpose>
+      <refpurpose>Updates joined slots of objects</refpurpose>
       <refclass>Function</refclass>
     </refnamediv>
     <refsect1>
       <title>Syntax</title>
       <synopsis>
-      <function> (UPDATE-OBJECTS-JOINS OBJECTS &amp;KEY (SLOTS T) (FORCE-P T) CLASS-NAME (MAX-LEN *DEFAULT-UPDATE-OBJECTS-MAX-LEN*)) [function]</function> => <returnvalue><!-- result --></returnvalue></synopsis>
+      <function>(update-objects-joins objects &amp;key (slots t) (force-p t) class-name (max-len *default-update-objects-max-len*))</function> => <returnvalue><!-- result --></returnvalue></synopsis>
     </refsect1>
     <refsect1>
       <title>Arguments and Values</title>
@@ -407,13 +414,13 @@
   <refentry id="update-record-from-slot">
     <refnamediv>
       <refname>UPDATE-RECORD-FROM-SLOT</refname>
-      <refpurpose><!-- purpose --></refpurpose>
+      <refpurpose>Updates database from slot value</refpurpose>
       <refclass>Function</refclass>
     </refnamediv>
     <refsect1>
       <title>Syntax</title>
       <synopsis>
-      <function> (UPDATE-RECORD-FROM-SLOT OBJECT SLOT &amp;KEY DATABASE) [generic]</function> => <returnvalue><!-- result --></returnvalue></synopsis>
+      <function>(update-record-from-slot object slot &amp;key database)</function> => <returnvalue><!-- result --></returnvalue></synopsis>
     </refsect1>
     <refsect1>
       <title>Arguments and Values</title>
@@ -479,13 +486,13 @@
   <refentry id="update-record-from-slots">
     <refnamediv>
       <refname>UPDATE-RECORD-FROM-SLOTS</refname>
-      <refpurpose><!-- purpose --></refpurpose>
+      <refpurpose>Update database from slots of view class object</refpurpose>
       <refclass>Function</refclass>
     </refnamediv>
     <refsect1>
       <title>Syntax</title>
       <synopsis>
-      <function> (UPDATE-RECORD-FROM-SLOTS OBJECT SLOTS &amp;KEY DATABASE) [generic]</function> => <returnvalue><!-- result --></returnvalue></synopsis>
+      <function>(update-record-from-slots object slots &amp;key database)</function> => <returnvalue><!-- result --></returnvalue></synopsis>
     </refsect1>
     <refsect1>
       <title>Arguments and Values</title>
@@ -553,13 +560,13 @@
   <refentry id="update-records-from-instance">
     <refnamediv>
       <refname>UPDATE-RECORDS-FROM-INSTANCE</refname>
-      <refpurpose><!-- purpose --></refpurpose>
+      <refpurpose>Update database from view class object.</refpurpose>
       <refclass>Function</refclass>
     </refnamediv>
     <refsect1>
       <title>Syntax</title>
       <synopsis>
-      <function> (UPDATE-RECORDS-FROM-INSTANCE OBJECT &amp;KEY DATABASE) [generic]</function> => <returnvalue><!-- result --></returnvalue></synopsis>
+      <function>(update-records-from-instance object &amp;key database)</function> => <returnvalue><!-- result --></returnvalue></synopsis>
     </refsect1>
     <refsect1>
       <title>Arguments and Values</title>
@@ -623,13 +630,13 @@
   <refentry id="update-slot-from-record">
     <refnamediv>
       <refname>UPDATE-SLOT-FROM-RECORD</refname>
-      <refpurpose><!-- purpose --></refpurpose>
+      <refpurpose>Update objects slot from database.</refpurpose>
       <refclass>Function</refclass>
     </refnamediv>
     <refsect1>
       <title>Syntax</title>
       <synopsis>
-      <function> (UPDATE-SLOT-FROM-RECORD OBJECT SLOT &amp;KEY DATABASE) [generic]</function> => <returnvalue><!-- result --></returnvalue></synopsis>
+      <function>(update-slot-from-record object slot &amp;key database)</function> => <returnvalue><!-- result --></returnvalue></synopsis>
     </refsect1>
     <refsect1>
       <title>Arguments and Values</title>