diff options
-rw-r--r-- | Makefile.am | 4 | ||||
-rw-r--r-- | TODO | 2 | ||||
-rwxr-xr-x | autogen.sh | 3 | ||||
-rw-r--r-- | configure.in.in | 9 | ||||
-rw-r--r-- | docs/Makefile.am | 21 | ||||
-rw-r--r-- | docs/reference/Makefile.am | 21 | ||||
-rw-r--r-- | docs/reference/tumbler/Makefile.am | 81 | ||||
-rw-r--r-- | docs/reference/tumbler/tumbler-docs.xml | 99 | ||||
-rw-r--r-- | docs/reference/tumbler/tumbler-sections.txt | 52 | ||||
-rw-r--r-- | docs/reference/tumbler/tumbler.types | 1 | ||||
-rw-r--r-- | docs/reference/tumbler/version.xml.in | 1 | ||||
-rw-r--r-- | tumbler/tumbler-config.c | 8 | ||||
-rw-r--r-- | tumbler/tumbler-enum-types.c | 8 | ||||
-rw-r--r-- | tumbler/tumbler-error.h | 6 | ||||
-rw-r--r-- | tumbler/tumbler-thumbnail.c | 9 |
15 files changed, 325 insertions, 0 deletions
diff --git a/Makefile.am b/Makefile.am index 7358be8..32e08f5 100644 --- a/Makefile.am +++ b/Makefile.am @@ -18,6 +18,10 @@ # Boston, MA 02110-1301, USA. SUBDIRS = \ + docs \ po \ tumbler \ tumblerd + +DISTCHECK_CONFIGURE_FLAGS = \ + --enable-gtk-doc @@ -8,4 +8,6 @@ Tumbler TODO List for more info. + - create thumbnails (and directories) with the correct chmod bits set. + - implement TumblerThresholdScheduler. @@ -48,4 +48,7 @@ sed -e "s/@LINGUAS@/${linguas}/g" \ -e "s/@REVISION@/${revision}/g" \ < "configure.in.in" > "configure.in" +# initialize GTK-Doc +gtkdocize || exit 1 + exec xdt-autogen $@ diff --git a/configure.in.in b/configure.in.in index cc3fd4b..43ba9b1 100644 --- a/configure.in.in +++ b/configure.in.in @@ -119,6 +119,11 @@ dnl *** Check for i18n support *** dnl ****************************** XDT_I18N([@LINGUAS@]) +dnl ************************* +dnl *** Check for GTK-Doc *** +dnl ************************* +GTK_DOC_CHECK(1.9) + dnl *********************************** dnl *** Check for required packages *** dnl *********************************** @@ -223,6 +228,10 @@ AM_CONDITIONAL([HAVE_GNUC_VISIBILITY], [test x"$have_gnuc_visibility" = x"yes"]) AC_OUTPUT([ Makefile +docs/Makefile +docs/reference/Makefile +docs/reference/tumbler/Makefile +docs/reference/tumbler/version.xml po/Makefile.in tumbler/Makefile tumbler/tumbler-config.h diff --git a/docs/Makefile.am b/docs/Makefile.am new file mode 100644 index 0000000..848babc --- /dev/null +++ b/docs/Makefile.am @@ -0,0 +1,21 @@ +# vi:set ts=8 sw=8 noet ai nocindent: +# - +# Copyright (c) 2009 Jannis Pohlmann <jannis@xfce.org> +# +# This program is free software; you can redistribute it and/or +# modify it under the terms of the GNU General Public License as +# published by the Free Software Foundation; either version 2 of +# the License, or (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public +# License along with this program; if not, write to the Free +# Software Foundation, Inc., 51 Franklin Street, Fifth Floor, +# Boston, MA 02110-1301, USA. + +SUBIDRS = \ + reference diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am new file mode 100644 index 0000000..f5eef03 --- /dev/null +++ b/docs/reference/Makefile.am @@ -0,0 +1,21 @@ +# vi:set ts=8 sw=8 noet ai nocindent: +# - +# Copyright (c) 2009 Jannis Pohlmann <jannis@xfce.org> +# +# This program is free software; you can redistribute it and/or +# modify it under the terms of the GNU General Public License as +# published by the Free Software Foundation; either version 2 of +# the License, or (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public +# License along with this program; if not, write to the Free +# Software Foundation, Inc., 51 Franklin Street, Fifth Floor, +# Boston, MA 02110-1301, USA. + +SUBIDRS = \ + tumbler diff --git a/docs/reference/tumbler/Makefile.am b/docs/reference/tumbler/Makefile.am new file mode 100644 index 0000000..cf6e1c1 --- /dev/null +++ b/docs/reference/tumbler/Makefile.am @@ -0,0 +1,81 @@ +# vi:set ts=8 sw=8 noet ai nocindent syntax=automake: +# - +# Copyright (c) 2009 Jannis Pohlmann <jannis@xfce.org> +# +# This program is free software; you can redistribute it and/or +# modify it under the terms of the GNU General Public License as +# published by the Free Software Foundation; either version 2 of +# the License, or (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public +# License along with this program; if not, write to the Free +# Software Foundation, Inc., 51 Franklin Street, Fifth Floor, +# Boston, MA 02110-1301, USA. +# + +AUTOMAKE_OPTIONS = 1.8 + +# Name of the module +DOC_MODULE=tumbler + +# Top-level SGML file +DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.xml + +SCAN_OPTIONS=--rebuild-sections + +# Extra options to pass to gtkdoc-scangobj +SCANGOBJ_OPTIONS= + +# Directory containing the source code +DOC_SOURCE_DIR=$(top_srcdir)/tumbler + +# 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)/tumbler/*.h +CFILE_GLOB=$(top_srcdir)/tumbler/*.c + +# Extra files to add when scanning (relative to $srcdir) +EXTRA_HFILES= + +# Images to copy into HTML directory +HTML_IMAGES = + +# Extra SGML files that are included by DOC_MAIN_SGML_FILE +content_files = \ + version.xml + +# CFLAGS and LDFLAGS for compiling scan program. Only needed +# if $(DOC_MODULE).types is non-empty. +INCLUDES = \ + -I$(top_srcdir) \ + -I$(top_builddir) \ + $(DBUS_CFLAGS) \ + $(DBUS_GLIB_CFLAGS) \ + $(GIO_CFLAGS) \ + $(GLIB_CFLAGS) \ + $(GTHREAD_CFLAGS) + +GTKDOC_LIBS = \ + $(DBUS_LIBS) \ + $(DBUS_GLIB_LIBS) \ + $(GIO_LIBS) \ + $(GLIB_LIBS) \ + $(GTHREAD_LIBS) \ + $(GLIB_LIBS) \ + $(top_srcdir)/tumbler/libtumbler-$(TUMBLER_VERSION_API).la + +include $(top_srcdir)/gtk-doc.make + +# Other files to distribute +EXTRA_DIST += \ + version.xml.in diff --git a/docs/reference/tumbler/tumbler-docs.xml b/docs/reference/tumbler/tumbler-docs.xml new file mode 100644 index 0000000..7dda9ab --- /dev/null +++ b/docs/reference/tumbler/tumbler-docs.xml @@ -0,0 +1,99 @@ +<?xml version="1.0"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" + "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" +[ + <!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'"> +]> + +<book id="index" lang="en"> + <bookinfo> + <title>tumbler Reference Manual</title> + <releaseinfo>Version <xi:include href="version.xml" parse="text"/></releaseinfo> + <copyright> + <year>2009</year> + <holder>Jannis Pohlmann</holder> + </copyright> + <legalnotice id="legalnotice"> + <para> + Permission is granted to copy, distribute and/or modify this document + under the terms of the GNU Free Documentation License, Version 1.1 or + any later version published by the Free Software Foundation; with no + Invariant Sections, with no Front-Cover Texts, and with no Back-Cover + Texts. The complete license text is available from the <ulink + type="http" url="http://www.gnu.org/">Free Software Foundation</ulink>. + </para> + </legalnotice> + <authorgroup> + <author> + <firstname>Jannis</firstname> + <surname>Pohlmann</surname> + <affiliation> + <address><email>jannis@xfce.org</email></address> + </affiliation> + </author> + </authorgroup> + </bookinfo> + + <part> + <title>Overview</title> + <para> + The <application>tumbler</application> library depends on the following libraries: + <variablelist> + <varlistentry> + <term>D-Bus</term> + <listitem> + <para> + TODO + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>D-Bus GLib Bindings</term> + <listitem> + <para> + TODO + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>GLib</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> + </variablelist> + </para> + </part> + + <part id="tumbler-utils"> + <title>Utility Functions</title> + <xi:include href="xml/tumbler-error.xml"/> + <xi:include href="xml/tumbler-thumbnail.xml"/> + <xi:include href="xml/tumbler-enum-types.xml"/> + </part> + + <part id="tumbler-miscellaneous"> + <title>Miscellaneous</title> + <xi:include href="xml/tumbler-config.xml"/> + </part> + + <part id="object-tree"> + <title>Object Hierarchy</title> + <xi:include href="xml/tree_index.sgml"/> + </part> + + <index id="api-index-full"> + <title>API Index</title> + <xi:include href="xml/api-index-full.xml"> + <xi:fallback /> + </xi:include> + </index> + + <xi:include href="xml/annotation-glossary.xml"> + <xi:fallback /> + </xi:include> +</book> diff --git a/docs/reference/tumbler/tumbler-sections.txt b/docs/reference/tumbler/tumbler-sections.txt new file mode 100644 index 0000000..4b639a1 --- /dev/null +++ b/docs/reference/tumbler/tumbler-sections.txt @@ -0,0 +1,52 @@ +<SECTION> +<FILE>tumbler-error</FILE> +TUMBLER_ERROR_DOMAIN +TUMBLER_ERROR +TumblerErrorEnum +</SECTION> + +<SECTION> +<FILE>tumbler-config</FILE> +TUMBLER_MAJOR_VERSION +TUMBLER_MINOR_VERSION +TUMBLER_MICRO_VERSION +TUMBLER_CHECK_VERSION +tumbler_major_version +tumbler_minor_version +tumbler_micro_version +tumbler_check_version +G_GNUC_NULL_TERMINATED +G_GNUC_WARN_UNUSED_RESULT +</SECTION> + +<SECTION> +<FILE>tumbler-marshal</FILE> +tumbler_marshal_VOID__STRING_INT_STRING +tumbler_marshal_VOID__UINT_POINTER_INT_STRING +</SECTION> + +<SECTION> +<FILE>tumbler-thumbnail</FILE> +tumbler_thumbnail_get_flavors +tumbler_thumbnail_flavor_get_size +tumbler_thumbnail_flavor_get_directory +tumbler_thumbnail_get_file +tumbler_thumbnail_create_and_open_file +</SECTION> + +<SECTION> +<FILE>tumbler-enum-types</FILE> +TUMBLER_TYPE_THUMBNAIL_FLAVOR +TumblerThumbnailFlavor +tumbler_thumbnail_flavor_get_type +</SECTION> + +<SECTION> +<FILE>tumbler</FILE> +TUMBLER_INSIDE_TUMBLER_H +</SECTION> + +<SECTION> +<FILE>stamp-tumbler-marshal</FILE> +</SECTION> + diff --git a/docs/reference/tumbler/tumbler.types b/docs/reference/tumbler/tumbler.types new file mode 100644 index 0000000..bad737b --- /dev/null +++ b/docs/reference/tumbler/tumbler.types @@ -0,0 +1 @@ +tumbler_thumbnail_flavor_get_type diff --git a/docs/reference/tumbler/version.xml.in b/docs/reference/tumbler/version.xml.in new file mode 100644 index 0000000..d78bda9 --- /dev/null +++ b/docs/reference/tumbler/version.xml.in @@ -0,0 +1 @@ +@VERSION@ diff --git a/tumbler/tumbler-config.c b/tumbler/tumbler-config.c index 3474364..bc52a11 100644 --- a/tumbler/tumbler-config.c +++ b/tumbler/tumbler-config.c @@ -26,6 +26,14 @@ +/** + * SECTION:tumbler-config + * @title: Version Information and Compatibility Checks + * @include: tumbler/tumbler.h + */ + + + const guint tumbler_major_version = TUMBLER_MAJOR_VERSION; const guint tumbler_minor_version = TUMBLER_MINOR_VERSION; const guint tumbler_micro_version = TUMBLER_MICRO_VERSION; diff --git a/tumbler/tumbler-enum-types.c b/tumbler/tumbler-enum-types.c index 34f020c..b950ff5 100644 --- a/tumbler/tumbler-enum-types.c +++ b/tumbler/tumbler-enum-types.c @@ -29,6 +29,14 @@ +/** + * SECTION:tumbler-enum-types + * @title: Various Enumeration Types + * @include: tumbler/tumbler.h + */ + + + GType tumbler_thumbnail_flavor_get_type (void) { diff --git a/tumbler/tumbler-error.h b/tumbler/tumbler-error.h index 11c77aa..1403dc6 100644 --- a/tumbler/tumbler-error.h +++ b/tumbler/tumbler-error.h @@ -29,6 +29,12 @@ G_BEGIN_DECLS +/** + * SECTION:tumbler-error + * @title:Error Domain and Types + * @include: tumbler/tumbler.h + */ + #define TUMBLER_ERROR_DOMAIN "Tumbler" #define TUMBLER_ERROR (g_quark_from_static_string (TUMBLER_ERROR_DOMAIN)) diff --git a/tumbler/tumbler-thumbnail.c b/tumbler/tumbler-thumbnail.c index 635512e..1742e0c 100644 --- a/tumbler/tumbler-thumbnail.c +++ b/tumbler/tumbler-thumbnail.c @@ -31,6 +31,15 @@ +/** + * SECTION:tumbler-thumbnail + * @title:Thumbnail Utility Functions + * @short_description: Utility functions for creating thumbnails + * @include: tumbler/tumbler.h + */ + + + TumblerThumbnailFlavor * tumbler_thumbnail_get_flavors (void) { |