[seed] Add gtkdocs for Request #612590 - initialization using existing context
- From: Alan Knowles <alank src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [seed] Add gtkdocs for Request #612590 - initialization using existing context
- Date: Wed, 17 Mar 2010 04:14:25 +0000 (UTC)
commit 45e262f545cb6be137eeb6632dd8605237d8f8f4
Author: Alexandre Mazari <scaroo gmail com>
Date: Wed Mar 17 12:12:49 2010 +0800
Add gtkdocs for Request #612590 - initialization using existing context
gtkdoc comments for 2 new methods to initialize using existing context
libseed/seed-engine.c | 33 ++++++++++++++++++++++++++++++++-
1 files changed, 32 insertions(+), 1 deletions(-)
---
diff --git a/libseed/seed-engine.c b/libseed/seed-engine.c
index 8092fed..ff2634f 100644
--- a/libseed/seed-engine.c
+++ b/libseed/seed-engine.c
@@ -1453,7 +1453,23 @@ seed_engine_destroy (SeedEngine *eng)
g_free (eng);
}
-
+/**
+ * seed_init_with_context_and_group:
+ * @argc: A reference to the number of arguments remaining to parse.
+ * @argv: A reference to an array of string arguments remaining to parse.
+ * @context A reference to an existing JavascriptCore context
+ * @group: A #SeedContextGroup within which to create the initial context.
+ *
+ * Initializes a new #SeedEngine using an existing JavascriptCore context.
+ * This involves initializing GLib, adding @instance to @group, adding the
+ * default globals to the provided context, 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_and_group (gint * argc,
gchar *** argv, JSGlobalContextRef context, JSContextGroupRef group)
@@ -1586,6 +1602,21 @@ seed_init (gint * argc, gchar *** argv)
return seed_init_with_context_group (argc, argv, context_group);
}
+/**
+ * seed_init_with_context:
+ * @argc: A reference to the number of arguments remaining to parse.
+ * @argv: A reference to an array of string arguments remaining to parse.
+ * @context A reference to an existing JavascriptCore context
+
+ * Initializes a new #SeedEngine using an existing JavascriptCore context.
+ * This involves initializing GLib, adding the default globals to the provided
+ * @context 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 (gint * argc, gchar *** argv, JSGlobalContextRef context)
{
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]