[seed] [docs] Reorganize index to be more like Gtk
- From: Tim Horton <hortont src gnome org>
- To: svn-commits-list gnome org
- Subject: [seed] [docs] Reorganize index to be more like Gtk
- Date: Sun, 5 Jul 2009 03:17:09 +0000 (UTC)
commit 5d47a099bb6c15efbf01187954dbecadd7d60c82
Author: Tim Horton <hortont svn gnome org>
Date: Sat Jul 4 21:55:52 2009 -0400
[docs] Reorganize index to be more like Gtk
doc/reference/seed-docs.sgml | 45 +++++++++++++++++++++--------------------
libseed/seed-api.c | 12 +++++++++++
libseed/seed-closure.h | 6 +++++
libseed/seed-engine.h | 6 +++++
libseed/seed-exceptions.h | 2 +-
libseed/seed-types.h | 4 +-
6 files changed, 50 insertions(+), 25 deletions(-)
---
diff --git a/doc/reference/seed-docs.sgml b/doc/reference/seed-docs.sgml
index 75150bd..1a326e3 100644
--- a/doc/reference/seed-docs.sgml
+++ b/doc/reference/seed-docs.sgml
@@ -10,30 +10,31 @@
<ulink role="online-location" url="http://www.gnome.org/~racarr/seed/gtk-doc/index.html">http://www.gnome.org/~racarr/seed/gtk-doc/</ulink>.
</releaseinfo>
</bookinfo>
+
+ <chapter id="seed">
+ <title>Seed Overview</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>
+ Stuff here about installing, prereqs, contact info, etc.
+ </chapter>
- <preface>
- <title>Introduction</title>
- <para>
- This is the documentation for the C API of Seed, used for embedding, and 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>
- </preface>
+ <chapter id="fundamentals">
+ <title>Seed Fundamentals</title>
+ <xi:include href="xml/seed-main.xml"/>
+ <xi:include href="xml/seed-context.xml"/>
+ <xi:include href="xml/seed-closure.xml"/>
+ </chapter>
- <part>
- <title>API Reference</title>
- <chapter>
- <title>General Seed Functions</title>
- <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-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>
- </part>
+ <chapter id="general">
+ <title>Seed Exception Handling</title>
+ <xi:include href="xml/seed-exception.xml"/>
+ </chapter>
+
+ <chapter id="values">
+ <title>Seed Data Types and Type-Conversion Utilities</title>
+ <xi:include href="xml/seed-object.xml"/>
+ <xi:include href="xml/seed-string.xml"/>
+ <xi:include href="xml/seed-value.xml"/>
+ </chapter>
<index>
<title>Index</title>
diff --git a/libseed/seed-api.c b/libseed/seed-api.c
index 493b378..cd47b85 100644
--- a/libseed/seed-api.c
+++ b/libseed/seed-api.c
@@ -19,6 +19,18 @@
#include <stdarg.h>
/**
+ * SECTION:seed-main
+ * @short_description: Library initialization and engine configuration
+ *
+ */
+
+/**
+ * SECTION:seed-object
+ * @short_description: Manipulation of JavaScript objects
+ *
+ */
+
+/**
* seed_value_protect:
* @ctx: A #SeedContext.
* @value: The #SeedValue to protect.
diff --git a/libseed/seed-closure.h b/libseed/seed-closure.h
index 58bac5a..4e2a5df 100644
--- a/libseed/seed-closure.h
+++ b/libseed/seed-closure.h
@@ -19,6 +19,12 @@
* Copyright (C) Robert Carr 2008 <carrr rpi edu>
*/
+/**
+ * SECTION:seed-closure
+ * @short_description: JavaScript closures from C functions
+ *
+ */
+
#ifndef _SEED_CLOSURE_H_
#define _SEED_CLOSURE_H_
diff --git a/libseed/seed-engine.h b/libseed/seed-engine.h
index 75dd87d..fd82853 100644
--- a/libseed/seed-engine.h
+++ b/libseed/seed-engine.h
@@ -19,6 +19,12 @@
* Copyright (C) Robert Carr 2008 <carrr rpi edu>
*/
+/**
+ * SECTION:seed-context
+ * @short_description: Construction and manipulation of JavaScript contexts
+ *
+ */
+
#ifndef _SEED_ENGINE_H
#define _SEED_ENGINE_H
diff --git a/libseed/seed-exceptions.h b/libseed/seed-exceptions.h
index 11a445a..6a8a2c7 100644
--- a/libseed/seed-exceptions.h
+++ b/libseed/seed-exceptions.h
@@ -21,7 +21,7 @@
/**
* SECTION:seed-exception
- * @short_description: Manipulation of JavaScript exceptions.
+ * @short_description: Construction and handling of JavaScript exceptions
*
*/
diff --git a/libseed/seed-types.h b/libseed/seed-types.h
index 835b005..6fd5fb9 100644
--- a/libseed/seed-types.h
+++ b/libseed/seed-types.h
@@ -21,13 +21,13 @@
/**
* SECTION:seed-value
- * @short_description: Conversion between, and manipulation of, Seed and C types.
+ * @short_description: Conversion between, and manipulation of, Seed and C types
*
*/
/**
* SECTION:seed-string
- * @short_description: Manipulation of #SeedString objects.
+ * @short_description: Various string-related functions
*
*/
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]