diff options
Diffstat (limited to 'doc/reference/matchbox')
-rw-r--r-- | doc/reference/matchbox/Makefile.am | 88 | ||||
-rw-r--r-- | doc/reference/matchbox/matchbox2-docs.sgml | 57 | ||||
-rw-r--r-- | doc/reference/matchbox/matchbox2-sections.txt | 7 | ||||
-rw-r--r-- | doc/reference/matchbox/version.xml.in | 1 |
4 files changed, 153 insertions, 0 deletions
diff --git a/doc/reference/matchbox/Makefile.am b/doc/reference/matchbox/Makefile.am new file mode 100644 index 0000000..8649c74 --- /dev/null +++ b/doc/reference/matchbox/Makefile.am @@ -0,0 +1,88 @@ +## 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=matchbox + +# 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=../../../matchbox + +# 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=--deprecated-guards="MATCHBOX_DISABLE_DEPRECATED" + +# 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=\ + --extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html/gobject \ + --extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html/glib + +# 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=$(top_srcdir)/matchbox/*.h +CFILE_GLOB= + +# Header files to ignore when scanning. +# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h +IGNORE_HFILES=$(top_srcdir)/matchbox/*-private.h + +EXTRA_HFILES= + +# 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= \ + version.xml + +# 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=\ + $(MBWM_INCS) $(MBWM_CFLAGS) +GTKDOC_LIBS=\ + @MBWM_LIBS@ \ + $(top_builddir)/matchbox/libmatchbox-@MBWM_API_VERSION@.la + +# 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 += \ + version.xml.in diff --git a/doc/reference/matchbox/matchbox2-docs.sgml b/doc/reference/matchbox/matchbox2-docs.sgml new file mode 100644 index 0000000..51933f7 --- /dev/null +++ b/doc/reference/matchbox/matchbox2-docs.sgml @@ -0,0 +1,57 @@ +<?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" [ +<!ENTITY version SYSTEM "version.xml"> +]> +<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude"> + <bookinfo> + <title>Matchbox2 &version; Reference Manual</title> + <releaseinfo> + for matchbox2 &version; + The latest version of this documentation can be found on-line at + <ulink role="online-location" url="http://[SERVER]/matchbox2/index.html">http://[SERVER]/matchbox2/</ulink>. + </releaseinfo> + <copyright> + <year>2010</year> + <holder>Intel Corporation.</holder> + </copyright> + + <legalnotice> + <para> + Permission is granted to copy, distribute and/or modify this + document under the terms of the <citetitle>GNU Free + Documentation License</citetitle>, Version 1.1 or any later + version published by the Free Software Foundation with no + Invariant Sections, no Front-Cover Texts, and no Back-Cover + Texts. You may obtain a copy of the <citetitle>GNU Free + Documentation License</citetitle> from the Free Software + Foundation by visiting <ulink type="http" + url="http://www.fsf.org">their Web site</ulink> or by writing + to: + + <address> + The Free Software Foundation, Inc., + <street>59 Temple Place</street> - Suite 330, + <city>Boston</city>, <state>MA</state> <postcode>02111-1307</postcode> +, + <country>USA</country> + </address> + </para> + </legalnotice> + + </bookinfo> + + <chapter> + <title>Matchbox2 - Matchbox Window Manager II</title> + + <section id="matchbox2-intro"> + <title>About Matchbox2</title> + + <para>Matchbox Window Manager II is a complete rewrite of the original + m-w-m. It is in early stages of development.</para> + + </section> + + <xi:include href="xml/matchbox2.xml"/> + </chapter> +</book> diff --git a/doc/reference/matchbox/matchbox2-sections.txt b/doc/reference/matchbox/matchbox2-sections.txt new file mode 100644 index 0000000..eaa3e15 --- /dev/null +++ b/doc/reference/matchbox/matchbox2-sections.txt @@ -0,0 +1,7 @@ +<SECTION> +<FILE>matchbox2</FILE> +mb_wm_new +mb_wm_init +</SECTION> + + diff --git a/doc/reference/matchbox/version.xml.in b/doc/reference/matchbox/version.xml.in new file mode 100644 index 0000000..4314820 --- /dev/null +++ b/doc/reference/matchbox/version.xml.in @@ -0,0 +1 @@ +@MBW2_VERSION@ |