[seed] [docs] Expand "Initialization" docs



commit b531c83fcd6eb374a9af4fcb5c763ab2d20d1723
Author: Tim Horton <hortont424 gmail com>
Date:   Wed Jul 8 01:24:17 2009 -0400

    [docs] Expand "Initialization" docs

 libseed/seed-api.c    |    4 +++-
 libseed/seed-engine.c |   24 +++++++++++++++++++++---
 2 files changed, 24 insertions(+), 4 deletions(-)
---
diff --git a/libseed/seed-api.c b/libseed/seed-api.c
index de1941f..3b8c646 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 the imports system.
+ * Sets the search path for the imports system.
  *
  */
 void
@@ -584,6 +584,8 @@ seed_engine_set_search_path (SeedEngine * eng, const gchar * path)
  * seed_engine_get_search_path:
  * @eng: A #SeedEngine, to get the currently set search path.
  *
+ * Retrieves the search path for the imports system.
+ *
  * Return value: A null-terminated array of strings containing the paths.
  *
  */
diff --git a/libseed/seed-engine.c b/libseed/seed-engine.c
index c06e143..c8cb189 100644
--- a/libseed/seed-engine.c
+++ b/libseed/seed-engine.c
@@ -1262,7 +1262,11 @@ seed_parse_args (int *argc, char ***argv)
  * @argc: A reference to the number of arguments remaining to parse.
  * @argv: A reference to an array of string arguments remaining to parse.
  *
- * Initializes a new #SeedEngine.
+ * Initializes a new #SeedEngine. This involves initializing GLib, creating
+ * an initial context with all of the default globals, and initializing 
+ * various internal parts of Seed.
+ *
+ * This function should only be called once within a single Seed application.
  *
  * Return value: The newly created and initialized #SeedEngine.
  *
@@ -1343,13 +1347,27 @@ seed_init (gint * argc, gchar *** argv)
 }
 
 
-
+/**
+ * seed_init_with_context_group:
+ * @argc: A reference to the number of arguments remaining to parse.
+ * @argv: A reference to an array of string arguments remaining to parse.
+ * @group: A #SeedContextGroup within which to create the initial context.
+ *
+ * Initializes a new #SeedEngine. This involves initializing GLib, creating
+ * an initial context (in #group) with all of the default globals, and
+ * initializing various internal parts of Seed.
+ *
+ * This function should only be called once within a single Seed application.
+ *
+ * Return value: The newly created and initialized #SeedEngine.
+ *
+ */
 SeedEngine *
 seed_init_with_context_group (gint * argc,
 			      gchar *** argv,
 			      JSContextGroupRef group)
 {
-  JSStringRef defaults_script;
+  // FIXME: this seems like unnecessary code duplication
 
   g_type_init ();
   g_log_set_handler ("GLib-GObject", G_LOG_LEVEL_WARNING, seed_log_handler,



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