[seed] [docs] Add overrides for some of the structs which aren't getting scanned



commit f2913266b2903527b55333c32318974259608b4a
Author: Tim Horton <hortont424 gmail com>
Date:   Wed Jul 8 00:11:10 2009 -0400

    [docs] Add overrides for some of the structs which aren't getting scanned

 .gitignore                           |    1 -
 doc/reference/seed-overrides.txt     |   41 ++++++++++++++++++++++++++++++++++
 doc/reference/tmpl/seed-closure.sgml |   11 +++++++++
 doc/reference/tmpl/seed-eval.sgml    |    4 +++
 doc/reference/tmpl/seed-main.sgml    |   12 +++++++++-
 libseed/seed-api.c                   |    5 ++-
 6 files changed, 70 insertions(+), 4 deletions(-)
---
diff --git a/.gitignore b/.gitignore
index f550d7d..1e44fa1 100644
--- a/.gitignore
+++ b/.gitignore
@@ -50,7 +50,6 @@ doc/reference/html/up.png
 doc/reference/scan-build.stamp
 doc/reference/seed-decl-list.txt
 doc/reference/seed-decl.txt
-doc/reference/seed-overrides.txt
 doc/reference/seed-undeclared.txt
 doc/reference/seed-undocumented.txt
 doc/reference/seed-unused.txt
diff --git a/doc/reference/seed-overrides.txt b/doc/reference/seed-overrides.txt
new file mode 100644
index 0000000..54311e0
--- /dev/null
+++ b/doc/reference/seed-overrides.txt
@@ -0,0 +1,41 @@
+# These are manually-edited to override or add declarations to those scanned
+# from the Seed header files.
+
+
+<STRUCT>
+<NAME>SeedEngine</NAME>
+struct SeedEngine
+{
+	JSGlobalContextRef context;
+	JSObjectRef global;
+	gchar **search_path;
+
+	JSContextGroupRef group;
+};
+</STRUCT>
+
+<STRUCT>
+<NAME>SeedScript</NAME>
+struct SeedScript
+{
+  JSStringRef script;
+  JSValueRef exception;
+
+  JSStringRef source_url;
+  gint line_number;
+};
+</STRUCT>
+
+<STRUCT>
+<NAME>SeedClosure</NAME>
+struct SeedClosure
+{
+  GClosure closure;
+
+  JSObjectRef function;
+  JSValueRef user_data;
+
+  GType return_type;
+  gchar *description;
+};
+</STRUCT>
diff --git a/doc/reference/tmpl/seed-closure.sgml b/doc/reference/tmpl/seed-closure.sgml
index a8c8973..79c6f97 100644
--- a/doc/reference/tmpl/seed-closure.sgml
+++ b/doc/reference/tmpl/seed-closure.sgml
@@ -17,6 +17,17 @@ Long description
 <!-- ##### SECTION Stability_Level ##### -->
 
 
+<!-- ##### STRUCT SeedClosure ##### -->
+<para>
+
+</para>
+
+ closure: 
+ function: 
+ user_data: 
+ return_type: 
+ description: 
+
 <!-- ##### FUNCTION seed_closure_new ##### -->
 <para>
 
diff --git a/doc/reference/tmpl/seed-eval.sgml b/doc/reference/tmpl/seed-eval.sgml
index 342490a..31aa236 100644
--- a/doc/reference/tmpl/seed-eval.sgml
+++ b/doc/reference/tmpl/seed-eval.sgml
@@ -22,6 +22,10 @@ Long description
 
 </para>
 
+ script: 
+ exception: 
+ source_url: 
+ line_number: 
 
 <!-- ##### FUNCTION seed_make_script ##### -->
 <para>
diff --git a/doc/reference/tmpl/seed-main.sgml b/doc/reference/tmpl/seed-main.sgml
index a158bbb..7995c0b 100644
--- a/doc/reference/tmpl/seed-main.sgml
+++ b/doc/reference/tmpl/seed-main.sgml
@@ -6,7 +6,7 @@ Overall setup of the Seed engine
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
-Long description
+Before any other Seed functions can be used, you must initialize the engine, which creates an initial JavaScript context and sets up JavaScriptCore and GLib. To do this in most cases, you will use seed_init(), which will provide you with a #SeedEngine. Only one SeedEngine is permitted per application; use a #SeedContext to sandbox code execution.
 </para>
 
 <!-- ##### SECTION See_Also ##### -->
@@ -17,6 +17,16 @@ Long description
 <!-- ##### SECTION Stability_Level ##### -->
 
 
+<!-- ##### STRUCT SeedEngine ##### -->
+<para>
+
+</para>
+
+ context: 
+ global: 
+ search_path: 
+ group: 
+
 <!-- ##### FUNCTION seed_init ##### -->
 <para>
 
diff --git a/libseed/seed-api.c b/libseed/seed-api.c
index 493b378..de1941f 100644
--- a/libseed/seed-api.c
+++ b/libseed/seed-api.c
@@ -568,7 +568,7 @@ seed_value_is_number (JSContextRef ctx, JSValueRef value)
  * @eng: A #SeedEngine, on which to set the path.
  * @path: A #const gchar*, a colon separated string containing the path to set
  *
- * Sets the default search path for Seed.include.
+ * Sets the default search path for the imports system.
  *
  */
 void
@@ -650,7 +650,8 @@ seed_context_get_global_object (JSGlobalContextRef ctx)
  * @ctx: A valid #SeedContext
  * @elements: An array of #SeedValue's with which to populate the array.
  * @num_elements: The number of values, in @elements
- * @exception: A #SeedException in which to store an exception. Pass %NULL to ignore exceptions.
+ * @exception: A #SeedException in which to store an exception.
+ *             Pass %NULL to ignore exceptions.
  *
  * Return value: A new array object, populated with @elements.
  */



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