seed r502 - in trunk: . doc doc/reference

[racarr svn gnome org]

Author: racarr
Date: Sat Dec 20 03:47:39 2008
New Revision: 502
URL: http://svn.gnome.org/viewvc/seed?rev=502&view=rev

Log:
gtk-doc actually builds now...

Added:
   trunk/doc/reference/
   trunk/doc/reference/Makefile.am
   trunk/doc/reference/seed-docs.sgml
   trunk/doc/reference/seed-sections.txt
   trunk/doc/reference/seed.types
Modified:
   trunk/Makefile.am
   trunk/autogen.sh
   trunk/configure.ac
   trunk/doc/Makefile.am

Modified: trunk/Makefile.am
==============================================================================
--- trunk/Makefile.am	(original)
+++ trunk/Makefile.am	Sat Dec 20 03:47:39 2008
@@ -28,6 +28,8 @@
 EXTRA_DIST = $(seeddoc_DATA) \
 	$(pkgconfig_DATA)
 
+DISTCHEKC_CONFIGURE_FLAGS=--enable-gtk-doc
+
 
 # Copy all the spec files. Of cource, only one is actually used.
 dist-hook:

Modified: trunk/autogen.sh
==============================================================================
--- trunk/autogen.sh	(original)
+++ trunk/autogen.sh	Sat Dec 20 03:47:39 2008
@@ -6,6 +6,8 @@
 
 DIE=0
 
+gtkdocize || exit 1
+
 if [ -n "$GNOME2_DIR" ]; then
 	ACLOCAL_FLAGS="-I $GNOME2_DIR/share/aclocal $ACLOCAL_FLAGS"
 	LD_LIBRARY_PATH="$GNOME2_DIR/lib:$LD_LIBRARY_PATH"

Modified: trunk/configure.ac
==============================================================================
--- trunk/configure.ac	(original)
+++ trunk/configure.ac	Sat Dec 20 03:47:39 2008
@@ -109,6 +109,7 @@
 tests/Makefile
 doc/Makefile
 doc/tutorial-standalone/Makefile
+doc/reference/Makefile
 examples/Makefile
 examples/lightsoff/Makefile
 examples/clutter-shader/Makefile

Modified: trunk/doc/Makefile.am
==============================================================================
--- trunk/doc/Makefile.am	(original)
+++ trunk/doc/Makefile.am	Sat Dec 20 03:47:39 2008
@@ -1,4 +1,4 @@
-SUBDIRS = tutorial-standalone
+SUBDIRS = tutorial-standalone reference
 
 EXTRA_DIST = \
 	runtime.html

Added: trunk/doc/reference/Makefile.am
==============================================================================
--- (empty file)
+++ trunk/doc/reference/Makefile.am	Sat Dec 20 03:47:39 2008
@@ -0,0 +1,87 @@
+## Process this file with automake to produce Makefile.in
+
+# We require automake 1.6 at least.
+AUTOMAKE_OPTIONS = 1.6
+
+# This is a blank Makefile.am for using gtk-doc.
+# Copy this to your project's API docs directory and modify the variables to
+# suit your project. See the GTK+ Makefiles in gtk+/docs/reference for examples
+# of using the various options.
+
+# The name of the module, e.g. 'glib'.
+DOC_MODULE=seed
+
+# The top-level SGML file. You can change this if you want to.
+DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
+
+# The directory containing the source code. Relative to $(srcdir).
+# gtk-doc will search all .c & .h files beneath here for inline comments
+# documenting the functions and macros.
+# e.g. DOC_SOURCE_DIR=../../../gtk
+DOC_SOURCE_DIR=../../libseed
+
+# Extra options to pass to gtkdoc-scangobj. Not normally needed.
+SCANGOBJ_OPTIONS=
+
+# Extra options to supply to gtkdoc-scan.
+# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED"
+SCAN_OPTIONS=
+
+# Extra options to supply to gtkdoc-mkdb.
+# e.g. MKDB_OPTIONS=--sgml-mode --output-format=xml
+MKDB_OPTIONS=--sgml-mode --output-format=xml
+
+# Extra options to supply to gtkdoc-mktmpl
+# e.g. MKTMPL_OPTIONS=--only-section-tmpl
+MKTMPL_OPTIONS=
+
+# Extra options to supply to gtkdoc-fixref. Not normally needed.
+# e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html
+FIXXREF_OPTIONS=
+
+# Used for dependencies. The docs will be rebuilt if any of these change.
+# e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h
+# e.g. CFILE_GLOB=$(top_srcdir)/gtk/*.c
+HFILE_GLOB=../../libseed/*.h
+CFILE_GLOB=../../libseed/*.c
+
+# Header files to ignore when scanning.
+# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h
+IGNORE_HFILES=seed-*.h
+
+# Images to copy into HTML directory.
+# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
+HTML_IMAGES=
+
+# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
+# e.g. content_files=running.sgml building.sgml changes-2.0.sgml
+content_files=
+
+# SGML files where gtk-doc abbrevations (#GtkWidget) are expanded
+# These files must be listed here *and* in content_files
+# e.g. expand_content_files=running.sgml
+expand_content_files=
+
+# CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library.
+# Only needed if you are using gtkdoc-scangobj to dynamically query widget
+# signals and properties.
+# e.g. INCLUDES=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
+# e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
+INCLUDES=
+GTKDOC_LIBS=
+
+# This includes the standard gtk-doc make rules, copied by gtkdocize.
+include $(top_srcdir)/gtk-doc.make
+
+# Other files to distribute
+# e.g. EXTRA_DIST += version.xml.in
+EXTRA_DIST +=
+
+# Files not to distribute
+# for --rebuild-types in $(SCAN_OPTIONS), e.g. $(DOC_MODULE).types
+# for --rebuild-sections in $(SCAN_OPTIONS) e.g. $(DOC_MODULE)-sections.txt
+#DISTCLEANFILES +=
+
+# Comment this out if you want your docs-status tested during 'make check'
+#TESTS = $(GTKDOC_CHECK)
+

Added: trunk/doc/reference/seed-docs.sgml
==============================================================================
--- (empty file)
+++ trunk/doc/reference/seed-docs.sgml	Sat Dec 20 03:47:39 2008
@@ -0,0 +1,28 @@
+<?xml version="1.0"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
+               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd";>
+<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude";>
+  <bookinfo>
+    <title>seed Reference Manual</title>
+    <releaseinfo>
+      for seed [VERSION]
+      The latest version of this documentation can be found on-line at
+      <ulink role="online-location" url="http://[SERVER]/seed/index.html";>http://[SERVER]/seed/</ulink>.
+    </releaseinfo>
+  </bookinfo>
+
+  <chapter>
+    <title>[Insert title here]</title>
+    <xi:include href="xml/seed-debug.xml"/>
+    <xi:include href="xml/seed-closure.xml"/>
+    <xi:include href="xml/seed-structs.xml"/>
+    <xi:include href="xml/seed-types.xml"/>
+    <xi:include href="xml/seed-gtype.xml"/>
+    <xi:include href="xml/seed-signals.xml"/>
+    <xi:include href="xml/seed-exceptions.xml"/>
+    <xi:include href="xml/seed.xml"/>
+    <xi:include href="xml/seed-engine.xml"/>
+    <xi:include href="xml/seed-builtins.xml"/>
+    <xi:include href="xml/seed-private.xml"/>
+  </chapter>
+</book>

Added: trunk/doc/reference/seed-sections.txt
==============================================================================
--- (empty file)
+++ trunk/doc/reference/seed-sections.txt	Sat Dec 20 03:47:39 2008
@@ -0,0 +1,211 @@
+<SECTION>
+<FILE>seed-debug</FILE>
+SeedDebugFlag
+SEED_NOTE
+SEED_MARK
+SEED_DBG
+seed_debug_flags
+</SECTION>
+
+<SECTION>
+<FILE>seed-closure</FILE>
+SeedClosure
+SeedNativeClosure
+seed_make_native_closure
+seed_make_gclosure
+seed_closures_init
+</SECTION>
+
+<SECTION>
+<FILE>seed-structs</FILE>
+seed_struct_class
+seed_make_union
+seed_make_struct
+seed_make_boxed
+seed_make_pointer
+seed_field_get_value
+seed_pointer_get_pointer
+seed_pointer_set_free
+seed_struct_find_field
+seed_union_find_field
+seed_construct_struct_type_with_parameters
+seed_structs_init
+</SECTION>
+
+<SECTION>
+<FILE>seed-types</FILE>
+seed_value_from_gvalue
+seed_object_get_property
+seed_object_set_property
+seed_gvalue_from_seed_value
+seed_gi_make_argument
+seed_gi_argument_make_js
+seed_gi_release_arg
+seed_gi_release_in_arg
+seed_value_to_boolean
+seed_value_from_boolean
+seed_value_to_uint
+seed_value_from_uint
+seed_value_to_int
+seed_value_from_int
+seed_value_to_char
+seed_value_from_char
+seed_value_to_uchar
+seed_value_from_uchar
+seed_value_to_long
+seed_value_from_long
+seed_value_to_ulong
+seed_value_from_ulong
+seed_value_to_int64
+seed_value_from_int64
+seed_value_to_uint64
+seed_value_from_uint64
+seed_value_to_float
+seed_value_from_float
+seed_value_to_double
+seed_value_from_double
+seed_value_to_string
+seed_value_from_string
+seed_value_to_object
+seed_value_from_object
+seed_toggle_ref
+</SECTION>
+
+<SECTION>
+<FILE>seed-gtype</FILE>
+seed_gtype_init
+</SECTION>
+
+<SECTION>
+<FILE>seed-signals</FILE>
+seed_signal_marshal_func
+seed_add_signals_to_object
+seed_get_signal_class
+gobject_signal_class
+</SECTION>
+
+<SECTION>
+<FILE>seed-exceptions</FILE>
+seed_make_exception
+seed_make_exception_from_gerror
+seed_exception_get_name
+seed_exception_get_message
+seed_exception_get_line
+seed_exception_get_file
+seed_exception_to_string
+</SECTION>
+
+<SECTION>
+<FILE>seed</FILE>
+SeedString
+SeedValue
+SeedObject
+SeedClass
+SeedException
+SeedContext
+SeedGlobalContext
+SeedContextGroup
+SeedType
+SeedPropertyAttributes
+SeedClassAttributes
+SeedScript
+SeedEngine
+seed_init
+seed_make_script
+seed_script_exception
+seed_make_exception
+seed_exception_get_name
+seed_exception_get_message
+seed_exception_get_line
+seed_exception_get_file
+seed_exception_to_string
+seed_evaluate
+seed_context_create
+seed_context_ref
+seed_context_unref
+seed_make_null
+seed_make_object
+seed_object_get_private
+seed_object_set_private
+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
+seed_object_call
+seed_value_unprotect
+seed_value_protect
+seed_object_set_property
+seed_object_get_property
+seed_object_set_property_at_index
+seed_value_to_boolean
+seed_value_from_boolean
+seed_value_to_uint
+seed_value_from_uint
+seed_value_to_int
+seed_value_from_int
+seed_value_to_char
+seed_value_from_char
+seed_value_to_uchar
+seed_value_from_uchar
+seed_value_to_long
+seed_value_from_long
+seed_value_to_ulong
+seed_value_from_ulong
+seed_value_to_int64
+seed_value_from_int64
+seed_value_to_uint64
+seed_value_from_uint64
+seed_value_to_float
+seed_value_from_float
+seed_value_to_double
+seed_value_from_double
+seed_value_to_string
+seed_value_from_string
+seed_value_to_object
+seed_value_from_object
+seed_pointer_get_pointer
+SeedFunctionCallback
+seed_create_function
+SeedModuleInitCallback
+SeedObjectInitializeCallback
+SeedObjectFinalizeCallback
+SeedObjectHasPropertyCallback
+SeedObjectGetPropertyCallback
+SeedObjectSetPropertyCallback
+SeedObjectDeletePropertyCallback
+SeedObjectGetPropertyNamesCallback
+SeedObjectCallAsFunctionCallback
+SeedObjectHasInstanceCallback
+SeedObjectConvertToTypeCallback
+seed_create_class
+seed_make_constructor
+</SECTION>
+
+<SECTION>
+<FILE>seed-engine</FILE>
+gobject_class
+gobject_method_class
+gobject_constructor_class
+seed_callback_class
+eng
+context_group
+SeedScript
+seed_gobject_get_prototype_for_gtype
+seed_gobject_get_class_for_gtype
+seed_gobject_define_property_from_function_info
+seed_create_function
+SeedModuleInitCallback
+</SECTION>
+
+<SECTION>
+<FILE>seed-builtins</FILE>
+seed_init_builtins
+</SECTION>
+
+<SECTION>
+<FILE>seed-private</FILE>
+SeedEngine
+</SECTION>
+

Added: trunk/doc/reference/seed.types
==============================================================================