[seed] [docs] SeedFunctionCallback documentation
- From: Tim Horton <hortont src gnome org>
- To: svn-commits-list gnome org
- Subject: [seed] [docs] SeedFunctionCallback documentation
- Date: Sun, 12 Jul 2009 22:03:37 +0000 (UTC)
commit bd64bd2880e4a97ad149a9531857a2bd470c1424
Author: Tim Horton <hortont424 gmail com>
Date: Sun Jul 12 17:40:31 2009 -0400
[docs] SeedFunctionCallback documentation
I put docs for this in the sgml template. Not sure that's right, but it seems
wrong to put it in seed.h too
doc/reference/tmpl/seed-nativefuncs.sgml | 15 ++++++++-------
1 files changed, 8 insertions(+), 7 deletions(-)
---
diff --git a/doc/reference/tmpl/seed-nativefuncs.sgml b/doc/reference/tmpl/seed-nativefuncs.sgml
index 912eb4b..38417eb 100644
--- a/doc/reference/tmpl/seed-nativefuncs.sgml
+++ b/doc/reference/tmpl/seed-nativefuncs.sgml
@@ -26,13 +26,14 @@ All native C callbacks should have the prototype of SeedFunctionCallback().
</para>
- ctx:
- function:
- this_object:
- argument_count:
- arguments:
- exception:
- Returns:
+ 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
<!-- ##### FUNCTION seed_make_function ##### -->
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]