commit 6dd8133e74a65a1c3594f07ce0e5ef5959ac3131
Author: Tim Horton <hortont svn gnome org>
Date: Mon Jul 6 07:44:02 2009 -0400
[docs] Continuing reorg; break into new sections, name sections
doc/reference/seed-docs.sgml | 28 ++-
doc/reference/seed-sections.txt | 218 +++++++++++---------
.../tmpl/{seed-value.sgml => seed-eval.sgml} | 4 +-
.../tmpl/{seed-value.sgml => seed-jsclass.sgml} | 4 +-
.../tmpl/{seed-value.sgml => seed-modules.sgml} | 4 +-
.../{seed-value.sgml => seed-nativefuncs.sgml} | 4 +-
.../{seed-value.sgml => seed-nativetypes.sgml} | 4 +-
.../tmpl/{seed-value.sgml => seed-signals.sgml} | 4 +-
.../{seed-value.sgml => seed-typeconversion.sgml} | 0
9 files changed, 151 insertions(+), 119 deletions(-)
---
diff --git a/doc/reference/seed-docs.sgml b/doc/reference/seed-docs.sgml
index ff5aec5..30c52e5 100644
--- a/doc/reference/seed-docs.sgml
+++ b/doc/reference/seed-docs.sgml
@@ -11,29 +11,37 @@
</releaseinfo>
</bookinfo>
- <chapter id="seed">
+ <part id="seed">
<title>Seed Overview</title>
<xi:include href="introduction.sgml"/>
<xi:include href="building.sgml"/>
<xi:include href="building-osx.sgml"/>
<xi:include href="contact.sgml"/>
- </chapter>
+ </part>
- <chapter id="js">
+ <part id="js">
<title>Seed JavaScript Reference</title>
- </chapter>
+ </part>
- <chapter id="api">
+ <part id="api">
<title>Seed API Reference</title>
<para>This is the documentation for the C API of Seed, used for embedding, and creating native C modules. For documentation on the JavaScript interface of Seed, see <ulink role="online-location" url="http://www.gnome.org/~racarr/seed";>http://www.gnome.org/~racarr/seed/</ulink>.</para>
<xi:include href="xml/seed-main.xml"/>
<xi:include href="xml/seed-context.xml"/>
- <xi:include href="xml/seed-closure.xml"/>
+ <xi:include href="xml/seed-eval.xml"/>
<xi:include href="xml/seed-exception.xml"/>
- <xi:include href="xml/seed-object.xml"/>
- <xi:include href="xml/seed-string.xml"/>
- <xi:include href="xml/seed-value.xml"/>
- </chapter>
+ <xi:include href="xml/seed-signals.xml"/>
+ <chapter id="types">
+ <title>Values and Type Conversion</title>
+ <xi:include href="xml/seed-typeconversion.xml"/>
+ <xi:include href="xml/seed-nativetypes.xml"/>
+ <xi:include href="xml/seed-object.xml"/>
+ </chapter>
+ <xi:include href="xml/seed-nativefuncs.xml"/>
+ <xi:include href="xml/seed-jsclass.xml"/>
+ <xi:include href="xml/seed-closure.xml"/>
+ <xi:include href="xml/seed-modules.xml"/>
+ </part>
<index>
<title>Index</title>
diff --git a/doc/reference/seed-sections.txt b/doc/reference/seed-sections.txt
index 9563a84..3517172 100644
--- a/doc/reference/seed-sections.txt
+++ b/doc/reference/seed-sections.txt
@@ -1,5 +1,16 @@
<SECTION>
-<TITLE>SeedContext</TITLE>
+<TITLE>Initialization</TITLE>
+<FILE>seed-main</FILE>
+<INCLUDE>seed/seed.h</INCLUDE>
+SeedEngine
+seed_init
+seed_init_with_context_group
+seed_engine_set_search_path
+seed_engine_get_search_path
+</SECTION>
+
+<SECTION>
+<TITLE>Contexts</TITLE>
<FILE>seed-context</FILE>
<INCLUDE>seed/seed.h</INCLUDE>
SeedContext
@@ -10,58 +21,51 @@ seed_context_ref
seed_context_unref
seed_context_get_global_object
seed_prepare_global_context
+seed_importer_add_global
+seed_importer_set_search_path
</SECTION>
<SECTION>
-<TITLE>SeedObject</TITLE>
-<FILE>seed-object</FILE>
+<TITLE>Evaluation</TITLE>
+<FILE>seed-eval</FILE>
<INCLUDE>seed/seed.h</INCLUDE>
-SeedPropertyAttributes
-SeedClassAttributes
-SeedClass
-SeedObject
-seed_create_class
-seed_make_object
-seed_make_array
-seed_object_call
-seed_object_set_property_at_index
-seed_object_get_property_at_index
-seed_object_is_of_class
-seed_object_get_private
-seed_object_set_private
-seed_object_get_property
-seed_object_set_property
-seed_object_get_prototype
-seed_object_copy_property_names
-SeedObjectInitializeCallback
-SeedObjectFinalizeCallback
-SeedObjectHasPropertyCallback
-SeedObjectGetPropertyCallback
-SeedObjectSetPropertyCallback
-SeedObjectDeletePropertyCallback
-SeedObjectGetPropertyNamesCallback
-SeedObjectCallAsFunctionCallback
-SeedObjectHasInstanceCallback
-SeedObjectConvertToTypeCallback
-SeedObjectCallAsConstructorCallback
+SeedScript
+seed_make_script
+seed_evaluate
+seed_simple_evaluate
+seed_script_new_from_file
+seed_script_exception
</SECTION>
+
<SECTION>
-<TITLE>SeedValue</TITLE>
-<FILE>seed-value</FILE>
+<TITLE>Exceptions</TITLE>
+<FILE>seed-exception</FILE>
+<INCLUDE>seed/seed.h</INCLUDE>
+SeedException
+seed_make_exception
+seed_exception_get_name
+seed_exception_get_message
+seed_exception_get_line
+seed_exception_get_file
+seed_exception_to_string
+</SECTION>
+
+<SECTION>
+<TITLE>Signals</TITLE>
+<FILE>seed-signals</FILE>
+<INCLUDE>seed/seed.h</INCLUDE>
+seed_signal_connect
+seed_signal_connect_value
+</SECTION>
+
+<SECTION>
+<TITLE>Native Type Conversion</TITLE>
+<FILE>seed-typeconversion</FILE>
<INCLUDE>seed/seed.h</INCLUDE>
SeedValue
SeedType
seed_make_undefined
seed_make_null
-seed_value_unprotect
-seed_value_protect
-seed_value_is_undefined
-seed_value_is_null
-seed_value_is_function
-seed_value_is_number
-seed_value_is_string
-seed_value_is_object_of_class
-seed_value_is_object
seed_value_to_boolean
seed_value_from_boolean
seed_value_to_uint
@@ -91,78 +95,98 @@ seed_value_to_object
seed_value_from_object
seed_value_to_filename
seed_value_from_filename
-seed_value_get_type
seed_value_to_format
+seed_pointer_get_pointer
+SeedString
+seed_string_ref
+seed_string_unref
+seed_string_get_maximum_size
+seed_string_to_utf8_buffer
+seed_string_is_equal
+seed_string_is_equal_utf8
</SECTION>
+
<SECTION>
-<TITLE>SeedClosure</TITLE>
-<FILE>seed-closure</FILE>
+<TITLE>Operating on Native Types</TITLE>
+<FILE>seed-nativetypes</FILE>
<INCLUDE>seed/seed.h</INCLUDE>
-SeedClosure
-seed_closure_new
-seed_closure_get_callable
-seed_closure_invoke
-seed_closure_invoke_with_context
-seed_closure_warn_exception
+seed_value_unprotect
+seed_value_protect
+seed_value_is_undefined
+seed_value_is_null
+seed_value_is_function
+seed_value_is_number
+seed_value_is_string
+seed_value_is_object_of_class
+seed_value_is_object
+seed_value_get_type
</SECTION>
<SECTION>
-<TITLE>SeedException</TITLE>
-<FILE>seed-exception</FILE>
+<TITLE>JS Objects</TITLE>
+<FILE>seed-object</FILE>
<INCLUDE>seed/seed.h</INCLUDE>
-SeedException
-seed_make_exception
-seed_exception_get_name
-seed_exception_get_message
-seed_exception_get_line
-seed_exception_get_file
-seed_exception_to_string
+SeedObject
+seed_make_object
+seed_make_array
+seed_object_call
+seed_object_set_property_at_index
+seed_object_get_property_at_index
+seed_object_is_of_class
+seed_object_get_private
+seed_object_set_private
+seed_object_get_property
+seed_object_set_property
+seed_object_get_prototype
+seed_object_copy_property_names
+SeedObjectInitializeCallback
+SeedObjectFinalizeCallback
+SeedObjectHasPropertyCallback
+SeedObjectGetPropertyCallback
+SeedObjectSetPropertyCallback
+SeedObjectDeletePropertyCallback
+SeedObjectGetPropertyNamesCallback
+SeedObjectCallAsFunctionCallback
+SeedObjectHasInstanceCallback
+SeedObjectConvertToTypeCallback
+SeedObjectCallAsConstructorCallback
</SECTION>
<SECTION>
-<TITLE>SeedString</TITLE>
-<FILE>seed-string</FILE>
+<TITLE>Native Functions</TITLE>
+<FILE>seed-nativefuncs</FILE>
<INCLUDE>seed/seed.h</INCLUDE>
-SeedString
-seed_string_ref
-seed_string_unref
-seed_string_get_maximum_size
-seed_string_to_utf8_buffer
-seed_string_is_equal
-seed_string_is_equal_utf8
+SeedFunctionCallback
+seed_make_function
+seed_create_function
</SECTION>
<SECTION>
-<TITLE>Library</TITLE>
-<FILE>seed-main</FILE>
+<TITLE>JavaScript Classes</TITLE>
+<FILE>seed-jsclass</FILE>
<INCLUDE>seed/seed.h</INCLUDE>
-<SUBSECTION>
-SeedEngine
-seed_init
-seed_init_with_context_group
-seed_importer_add_global
-seed_importer_set_search_path
-seed_engine_set_search_path
-seed_engine_get_search_path
-<SUBSECTION>
-SeedScript
-seed_make_script
-seed_evaluate
-seed_simple_evaluate
-seed_script_new_from_file
-seed_script_exception
-<SUBSECTION>
-seed_make_function
-seed_create_function
+SeedPropertyAttributes
+SeedClassAttributes
+SeedClass
+seed_create_class
seed_make_constructor
-<SUBSECTION>
-seed_pointer_get_pointer
-<SUBSECTION>
-SeedFunctionCallback
-SeedModuleInitCallback
</SECTION>
-<SUBSECTION>
-seed_signal_connect
-seed_signal_connect_value
+
+<SECTION>
+<TITLE>SeedClosure</TITLE>
+<FILE>seed-closure</FILE>
+<INCLUDE>seed/seed.h</INCLUDE>
+SeedClosure
+seed_closure_new
+seed_closure_get_callable
+seed_closure_invoke
+seed_closure_invoke_with_context
+seed_closure_warn_exception
</SECTION>
+<SECTION>
+<TITLE>Modules</TITLE>
+<FILE>seed-modules</FILE>
+<INCLUDE>seed/seed.h</INCLUDE>
+SeedModuleInitCallback
+</SECTION>
\ No newline at end of file
diff --git a/doc/reference/tmpl/seed-value.sgml b/doc/reference/tmpl/seed-eval.sgml
similarity index 71%
copy from doc/reference/tmpl/seed-value.sgml
copy to doc/reference/tmpl/seed-eval.sgml
index a27a154..b68c209 100644
--- a/doc/reference/tmpl/seed-value.sgml
+++ b/doc/reference/tmpl/seed-eval.sgml
@@ -1,8 +1,8 @@
<!-- ##### SECTION Title ##### -->
-Type Conversion
+Evaluating JavaScript
<!-- ##### SECTION Short_Description ##### -->
-Moving between JavaScript and C intrinsic types
+Creating and interpreting scripts
<!-- ##### SECTION Long_Description ##### -->
<para>
diff --git a/doc/reference/tmpl/seed-value.sgml b/doc/reference/tmpl/seed-jsclass.sgml
similarity index 66%
copy from doc/reference/tmpl/seed-value.sgml
copy to doc/reference/tmpl/seed-jsclass.sgml
index a27a154..e519800 100644
--- a/doc/reference/tmpl/seed-value.sgml
+++ b/doc/reference/tmpl/seed-jsclass.sgml
@@ -1,8 +1,8 @@
<!-- ##### SECTION Title ##### -->
-Type Conversion
+Creating JavaScript classes
<!-- ##### SECTION Short_Description ##### -->
-Moving between JavaScript and C intrinsic types
+Dealing with Seed class definitions and constructors
<!-- ##### SECTION Long_Description ##### -->
<para>
diff --git a/doc/reference/tmpl/seed-value.sgml b/doc/reference/tmpl/seed-modules.sgml
similarity index 71%
copy from doc/reference/tmpl/seed-value.sgml
copy to doc/reference/tmpl/seed-modules.sgml
index a27a154..453755a 100644
--- a/doc/reference/tmpl/seed-value.sgml
+++ b/doc/reference/tmpl/seed-modules.sgml
@@ -1,8 +1,8 @@
<!-- ##### SECTION Title ##### -->
-Type Conversion
+Seed Modules
<!-- ##### SECTION Short_Description ##### -->
-Moving between JavaScript and C intrinsic types
+Native C plug-in modules for Seed
<!-- ##### SECTION Long_Description ##### -->
<para>
diff --git a/doc/reference/tmpl/seed-value.sgml b/doc/reference/tmpl/seed-nativefuncs.sgml
similarity index 69%
copy from doc/reference/tmpl/seed-value.sgml
copy to doc/reference/tmpl/seed-nativefuncs.sgml
index a27a154..7c230c6 100644
--- a/doc/reference/tmpl/seed-value.sgml
+++ b/doc/reference/tmpl/seed-nativefuncs.sgml
@@ -1,8 +1,8 @@
<!-- ##### SECTION Title ##### -->
-Type Conversion
+Creating native functions
<!-- ##### SECTION Short_Description ##### -->
-Moving between JavaScript and C intrinsic types
+C functions as first-class JavaScript objects
<!-- ##### SECTION Long_Description ##### -->
<para>
diff --git a/doc/reference/tmpl/seed-value.sgml b/doc/reference/tmpl/seed-nativetypes.sgml
similarity index 71%
copy from doc/reference/tmpl/seed-value.sgml
copy to doc/reference/tmpl/seed-nativetypes.sgml
index a27a154..b376a56 100644
--- a/doc/reference/tmpl/seed-value.sgml
+++ b/doc/reference/tmpl/seed-nativetypes.sgml
@@ -1,8 +1,8 @@
<!-- ##### SECTION Title ##### -->
-Type Conversion
+Operating on JavaScript types
<!-- ##### SECTION Short_Description ##### -->
-Moving between JavaScript and C intrinsic types
+Determining the type of a SeedValue
<!-- ##### SECTION Long_Description ##### -->
<para>
diff --git a/doc/reference/tmpl/seed-value.sgml b/doc/reference/tmpl/seed-signals.sgml
similarity index 71%
copy from doc/reference/tmpl/seed-value.sgml
copy to doc/reference/tmpl/seed-signals.sgml
index a27a154..b8c3e54 100644
--- a/doc/reference/tmpl/seed-value.sgml
+++ b/doc/reference/tmpl/seed-signals.sgml
@@ -1,8 +1,8 @@
<!-- ##### SECTION Title ##### -->
-Type Conversion
+GObject Signals
<!-- ##### SECTION Short_Description ##### -->
-Moving between JavaScript and C intrinsic types
+Connecting JavaScript functions to signals
<!-- ##### SECTION Long_Description ##### -->
<para>
diff --git a/doc/reference/tmpl/seed-value.sgml b/doc/reference/tmpl/seed-typeconversion.sgml
similarity index 100%
rename from doc/reference/tmpl/seed-value.sgml
rename to doc/reference/tmpl/seed-typeconversion.sgml