[doc] Add gtk-doc infrastructure for ccss-gtk.

4 files changed, 154 insertions, 0 deletions

diff --git a/ccss-gtk-doc/Makefile.am b/ccss-gtk-doc/Makefile.am
new file mode 100644
index 0000000..f3e6424
--- /dev/null
+++ b/ccss-gtk-doc/Makefile.am
@@ -0,0 +1,52 @@
+## Process this file with automake to produce Makefile.in
+
+# The name of the module.
+DOC_MODULE=ccss-gtk
+
+# The top-level SGML file.
+DOC_MAIN_SGML_FILE=ccss-gtk-docs.sgml
+
+# The directory containing the source code. Relative to $(srcdir)
+DOC_SOURCE_DIR=../ccss-gtk
+
+# Extra options to pass to gtkdoc-scangobj
+SCANGOBJ_OPTIONS= --nogtkinit --type-init-func="ccss_gtk_init ()" 
+
+# Extra options to supply to gtkdoc-scan
+SCAN_OPTIONS=
+
+# Extra options to supply to gtkdoc-mkdb
+MKDB_OPTIONS=--sgml-mode --output-format=xml
+
+# Extra options to supply to gtkdoc-fixref
+FIXXREF_OPTIONS=
+
+# Used for dependencies
+HFILE_GLOB=$(top_srcdir)/ccss-gtk/*.h
+CFILE_GLOB=$(top_srcdir)/ccss-gtk/*.c
+
+# Header files to ignore when scanning
+IGNORE_HFILES =
+
+EXTRA_HFILES =
+
+# Images to copy into HTML directory
+HTML_IMAGES =
+
+# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE)
+content_files =
+
+# Other files to distribute
+extra_files =
+
+# CFLAGS and LDFLAGS for compiling scan program. Only needed
+# if $(DOC_MODULE).types is non-empty.
+GTKDOC_CFLAGS = # -I$(top_srcdir) $(CCSS_GTK_CFLAGS)
+GTKDOC_LIBS = # $(CCSS_GTK_LIBS) $(top_builddir)/ccss-gtk/libccss-gtk-1.la
+
+if GTK_DOC_INSTALLED
+include $(top_srcdir)/gtk-doc.make
+CLEANFILES += scan-*
+.PHONY : dist-hook-local
+endif
+
diff --git a/ccss-gtk-doc/ccss-gtk-docs.sgml b/ccss-gtk-doc/ccss-gtk-docs.sgml
new file mode 100644
index 0000000..a9678d1
--- /dev/null
+++ b/ccss-gtk-doc/ccss-gtk-docs.sgml
@@ -0,0 +1,88 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
+               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
+
+<!ENTITY ccss_grammar_t			SYSTEM "xml/grammar.xml">
+<!ENTITY ccss_stylesheet_t			SYSTEM "xml/stylesheet.xml">
+
+<!ENTITY TreeIndex			SYSTEM "xml/tree_index.sgml">
+
+]>
+<book id="index">
+  <bookinfo>
+    <title>CCSS/Gtk+ Reference Manual</title>
+  </bookinfo>
+
+  <part id="intro">
+    <title>CCSS: Introduction</title>
+    <partintro id="ccss-into">
+    <para>
+TODO
+    </para>
+    </partintro>
+  </part>
+
+  <part id="dependencies">
+    <title>CCSS: Dependencies</title>
+    <para>
+The CCSS/Gtk+ library depends on the following libraries:
+<variablelist>
+
+<varlistentry>
+<term><link linkend="glib" title="GLib">GLib</link></term>
+<listitem><para>
+A general-purpose utility library, not specific to graphical user interfaces.
+GLib provides many useful data types, macros, type conversions,
+string utilities, file utilities, a main loop abstraction, and so on.
+</para></listitem>
+</varlistentry>
+
+<varlistentry>
+<term><link linkend="gtk" title="Gtk+">Gtk+</link></term>
+<listitem><para>
+GTK+ is a library for creating graphical user interfaces. It works on many UNIX-like platforms, Windows, and on framebuffer devices. GTK+ is released under the GNU Library General Public License (GNU LGPL), which allows for flexible licensing of client applications. GTK+ has a C-based object-oriented architecture that allows for maximum flexibility. Bindings for other languages have been written, including C++, Objective-C, Guile/Scheme, Perl, Python, TOM, Ada95, Free Pascal, and Eiffel.
+</para></listitem>
+</varlistentry>
+
+</variablelist>
+
+    </para>
+</part>
+
+<part id="ccss-users">
+  <title>Projects using CCSS/Gtk+</title>
+  <partintro id="ccss-projects">
+  <para>
+CCSS is used by
+<variablelist>
+<varlistentry>
+<term><ulink url="http://www.gnome.org/~robsta/gtk-css-engine/">Gtk CSS Engine</ulink></term>
+<listitem><para>
+The Gtk CSS Engine
+</para></listitem>
+</varlistentry>
+
+</variablelist>
+
+  </para>
+  </partintro>
+</part>
+
+<part id="api">
+  <title>API Reference</title>
+    <partintro id="ccss-api-ref">
+      <para>
+TODO.
+      </para>
+    </partintro>
+  <chapter id="basic">
+    <title>Basic Usage</title>
+    &ccss_grammar_t;
+    &ccss_stylesheet_t;
+  </chapter>
+ </part>
+<index id="ccss-gtk-index"> <!-- TODO how to get index -->
+&TreeIndex;
+</index>
+</book>
+
diff --git a/ccss-gtk-doc/ccss-gtk-sections.txt b/ccss-gtk-doc/ccss-gtk-sections.txt
new file mode 100644
index 0000000..f3b1115
--- /dev/null
+++ b/ccss-gtk-doc/ccss-gtk-sections.txt
@@ -0,0 +1,13 @@
+
+<SECTION>
+<TITLE>ccss_grammar_t</TITLE>
+<FILE>grammar</FILE>
+ccss_gtk_grammar_create
+</SECTION>
+
+<SECTION>
+<TITLE>ccss_stylesheet_t</TITLE>
+<FILE>stylesheet</FILE>
+ccss_gtk_stylesheet_to_gtkrc
+</SECTION>
+
diff --git a/ccss-gtk-doc/version.xml.in b/ccss-gtk-doc/version.xml.in
new file mode 100644
index 0000000..d78bda9
--- /dev/null
+++ b/ccss-gtk-doc/version.xml.in
@@ -0,0 +1 @@
+@VERSION@