[seed] [docs] Update native function documentation



commit cb832d1dd5adf4f55e50044c4e35a76254af2d9c
Author: Tim Horton <hortont424 gmail com>
Date:   Sun Jul 12 17:21:25 2009 -0400

    [docs] Update native function documentation

 doc/reference/tmpl/seed-nativefuncs.sgml |   17 +++++------------
 libseed/seed-api.c                       |    5 ++++-
 2 files changed, 9 insertions(+), 13 deletions(-)
---
diff --git a/doc/reference/tmpl/seed-nativefuncs.sgml b/doc/reference/tmpl/seed-nativefuncs.sgml
index 5aab869..59a7d7a 100644
--- a/doc/reference/tmpl/seed-nativefuncs.sgml
+++ b/doc/reference/tmpl/seed-nativefuncs.sgml
@@ -6,7 +6,11 @@ C functions as first-class JavaScript objects
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
-Long description
+Exposing native C functions to JavaScript is one of the fundamental use cases for libseed when used in an embedding environment; if your application cannot be introspected, or you only have a small number of functions to expose, this is the simplest way to do that.
+</para>
+
+<para>
+All native C callbacks should have the prototype of SeedFunctionCallback(). 
 </para>
 
 <!-- ##### SECTION See_Also ##### -->
@@ -42,14 +46,3 @@ Long description
 @Returns: 
 
 
-<!-- ##### FUNCTION seed_create_function ##### -->
-<para>
-
-</para>
-
- ctx: 
- name: 
- callback: 
- object: 
-
-
diff --git a/libseed/seed-api.c b/libseed/seed-api.c
index c53c588..c425767 100644
--- a/libseed/seed-api.c
+++ b/libseed/seed-api.c
@@ -808,7 +808,10 @@ seed_object_is_of_class (JSContextRef ctx, JSObjectRef obj, JSClassRef class)
  * @func: A #SeedFunctionCallback to implement the function.
  * @name: The name of the function (used in exceptions).
  *
- * Return value: The function
+ * Creates a JavaScript object representing a first-class function; when
+ * the function is called from JavaScript, @func will be called.
+ *
+ * Return value: A #SeedObject representing the function
  */
 JSObjectRef
 seed_make_function (JSContextRef ctx,



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