[docs] Move SeedFunctionCallback docs to seed-api.c
authorTim Horton <hortont424@gmail.com>
Sun, 12 Jul 2009 21:49:42 +0000 (17:49 -0400)
committerTim Horton <hortont424@gmail.com>
Sun, 12 Jul 2009 21:49:42 +0000 (17:49 -0400)
doc/reference/tmpl/seed-nativefuncs.sgml
libseed/seed-api.c

index 38417eb..912eb4b 100644 (file)
@@ -26,14 +26,13 @@ All native C callbacks should have the prototype of SeedFunctionCallback().
 
 </para>
 
-@ctx: A #SeedContext
-@function: The #SeedObject representing the function
-@this_object: The #SeedObject representing the "this" object in the caller
-@argument_count: The number of arguments passed into the callback
-@arguments: An array of #SeedValues; the value of the arguments passed in
-@exception: A reference to a #SeedException; use seed_make_exception() in order
-            to throw a JavaScript exception from the callback.
-@Returns: The #SeedValue to return to the caller
+@ctx: 
+@function: 
+@this_object: 
+@argument_count: 
+@arguments: 
+@exception: 
+@Returns: 
 
 
 <!-- ##### FUNCTION seed_make_function ##### -->
index c425767..b8a7e91 100644 (file)
@@ -918,3 +918,20 @@ seed_value_to_format (JSContextRef ctx,
   return TRUE;
 }
 
+/*************************** CALLBACK DOCUMENTATION **************************/
+
+/**
+ * SeedFunctionCallback:
+ * @ctx: A #SeedContext
+ * @function: The #SeedObject representing the function
+ * @this_object: The #SeedObject representing the "this" object in the caller
+ * @argument_count: The number of arguments passed into the callback
+ * @arguments: An array of #SeedValues; the value of the arguments passed in
+ * @exception: A reference to a #SeedException; use seed_make_exception() in order
+ *             to throw a JavaScript exception from the callback.
+ *
+ * All native C function callbacks should use the prototype of
+ * SeedFunctionCallback.
+ *
+ * Return value: The #SeedValue to return to the caller
+ */