summaryrefslogtreecommitdiff
path: root/ccss-cairo-doc
diff options
context:
space:
mode:
authorRobert Staudinger <robsta@gnome.org>2008-11-25 10:32:35 +0100
committerRobert Staudinger <robsta@gnome.org>2008-11-25 10:32:35 +0100
commit6bd873cc1817658804939a72fc431d1ddcd6f459 (patch)
treeaf121e7b1146b507c8814a988c94df86cfedc3fb /ccss-cairo-doc
parentc38745a278f18fd7ac5c7f8214a0ef0b5b6382ce (diff)
* Makefile.am:
* ccss-cairo-doc/Makefile.am: * ccss-cairo-doc/ccss-cairo-docs.sgml: * ccss-cairo-doc/ccss-cairo-sections.txt: * ccss-cairo-doc/version.xml.in: * configure.in: Add doc skeleton for ccss-cairo.
Diffstat (limited to 'ccss-cairo-doc')
-rw-r--r--ccss-cairo-doc/Makefile.am52
-rw-r--r--ccss-cairo-doc/ccss-cairo-docs.sgml96
-rw-r--r--ccss-cairo-doc/ccss-cairo-sections.txt8
-rw-r--r--ccss-cairo-doc/version.xml.in1
4 files changed, 157 insertions, 0 deletions
diff --git a/ccss-cairo-doc/Makefile.am b/ccss-cairo-doc/Makefile.am
new file mode 100644
index 0000000..09522a0
--- /dev/null
+++ b/ccss-cairo-doc/Makefile.am
@@ -0,0 +1,52 @@
+## Process this file with automake to produce Makefile.in
+
+# The name of the module.
+DOC_MODULE=ccss-cairo
+
+# The top-level SGML file.
+DOC_MAIN_SGML_FILE=ccss-cairo-docs.sgml
+
+# The directory containing the source code. Relative to $(srcdir)
+DOC_SOURCE_DIR=../ccss-cairo
+
+# Extra options to pass to gtkdoc-scangobj
+SCANGOBJ_OPTIONS= --nogtkinit --type-init-func="ccss_cairo_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-cairo/*.h
+CFILE_GLOB=$(top_srcdir)/ccss-cairo/*.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_CAIRO_CFLAGS)
+GTKDOC_LIBS = # $(top_builddir)/ccss/libccss-1.la $(top_builddir)/ccss-caior/libccss-cairo-1.la $(CCSS_LIBS)
+
+if GTK_DOC_INSTALLED
+include $(top_srcdir)/gtk-doc.make
+CLEANFILES += scan-*
+.PHONY : dist-hook-local
+endif
+
diff --git a/ccss-cairo-doc/ccss-cairo-docs.sgml b/ccss-cairo-doc/ccss-cairo-docs.sgml
new file mode 100644
index 0000000..bd5ac69
--- /dev/null
+++ b/ccss-cairo-doc/ccss-cairo-docs.sgml
@@ -0,0 +1,96 @@
+<?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-cairo SYSTEM "xml/ccss_cairo.xml">
+
+<!ENTITY TreeIndex SYSTEM "xml/tree_index.sgml">
+
+]>
+<book id="index">
+ <bookinfo>
+ <title>CCSS/Cairo 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>
+CCSS 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="cairo" title="Cairo">Cairo</link></term>
+<listitem><para>
+Cairo is a 2D graphics library with support for multiple output devices.
+Currently supported output targets include the X Window System, Quartz, Win32,
+image buffers, PostScript, PDF, and SVG file output. Experimental backends
+include OpenGL (through glitz), XCB, BeOS, OS/2, and DirectFB.
+</para></listitem>
+</varlistentry>
+
+<varlistentry>
+<term><link linkend="libsoup" title="LibSoup">LibSoup (optional)</link></term>
+<listitem><para>
+LibSoup is an HTTP client/server library for GNOME. It uses GObjects and the glib main loop, to integrate well with GNOME applications.
+</para></listitem>
+</varlistentry>
+
+</variablelist>
+
+ </para>
+</part>
+
+<part id="ccss-users">
+ <title>Projects using CCSS/Cairo</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_cairo;
+ </chapter>
+ </part>
+<index id="ccss-index">
+&TreeIndex;
+</index>
+</book>
+
diff --git a/ccss-cairo-doc/ccss-cairo-sections.txt b/ccss-cairo-doc/ccss-cairo-sections.txt
new file mode 100644
index 0000000..5cb492b
--- /dev/null
+++ b/ccss-cairo-doc/ccss-cairo-sections.txt
@@ -0,0 +1,8 @@
+
+<SECTION>
+<TITLE>Initialization</TITLE>
+<FILE>ccss_cairo</FILE>
+ccss_cairo_init
+ccss_cairo_shutdown
+</SECTION>
+
diff --git a/ccss-cairo-doc/version.xml.in b/ccss-cairo-doc/version.xml.in
new file mode 100644
index 0000000..d78bda9
--- /dev/null
+++ b/ccss-cairo-doc/version.xml.in
@@ -0,0 +1 @@
+@VERSION@