diff options
-rw-r--r-- | configure.ac | 21 | ||||
-rw-r--r-- | doc/Makefile.am | 7 | ||||
-rw-r--r-- | doc/reference/Makefile.am | 1 | ||||
-rw-r--r-- | doc/reference/matchbox2/Makefile.am | 91 | ||||
-rw-r--r-- | doc/reference/matchbox2/matchbox2-docs.sgml | 57 | ||||
-rw-r--r-- | doc/reference/matchbox2/matchbox2-sections.txt | 7 | ||||
-rw-r--r-- | doc/reference/matchbox2/version.xml.in | 1 | ||||
-rw-r--r-- | matchbox2/core/mb-window-manager.h | 10 |
8 files changed, 194 insertions, 1 deletions
diff --git a/configure.ac b/configure.ac index ccf094a..9e839db 100644 --- a/configure.ac +++ b/configure.ac @@ -17,6 +17,9 @@ AC_CONFIG_SRCDIR([matchbox2/core/mb-window-manager.c]) AM_INIT_AUTOMAKE() +MBWM2_VERSION=mbwm2_version +AC_SUBST(MBWM2_VERSION) + MBWM2_API_VERSION=mbwm2_api_version AC_SUBST(MBWM2_API_VERSION) @@ -38,6 +41,18 @@ AC_CHECK_HEADERS([stdlib.h string.h expat.h]) AC_C_CONST AC_CHECK_FUNCS([memset strdup strncasecmp]) +GTK_DOC_CHECK([1.13], [--flavour no-tmpl]) + +# we don't want to build the documentation from a Git clone unless we +# explicitly tell configure to do so; this allows avoiding to recurse into +# the documentation directory when building Matchbox2 inside Poky for a +# target device that doesn't have gtk-doc installed. for reference +# see: http://bugzilla.openedhand.com/show_bug.cgi?id=1047 +# +# we use autogen.sh as it exists only inside the Git clones, and it +# is not packaged into tarballs. +AM_CONDITIONAL([BUILD_GTK_DOC], [test "x$enable_gtk_doc" = "xyes" || test ! -f "autogen.sh"]) + needed_pkgs="x11 " AC_ARG_ENABLE(debug, @@ -315,6 +330,9 @@ data/themes/Default/Makefile data/themes/PngSample/Makefile data/libmatchbox2.pc doc/Makefile +doc/reference/Makefile +doc/reference/matchbox2/Makefile +doc/reference/matchbox2/version.xml util/Makefile ]) @@ -326,6 +344,9 @@ echo " source code location: ${srcdir} install prefix : ${prefix} + Documentation: + Build API Reference : ${enable_gtk_doc} + Extension: Xfixes : ${have_xfixes} Xext : ${have_xext} diff --git a/doc/Makefile.am b/doc/Makefile.am index 622a0ac..1cba747 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -1,2 +1,7 @@ +if BUILD_GTK_DOC +SUBDIRS = reference +endif -EXTRA_DIST = MBWM-Overview.xml
\ No newline at end of file +DIST_SUBDIRS = reference + +EXTRA_DIST = MBWM-Overview.xml diff --git a/doc/reference/Makefile.am b/doc/reference/Makefile.am new file mode 100644 index 0000000..e8bc530 --- /dev/null +++ b/doc/reference/Makefile.am @@ -0,0 +1 @@ +SUBDIRS=matchbox2 diff --git a/doc/reference/matchbox2/Makefile.am b/doc/reference/matchbox2/Makefile.am new file mode 100644 index 0000000..952c6cd --- /dev/null +++ b/doc/reference/matchbox2/Makefile.am @@ -0,0 +1,91 @@ +## 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=matchbox2 + +# 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=../../../matchbox2 + +# 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="MATCHBOX2_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)/matchbox2/core/*.h \ + $(top_srcdir)/matchbox2/comp-mgr/*.h \ + $(top_srcdir)/matchbox2/client-types/*.h \ + $(top_srcdir)/matchbox2/theme-engines/*.h +CFILE_GLOB= + +# Header files to ignore when scanning. +# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h +IGNORE_HFILES=$(top_srcdir)/matchbox2/*-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@ +GTKDOC_LIBS=\ + @MBWM_LIBS@ \ + $(top_builddir)/matchbox2/libmatchbox2-@MBWM2_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/matchbox2/matchbox2-docs.sgml b/doc/reference/matchbox2/matchbox2-docs.sgml new file mode 100644 index 0000000..51933f7 --- /dev/null +++ b/doc/reference/matchbox2/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/matchbox2/matchbox2-sections.txt b/doc/reference/matchbox2/matchbox2-sections.txt new file mode 100644 index 0000000..eaa3e15 --- /dev/null +++ b/doc/reference/matchbox2/matchbox2-sections.txt @@ -0,0 +1,7 @@ +<SECTION> +<FILE>matchbox2</FILE> +mb_wm_new +mb_wm_init +</SECTION> + + diff --git a/doc/reference/matchbox2/version.xml.in b/doc/reference/matchbox2/version.xml.in new file mode 100644 index 0000000..557b997 --- /dev/null +++ b/doc/reference/matchbox2/version.xml.in @@ -0,0 +1 @@ +@MBWM2_VERSION@ diff --git a/matchbox2/core/mb-window-manager.h b/matchbox2/core/mb-window-manager.h index e82b931..4b73d35 100644 --- a/matchbox2/core/mb-window-manager.h +++ b/matchbox2/core/mb-window-manager.h @@ -130,6 +130,16 @@ struct MBWindowManagerClass void (*main) (MBWindowManager *wm); }; +/** + * SECTION:matchbox2 + * @short_description: Core functions for creating and manipulating a + * #MBWindowManager + * + * The core object of Matchbox2 is the #MBWindowManager object, which + * is the first thing you would instantiate when implementing a new + * window manager. + */ + MBWindowManager * mb_wm_new (int argc, char **argv); |