[graphic-forms-cvs] r391 - trunk/docs/manual

[junrue at common-lisp.net]

Author: junrue
Date: Sun Nov  5 17:38:08 2006
New Revision: 391

Modified:
   trunk/docs/manual/gfw-symbols.xml
Log:
documented the startup and shutdown functions

Modified: trunk/docs/manual/gfw-symbols.xml
==============================================================================
--- trunk/docs/manual/gfw-symbols.xml	(original)
+++ trunk/docs/manual/gfw-symbols.xml	Sun Nov  5 17:38:08 2006
@@ -2059,6 +2059,56 @@
 
   <!-- FUNCTIONS -->
 
+  <function name="startup">
+    <syntax>
+      <arguments>
+        <argument name="string">
+          <description>
+            A <refclhs>string</refclhs> identifying the application's name.
+          </description>
+        </argument>
+        <argument name="function">
+          <description>
+            A <emphasis>function</emphasis> with initialization code for the
+            application.
+          </description>
+        </argument>
+      </arguments>
+      <return>
+        <emphasis>undefined</emphasis>
+      </return>
+    </syntax>
+    <description>
+      This is the main entry point for applications.
+    </description>
+    <seealso>
+      <reftopic>gfw:shutdown</reftopic>
+    </seealso>
+  </function>
+
+  <function name="shutdown">
+    <syntax>
+      <arguments>
+        <argument name="integer">
+          <description>
+            An <refclhs>integer</refclhs> exit code.
+          </description>
+        </argument>
+      </arguments>
+      <return>
+        <emphasis>undefined</emphasis>
+      </return>
+    </syntax>
+    <description>
+      Applications call this function to perform graceful cleanup and exit.
+      One of the side effects of this function is the posting of a WM_QUIT
+      message.
+    </description>
+    <seealso>
+      <reftopic>gfw:startup</reftopic>
+    </seealso>
+  </function>
+
   <function name="capture-mouse">
     <syntax>
       <arguments>