[seed] Add docbook for gtkbuilder module. Pretty sparse...



commit 06c57d03d383283026ca00353b2b648d1cd8f3f4
Author: Robert Carr <racarr svn gnome org>
Date:   Wed May 20 22:22:18 2009 -0400

    Add docbook for gtkbuilder module. Pretty sparse...
---
 configure.ac                          |    1 +
 doc/modules/Makefile.am               |    4 +-
 doc/modules/book.xml                  |    1 +
 doc/modules/gtkbuilder/Makefile.am    |   12 ++++++++++
 doc/modules/gtkbuilder/gtkbuilder.js  |    5 ++++
 doc/modules/gtkbuilder/gtkbuilder.xml |   38 +++++++++++++++++++++++++++++++++
 6 files changed, 59 insertions(+), 2 deletions(-)

diff --git a/configure.ac b/configure.ac
index 3d46f96..77bec6b 100644
--- a/configure.ac
+++ b/configure.ac
@@ -360,6 +360,7 @@ doc/modules/sandbox/sandbox.html
 doc/modules/canvas/Makefile
 doc/modules/multiprocessing/Makefile
 doc/modules/readline/Makefile
+doc/modules/gtkbuilder/Makefile
 doc/modules/sqlite/Makefile
 doc/modules/sandbox/Makefile
 
diff --git a/doc/modules/Makefile.am b/doc/modules/Makefile.am
index fb8edf5..8dcb61a 100644
--- a/doc/modules/Makefile.am
+++ b/doc/modules/Makefile.am
@@ -1,7 +1,7 @@
-SUBDIRS=canvas multiprocessing readline sandbox sqlite
+SUBDIRS=canvas multiprocessing readline sandbox sqlite gtkbuilder
 
 if ENABLE_GTK_DOC
-html/index.html: book.xml sqlite/sqlite.xml sqlite/sqlite-funcs.xml readline/readline.xml readline/readline-funcs.xml make-functions.js
+html/index.html: book.xml sqlite/sqlite.xml sqlite/sqlite-funcs.xml readline/readline.xml readline/readline-funcs.xml make-functions.js gtkbuilder/gtkbuilder-funcs.xml gtkbuilder/gtkbuilder.xml
 	mkdir -p html;
 	gtkdoc-mkhtml "Seed" book.xml;
 	mv *.html *.css *.png *.sgml *.devhelp* html
diff --git a/doc/modules/book.xml b/doc/modules/book.xml
index 3a71218..9b4c6e2 100644
--- a/doc/modules/book.xml
+++ b/doc/modules/book.xml
@@ -12,5 +12,6 @@ doc/index.html">http://www.gnome.org/~racarr/seed/modules/</ulink>.
  
  <xi:include href="readline/readline.xml"/>
  <xi:include href="sqlite/sqlite.xml"/>
+ <xi:include href="gtkbuilder/gtkbuilder.xml"/>
 
 </book>
diff --git a/doc/modules/gtkbuilder/Makefile.am b/doc/modules/gtkbuilder/Makefile.am
new file mode 100644
index 0000000..0558b73
--- /dev/null
+++ b/doc/modules/gtkbuilder/Makefile.am
@@ -0,0 +1,12 @@
+EXTRA_DIST = \
+	gtkbuilder.js
+
+gtkbuilder-funcs.xml: $(top_builddir)/src/seed gtkbuilder.js
+	$(top_builddir)/src/seed ../make-functions.js gtkbuilder.js > gtkbuilder-funcs.xml
+CLEANFILES=gtkbuilder-funcs.xml
+
+gtkbuilderdocsdir = \
+	$(datadir)/doc/seed/modules/gtkbuilder/html
+gtkbuilderdocs_DATA = gtkbuilder-funcs.xml
+
+
diff --git a/doc/modules/gtkbuilder/gtkbuilder.js b/doc/modules/gtkbuilder/gtkbuilder.js
new file mode 100644
index 0000000..3de4e9a
--- /dev/null
+++ b/doc/modules/gtkbuilder/gtkbuilder.js
@@ -0,0 +1,5 @@
+funcs = [{id: "gtkbuilder-connect-signals",
+	  title: "builder.connect_signals (object, user_data)",
+	  description: "Connects signals"
+	 }]
+
diff --git a/doc/modules/gtkbuilder/gtkbuilder.xml b/doc/modules/gtkbuilder/gtkbuilder.xml
new file mode 100644
index 0000000..aae9250
--- /dev/null
+++ b/doc/modules/gtkbuilder/gtkbuilder.xml
@@ -0,0 +1,38 @@
+<?xml version="1.0"?>
+<chapter id="GtkBuilder-module" xmlns:xi="http://www.w3.org/2003/XInclude";>
+    <chapterinfo>
+    <author>
+      <firstname>Robert</firstname>
+      <surname>Carr</surname>
+      <affiliation>
+	<address>
+	  <email>racarr@<parameter>gnome.org</parameter></email>
+	</address>
+      </affiliation>
+    </author>
+  </chapterinfo>
+  <title>GtkBuilder module.</title>
+
+  <section>
+    <title>API Reference</title>
+    <para>
+      The GtkBuilder extends Gtk.GtkBuilder.prototype to implement a custom automatic signal connection function, which is useful in Seed. It does not provide any methods or types, so there is no need to save it's namespace, as of such it can be imported as follows.
+      <programlisting>
+	imports.gtkbuilder;
+      </programlisting>
+    </para>
+    
+    <xi:include href="gtkbuilder-funcs.xml"/>
+  </section>
+  <section>
+    <title>Examples</title>
+    <para>Below are several examples of using the Seed GtkBuilder module. For additional resources, consult the examples/ folder of the Seed source</para>
+    <example id="GtkBuilder-repl-example">
+      <para>This demonstrates basic usage of GtkBuilder automatic signal connection.</para>
+      <programlisting>
+
+      </programlisting>
+    </example>
+  </section>
+</chapter>
+



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