[seed] [docs] Add contact information to docs



commit 4607806086a74b4caca92e96659ad03446247ba5
Author: Tim Horton <hortont424 gmail com>
Date:   Sun Jul 5 22:57:55 2009 -0400

    [docs] Add contact information to docs

 doc/reference/contact.sgml   |   23 +++++++++++++++++++++++
 doc/reference/seed-docs.sgml |   19 ++++++++-----------
 libseed/seed-api.c           |   12 ------------
 libseed/seed-closure.h       |    6 ------
 libseed/seed-exceptions.h    |    6 ------
 libseed/seed-types.h         |   12 ------------
 6 files changed, 31 insertions(+), 47 deletions(-)
---
diff --git a/doc/reference/contact.sgml b/doc/reference/contact.sgml
new file mode 100644
index 0000000..2aacddc
--- /dev/null
+++ b/doc/reference/contact.sgml
@@ -0,0 +1,23 @@
+<refentry id="seed-contact" revision="05 Jul 2009">
+<refmeta>
+<refentrytitle>Contact Information</refentrytitle>
+<manvolnum>3</manvolnum>
+<refmiscinfo>SEED Library</refmiscinfo>
+</refmeta>
+
+<refnamediv>
+<refname>Contact Information</refname>
+<refpurpose>
+Where to find help, ask questions, or bring patches
+</refpurpose>
+  </refnamediv>
+  
+    <refsect1 id="build">
+      <title>Authors</title>
+      <itemizedlist>
+        <listitem><para>Robert Carr &lt;racarr svn gnome org&gt;</para></listitem>
+        <listitem><para>Tim Horton &lt;hortont svn gnome org&gt;</para></listitem>
+    </itemizedlist>
+    </refsect1>
+
+</refentry>
diff --git a/doc/reference/seed-docs.sgml b/doc/reference/seed-docs.sgml
index cbbd5c4..ff5aec5 100644
--- a/doc/reference/seed-docs.sgml
+++ b/doc/reference/seed-docs.sgml
@@ -13,26 +13,23 @@
 
   <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>
     <xi:include href="introduction.sgml"/>
     <xi:include href="building.sgml"/>
     <xi:include href="building-osx.sgml"/>
+    <xi:include href="contact.sgml"/>
+  </chapter>
+  
+  <chapter id="js">
+    <title>Seed JavaScript Reference</title>
   </chapter>
   
-  <chapter id="fundamentals">
-    <title>Seed Fundamentals</title>
+  <chapter 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"/>
-  </chapter>
-  
-  <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"/>
diff --git a/libseed/seed-api.c b/libseed/seed-api.c
index cd47b85..493b378 100644
--- a/libseed/seed-api.c
+++ b/libseed/seed-api.c
@@ -19,18 +19,6 @@
 #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 4e2a5df..58bac5a 100644
--- a/libseed/seed-closure.h
+++ b/libseed/seed-closure.h
@@ -19,12 +19,6 @@
  * 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-exceptions.h b/libseed/seed-exceptions.h
index 6a8a2c7..c415090 100644
--- a/libseed/seed-exceptions.h
+++ b/libseed/seed-exceptions.h
@@ -19,12 +19,6 @@
  * Copyright (C) Robert Carr 2008 <carrr rpi edu>
  */
 
-/**
- * SECTION:seed-exception
- * @short_description: Construction and handling of JavaScript exceptions
- *
- */
-
 #ifndef _SEED_EXCEPTIONS_H
 #define _SEED_EXCEPTIONS_H
 
diff --git a/libseed/seed-types.h b/libseed/seed-types.h
index 6fd5fb9..d3d0bb7 100644
--- a/libseed/seed-types.h
+++ b/libseed/seed-types.h
@@ -19,18 +19,6 @@
  * Copyright (C) Robert Carr 2008 <carrr rpi edu>
  */
 
-/**
- * SECTION:seed-value
- * @short_description: Conversion between, and manipulation of, Seed and C types
- *
- */
-
-/**
- * SECTION:seed-string
- * @short_description: Various string-related functions
- *
- */
-
 #ifndef _SEED_TYPES_H
 #define _SEED_TYPES_H
 



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