X-Git-Url: http://git.kpe.io/?p=clsql.git;a=blobdiff_plain;f=doc%2Fref-oodml.xml;h=9b17eba7ee7da5c5a129e771fcad51b98ad6d228;hp=4a5900cf6a300d27cc301d197ac5b220db59a70a;hb=75fc587eb38dc243370160823906f9cea60326df;hpb=e26e47c342e5a56655d97290cdf39425b670c9b0

diff --git a/doc/ref-oodml.xml b/doc/ref-oodml.xml
index 4a5900c..9b17eba 100644
--- 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>