GNOME.org
 

[seed] doc: Clean up the GTK-doc a lot, split things in to chapters, etc...

commit 0b632e6a2252658aa7e64e1518856c606b1b2a2b
Author: Robert Carr <racarr svn gnome org>
Date:   Tue May 12 22:15:22 2009 -0400

    doc: Clean up the GTK-doc a lot, split things in to chapters, etc...
---
 doc/reference/html/index.html   |   20 ++-
 doc/reference/seed-docs.sgml    |   11 +-
 doc/reference/seed-sections.txt |   73 +++++----
 doc/reference/tmpl/seed.sgml    |  311 ---------------------------------------
 4 files changed, 64 insertions(+), 351 deletions(-)

diff --git a/doc/reference/html/index.html b/doc/reference/html/index.html
index 739f908..cc0116c 100644
--- a/doc/reference/html/index.html
+++ b/doc/reference/html/index.html
@@ -5,10 +5,11 @@
 <title>Seed Reference Manual</title>
 <meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
 <link rel="start" href="index.html" title="Seed Reference Manual">
-<link rel="next" href="ch01.html" title="Seed External API">
+<link rel="next" href="ch01.html" title="General Seed Functions">
 <meta name="generator" content="GTK-Doc V1.11 (XML mode)">
 <link rel="stylesheet" href="style.css" type="text/css">
-<link rel="chapter" href="ch01.html" title="Seed External API">
+<link rel="chapter" href="ch01.html" title="General Seed Functions">
+<link rel="chapter" href="ch02.html" title="Value and Object manipulation">
 </head>
 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
 <div class="book" lang="en">
@@ -16,7 +17,7 @@
 <div>
 <div><table class="navigation" id="top" width="100%" cellpadding="2" cellspacing="0"><tr><th valign="middle"><p class="title">Seed Reference Manual</p></th></tr></table></div>
 <div><p class="releaseinfo">
-      Documentation for Seed 0.5. 
+      Documentation for Seed 0.7. 
       The latest version of this documentation can be found on-line at
       <a class="ulink" href="http://nowhere/seed/index.html"; target="_top">http://[SERVER]/seed/</a>.
     </p></div>
@@ -24,13 +25,13 @@
 <hr>
 </div>
 <div class="toc"><dl>
-<dt><span class="chapter"><a href="ch01.html">Seed External API</a></span></dt>
+<dt><span class="chapter"><a href="ch01.html">General Seed Functions</a></span></dt>
 <dd><dl>
 <dt>
 <span class="refentrytitle"><a href="seed-seed.html">seed</a></span><span class="refpurpose"></span>
 </dt>
 <dt>
-<span class="refentrytitle"><a href="seed-SeedValue.html">SeedValue</a></span><span class="refpurpose"> â?? Conversion between, and manipulation of, Seed and C types.</span>
+<span class="refentrytitle"><a href="seed-SeedClosure.html">SeedClosure</a></span><span class="refpurpose"></span>
 </dt>
 <dt>
 <span class="refentrytitle"><a href="seed-SeedString.html">SeedString</a></span><span class="refpurpose"> â?? Manipulation of <a class="link" href="seed-SeedString.html#SeedString" title="SeedString"><span class="type">SeedString</span></a> objects.</span>
@@ -39,6 +40,15 @@
 <span class="refentrytitle"><a href="seed-SeedException.html">SeedException</a></span><span class="refpurpose"> â?? Manipulation of JavaScript exceptions.</span>
 </dt>
 </dl></dd>
+<dt><span class="chapter"><a href="ch02.html">Value and Object manipulation</a></span></dt>
+<dd><dl>
+<dt>
+<span class="refentrytitle"><a href="seed-SeedObject.html">SeedObject</a></span><span class="refpurpose"></span>
+</dt>
+<dt>
+<span class="refentrytitle"><a href="seed-SeedValue.html">SeedValue</a></span><span class="refpurpose"> â?? Conversion between, and manipulation of, Seed and C types.</span>
+</dt>
+</dl></dd>
 </dl></div>
 </div>
 <div class="footer">
diff --git a/doc/reference/seed-docs.sgml b/doc/reference/seed-docs.sgml
index 2cab8df..aa5db4f 100644
--- a/doc/reference/seed-docs.sgml
+++ b/doc/reference/seed-docs.sgml
@@ -5,17 +5,22 @@
   <bookinfo>
     <title>Seed Reference Manual</title>
     <releaseinfo>
-      Documentation for Seed 0.5. 
+      Documentation for Seed 0.7. 
       The latest version of this documentation can be found on-line at
       <ulink role="online-location" url="http://nowhere/seed/index.html";>http://[SERVER]/seed/</ulink>.
     </releaseinfo>
   </bookinfo>
 
   <chapter>
-    <title>Seed External API</title>
+    <title>General Seed Functions</title>
     <xi:include href="xml/seed.xml"/>
-    <xi:include href="xml/seed-value.xml"/>
+    <xi:include href="xml/seed-closure.xml"/>
     <xi:include href="xml/seed-string.xml"/>
     <xi:include href="xml/seed-exception.xml"/>
   </chapter>
+  <chapter>
+    <title>Value and Object manipulation</title>
+    <xi:include href="xml/seed-object.xml"/>
+    <xi:include href="xml/seed-value.xml"/>
+  </chapter>
 </book>
diff --git a/doc/reference/seed-sections.txt b/doc/reference/seed-sections.txt
index 79b84e5..52aae1a 100644
--- a/doc/reference/seed-sections.txt
+++ b/doc/reference/seed-sections.txt
@@ -1,8 +1,38 @@
 <SECTION>
+<TITLE>SeedObject</TITLE>
+<FILE>seed-object</FILE>
+<INCLUDE>seed/seed.h</INCLUDE>
+SeedClass
+SeedObject
+seed_create_class
+seed_make_object
+seed_object_call
+seed_object_set_property_at_index
+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>SeedValue</TITLE>
 <FILE>seed-value</FILE>
 <INCLUDE>seed/seed.h</INCLUDE>
 SeedValue
+seed_make_undefined
+seed_make_null
 seed_value_unprotect
 seed_value_protect
 seed_value_is_null
@@ -38,6 +68,17 @@ seed_value_to_filename
 seed_value_from_filename
 seed_value_get_type
 </SECTION>
+<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>SeedException</TITLE>
@@ -94,44 +135,12 @@ seed_script_new_from_file
 seed_script_exception
 <SUBSECTION>
 seed_create_function
-seed_create_class
 seed_make_constructor
 <SUBSECTION>
-SeedObject
-seed_object_call
-seed_object_set_property_at_index
-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
-<SUBSECTION>
-seed_closure_new
-seed_closure_get_callable
-seed_closure_invoke
-seed_closure_invoke_with_context
-seed_closure_warn_exception
-<SUBSECTION>
-seed_make_undefined
-seed_make_null
-seed_make_object
-<SUBSECTION>
 seed_pointer_get_pointer
 <SUBSECTION>
 SeedFunctionCallback
 SeedModuleInitCallback
-SeedObjectInitializeCallback
-SeedObjectFinalizeCallback
-SeedObjectHasPropertyCallback
-SeedObjectGetPropertyCallback
-SeedObjectSetPropertyCallback
-SeedObjectDeletePropertyCallback
-SeedObjectGetPropertyNamesCallback
-SeedObjectCallAsFunctionCallback
-SeedObjectHasInstanceCallback
-SeedObjectConvertToTypeCallback
-SeedObjectCallAsConstructorCallback
 </SECTION>
 <SUBSECTION>
 seed_signal_connect
diff --git a/doc/reference/tmpl/seed.sgml b/doc/reference/tmpl/seed.sgml
index 9248a71..32e89cd 100644
--- a/doc/reference/tmpl/seed.sgml
+++ b/doc/reference/tmpl/seed.sgml
@@ -205,15 +205,6 @@ seed
 @object: 
 
 
-<!-- ##### FUNCTION seed_create_class ##### -->
-<para>
-
-</para>
-
- def: 
- Returns: 
-
-
 <!-- ##### FUNCTION seed_make_constructor ##### -->
 <para>
 
@@ -225,184 +216,6 @@ seed
 @Returns: 
 
 
-<!-- ##### TYPEDEF SeedObject ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### FUNCTION seed_object_call ##### -->
-<para>
-
-</para>
-
- ctx: 
- object: 
- this: 
- argument_count: 
- arguments: 
- exception: 
- Returns: 
-
-
-<!-- ##### FUNCTION seed_object_set_property_at_index ##### -->
-<para>
-
-</para>
-
- ctx: 
- object: 
- index: 
- value: 
- exception: 
-
-
-<!-- ##### FUNCTION seed_object_get_private ##### -->
-<para>
-
-</para>
-
- object: 
- Returns: 
-
-
-<!-- ##### FUNCTION seed_object_set_private ##### -->
-<para>
-
-</para>
-
- object: 
- value: 
-
-
-<!-- ##### FUNCTION seed_object_get_property ##### -->
-<para>
-
-</para>
-
- ctx: 
- object: 
- name: 
- Returns: 
-
-
-<!-- ##### FUNCTION seed_object_set_property ##### -->
-<para>
-
-</para>
-
- ctx: 
- object: 
- name: 
- value: 
- Returns: 
-
-
-<!-- ##### FUNCTION seed_object_get_prototype ##### -->
-<para>
-
-</para>
-
- ctx: 
- obj: 
- Returns: 
-
-
-<!-- ##### FUNCTION seed_object_copy_property_names ##### -->
-<para>
-
-</para>
-
- ctx: 
- object: 
- Returns: 
-
-
-<!-- ##### FUNCTION seed_closure_new ##### -->
-<para>
-
-</para>
-
- ctx: 
- function: 
- user_data: 
- description: 
- Returns: 
-
-
-<!-- ##### FUNCTION seed_closure_get_callable ##### -->
-<para>
-
-</para>
-
- c: 
- Returns: 
-
-
-<!-- ##### FUNCTION seed_closure_invoke ##### -->
-<para>
-
-</para>
-
- closure: 
- args: 
- argc: 
- exception: 
- Returns: 
-
-
-<!-- ##### FUNCTION seed_closure_invoke_with_context ##### -->
-<para>
-
-</para>
-
- ctx: 
- closure: 
- args: 
- argc: 
- exception: 
- Returns: 
-
-
-<!-- ##### FUNCTION seed_closure_warn_exception ##### -->
-<para>
-
-</para>
-
- c: 
- ctx: 
- exception: 
-
-
-<!-- ##### FUNCTION seed_make_undefined ##### -->
-<para>
-
-</para>
-
- ctx: 
- Returns: 
-
-
-<!-- ##### FUNCTION seed_make_null ##### -->
-<para>
-
-</para>
-
- ctx: 
- Returns: 
-
-
-<!-- ##### FUNCTION seed_make_object ##### -->
-<para>
-
-</para>
-
- ctx: 
- class: 
- private: 
- Returns: 
-
-
 <!-- ##### FUNCTION seed_pointer_get_pointer ##### -->
 <para>
 
@@ -435,127 +248,3 @@ seed
 @Returns: 
 
 
-<!-- ##### USER_FUNCTION SeedObjectInitializeCallback ##### -->
-<para>
-
-</para>
-
- ctx: 
- object: 
-
-
-<!-- ##### USER_FUNCTION SeedObjectFinalizeCallback ##### -->
-<para>
-
-</para>
-
- object: 
-
-
-<!-- ##### USER_FUNCTION SeedObjectHasPropertyCallback ##### -->
-<para>
-
-</para>
-
- ctx: 
- object: 
- string: 
- Returns: 
-
-
-<!-- ##### USER_FUNCTION SeedObjectGetPropertyCallback ##### -->
-<para>
-
-</para>
-
- ctx: 
- object: 
- property_name: 
- e: 
- Returns: 
-
-
-<!-- ##### USER_FUNCTION SeedObjectSetPropertyCallback ##### -->
-<para>
-
-</para>
-
- ctx: 
- object: 
- property_name: 
- value: 
- e: 
- Returns: 
-
-
-<!-- ##### USER_FUNCTION SeedObjectDeletePropertyCallback ##### -->
-<para>
-
-</para>
-
- ctx: 
- object: 
- property_name: 
- value: 
- e: 
- Returns: 
-
-
-<!-- ##### USER_FUNCTION SeedObjectGetPropertyNamesCallback ##### -->
-<para>
-
-</para>
-
-
-
-<!-- ##### USER_FUNCTION SeedObjectCallAsFunctionCallback ##### -->
-<para>
-
-</para>
-
- ctx: 
- function: 
- this_object: 
- argument_count: 
- arguments: 
- exception: 
- Returns: 
-
-
-<!-- ##### USER_FUNCTION SeedObjectHasInstanceCallback ##### -->
-<para>
-
-</para>
-
- ctx: 
- constructor: 
- instance_p: 
- exception: 
- Returns: 
-
-
-<!-- ##### USER_FUNCTION SeedObjectConvertToTypeCallback ##### -->
-<para>
-
-</para>
-
- ctx: 
- object: 
- type: 
- exception: 
- Returns: 
-
-
-<!-- ##### USER_FUNCTION SeedObjectCallAsConstructorCallback ##### -->
-<para>
-
-</para>
-
- ctx: 
- constructor: 
- argument_count: 
- arguments: 
- exception: 
- Returns: 
-
-
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]