[seed] [docs] Move SeedFunctionCallback docs to seed-api.c



commit d07fc3f0de74f1a97066d1fde477d98a09cc2974
Author: Tim Horton <hortont424 gmail com>
Date:   Sun Jul 12 17:49:42 2009 -0400

    [docs] Move SeedFunctionCallback docs to seed-api.c

 doc/reference/tmpl/seed-nativefuncs.sgml |   15 +++++++--------
 libseed/seed-api.c                       |   17 +++++++++++++++++
 2 files changed, 24 insertions(+), 8 deletions(-)
---
diff --git a/doc/reference/tmpl/seed-nativefuncs.sgml b/doc/reference/tmpl/seed-nativefuncs.sgml
index 38417eb..912eb4b 100644
--- a/doc/reference/tmpl/seed-nativefuncs.sgml
+++ b/doc/reference/tmpl/seed-nativefuncs.sgml
@@ -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 ##### -->
diff --git a/libseed/seed-api.c b/libseed/seed-api.c
index c425767..b8a7e91 100644
--- a/libseed/seed-api.c
+++ b/libseed/seed-api.c
@@ -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
+ */



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]