svn commit - mysqldoc@docsrva: r10238 - trunk/ndbapi

[jon]

Author: jstephens
Date: 2008-03-14 19:42:22 +0100 (Fri, 14 Mar 2008)
New Revision: 10238

Log:

Updated description of Dictionary::dropEvent() (Thanks, Frazer!)

Minor markup fix



Modified:
   trunk/ndbapi/class-dictionary.xml


Modified: trunk/ndbapi/class-dictionary.xml
===================================================================
--- trunk/ndbapi/class-dictionary.xml	2008-03-14 17:36:58 UTC (rev 10237)
+++ trunk/ndbapi/class-dictionary.xml	2008-03-14 18:42:22 UTC (rev 10238)
Changed blocks: 2, Lines Added: 35, Lines Deleted: 9; 2240 bytes

@@ -1885,10 +1885,33 @@
         <title>Parameters</title>
 
         <para>
-          <emphasis>Required</emphasis>: A reference to an
-          <literal>Index</literal> object.
-          <emphasis>Optional</emphasis>: A reference to a
-          <literal>Table</literal> object.
+          <itemizedlist>
+
+            <listitem>
+              <formalpara>
+
+                <title>Required</title>
+
+                <para>
+                  A reference to an <literal>Index</literal> object.
+                </para>
+
+              </formalpara>
+            </listitem>
+
+            <listitem>
+              <formalpara>
+
+                <title>Optional</title>
+
+                <para>
+                  A reference to a <literal>Table</literal> object.
+                </para>
+
+              </formalpara>
+            </listitem>
+
+          </itemizedlist>
         </para>
 
       </formalpara>

@@ -1971,16 +1994,19 @@
             <listitem>
               <para>
                 The <replaceable>name</replaceable> of the event to be
-                dropped.
+                dropped, as a string.
               </para>
             </listitem>
 
             <listitem>
               <para>
-                An optional <replaceable>force</replaceable> parameter;
-                if set to a nonzero value, then the event is dropped in
-                spite of any conditions that would otherwise prevent it
-                from being dropped.
+                By default, <literal>dropEvent()</literal> fails if the
+                event specified does not exist. You can override this
+                behavior by passing any nonzero value for the (optional)
+                <replaceable>force</replaceable> argument; in this case
+                no check is made as to whether there actually is such an
+                event, and an error is returned only if the event exists
+                but it was for whatever reason not possible to drop it.
               </para>
             </listitem>