projects
/
clsql.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
r9747: Version 2.11.13
[clsql.git]
/
doc
/
ref-oodml.xml
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>
<refentry id="instance-refreshed">
<refnamediv>
<refname>INSTANCE-REFRESHED</refname>
- <refpurpose>
<!-- purpose -->
</refpurpose>
- <refclass>
F
unction</refclass>
+ <refpurpose>
Hook to call on object refresh
</refpurpose>
+ <refclass>
Generic f
unction</refclass>
</refnamediv>
<refsect1>
<title>Syntax</title>
</refnamediv>
<refsect1>
<title>Syntax</title>
@@
-200,7
+200,14
@@
<refsect1>
<title>Arguments and Values</title>
<variablelist>
<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>
</variablelist>
</refsect1>
<refsect1>
@@
-238,7
+245,7
@@
<refsect1>
<title>Exceptional Situations</title>
<para>
<refsect1>
<title>Exceptional Situations</title>
<para>
- <!-- execeptional situations -->
+ None.
</para>
</refsect1>
<refsect1>
</para>
</refsect1>
<refsect1>
@@
-260,13
+267,13
@@
<refentry id="update-instance-from-records">
<refnamediv>
<refname>UPDATE-INSTANCE-FROM-RECORDS</refname>
<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>
<refclass>Function</refclass>
</refnamediv>
<refsect1>
<title>Syntax</title>
<synopsis>
- <function>
(UPDATE-INSTANCE-FROM-RECORDS OBJECT &KEY DATABASE) [generic]
</function> => <returnvalue><!-- result --></returnvalue></synopsis>
+ <function>
(update-instance-from-records object &key database)
</function> => <returnvalue><!-- result --></returnvalue></synopsis>
</refsect1>
<refsect1>
<title>Arguments and Values</title>
</refsect1>
<refsect1>
<title>Arguments and Values</title>
@@
-329,13
+336,13
@@
<refentry id="update-objects-joins">
<refnamediv>
<refname>UPDATE-OBJECTS-JOINS</refname>
<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>
<refclass>Function</refclass>
</refnamediv>
<refsect1>
<title>Syntax</title>
<synopsis>
- <function>
(UPDATE-OBJECTS-JOINS OBJECTS &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 &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>
</refsect1>
<refsect1>
<title>Arguments and Values</title>
@@
-407,13
+414,13
@@
<refentry id="update-record-from-slot">
<refnamediv>
<refname>UPDATE-RECORD-FROM-SLOT</refname>
<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>
<refclass>Function</refclass>
</refnamediv>
<refsect1>
<title>Syntax</title>
<synopsis>
- <function>
(UPDATE-RECORD-FROM-SLOT OBJECT SLOT &KEY DATABASE) [generic]
</function> => <returnvalue><!-- result --></returnvalue></synopsis>
+ <function>
(update-record-from-slot object slot &key database)
</function> => <returnvalue><!-- result --></returnvalue></synopsis>
</refsect1>
<refsect1>
<title>Arguments and Values</title>
</refsect1>
<refsect1>
<title>Arguments and Values</title>
@@
-479,13
+486,13
@@
<refentry id="update-record-from-slots">
<refnamediv>
<refname>UPDATE-RECORD-FROM-SLOTS</refname>
<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>
<refclass>Function</refclass>
</refnamediv>
<refsect1>
<title>Syntax</title>
<synopsis>
- <function>
(UPDATE-RECORD-FROM-SLOTS OBJECT SLOTS &KEY DATABASE) [generic]
</function> => <returnvalue><!-- result --></returnvalue></synopsis>
+ <function>
(update-record-from-slots object slots &key database)
</function> => <returnvalue><!-- result --></returnvalue></synopsis>
</refsect1>
<refsect1>
<title>Arguments and Values</title>
</refsect1>
<refsect1>
<title>Arguments and Values</title>
@@
-553,13
+560,13
@@
<refentry id="update-records-from-instance">
<refnamediv>
<refname>UPDATE-RECORDS-FROM-INSTANCE</refname>
<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>
<refclass>Function</refclass>
</refnamediv>
<refsect1>
<title>Syntax</title>
<synopsis>
- <function>
(UPDATE-RECORDS-FROM-INSTANCE OBJECT &KEY DATABASE) [generic]
</function> => <returnvalue><!-- result --></returnvalue></synopsis>
+ <function>
(update-records-from-instance object &key database)
</function> => <returnvalue><!-- result --></returnvalue></synopsis>
</refsect1>
<refsect1>
<title>Arguments and Values</title>
</refsect1>
<refsect1>
<title>Arguments and Values</title>
@@
-623,13
+630,13
@@
<refentry id="update-slot-from-record">
<refnamediv>
<refname>UPDATE-SLOT-FROM-RECORD</refname>
<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>
<refclass>Function</refclass>
</refnamediv>
<refsect1>
<title>Syntax</title>
<synopsis>
- <function>
(UPDATE-SLOT-FROM-RECORD OBJECT SLOT &KEY DATABASE) [generic]
</function> => <returnvalue><!-- result --></returnvalue></synopsis>
+ <function>
(update-slot-from-record object slot &key database)
</function> => <returnvalue><!-- result --></returnvalue></synopsis>
</refsect1>
<refsect1>
<title>Arguments and Values</title>
</refsect1>
<refsect1>
<title>Arguments and Values</title>