diff options
author | Jannis Pohlmann <jannis@xfce.org> | 2009-06-08 21:05:33 +0200 |
---|---|---|
committer | Jannis Pohlmann <jannis@xfce.org> | 2009-06-08 21:05:33 +0200 |
commit | 6c3eaab253abd6d1bdab7fe2efd83489897d0c54 (patch) | |
tree | 84e29b2b062fdc4003d38bf6bb23349971c64a1a /docs | |
parent | 9d5f1b7b03bd0ad50365fa8186a0d9bce690f31d (diff) | |
download | tumbler-6c3eaab253abd6d1bdab7fe2efd83489897d0c54.tar.gz |
Update API docs a little bit.
Diffstat (limited to 'docs')
-rw-r--r-- | docs/reference/tumbler/tumbler-docs.xml | 27 | ||||
-rw-r--r-- | docs/reference/tumbler/tumbler-sections.txt | 179 | ||||
-rw-r--r-- | docs/reference/tumbler/tumbler.types | 10 |
3 files changed, 193 insertions, 23 deletions
diff --git a/docs/reference/tumbler/tumbler-docs.xml b/docs/reference/tumbler/tumbler-docs.xml index 7dda9ab..6ab89c2 100644 --- a/docs/reference/tumbler/tumbler-docs.xml +++ b/docs/reference/tumbler/tumbler-docs.xml @@ -69,16 +69,31 @@ </para> </part> - <part id="tumbler-utils"> - <title>Utility Functions</title> + <part id="miscellaneous"> + <title>Miscellaneous</title> <xi:include href="xml/tumbler-error.xml"/> - <xi:include href="xml/tumbler-thumbnail.xml"/> <xi:include href="xml/tumbler-enum-types.xml"/> + <xi:include href="xml/tumbler-config.xml"/> </part> - <part id="tumbler-miscellaneous"> - <title>Miscellaneous</title> - <xi:include href="xml/tumbler-config.xml"/> + <part id="thumbnails"> + <title>Querying and Generating Thumbnails</title> + <xi:include href="xml/tumbler-file-info.xml"/> + <xi:include href="xml/tumbler-thumbnail.xml"/> + <xi:include href="xml/tumbler-cache.xml"/> + </part> + + <part id="extension-api"> + <title>Extension API</title> + <xi:include href="xml/tumbler-provider-factory.xml"/> + <xi:include href="xml/tumbler-provider-plugin.xml"/> + <xi:include href="xml/tumbler-abstract-thumbnailer.xml"/> + <xi:include href="xml/tumbler-cache-provider.xml"/> + <xi:include href="xml/tumbler-thumbnailer-provider.xml"/> + </part> + + <part id="extension-tutorial"> + <title>Tutorial: Extending Tumbler</title> </part> <part id="object-tree"> diff --git a/docs/reference/tumbler/tumbler-sections.txt b/docs/reference/tumbler/tumbler-sections.txt index 4b639a1..ce8828f 100644 --- a/docs/reference/tumbler/tumbler-sections.txt +++ b/docs/reference/tumbler/tumbler-sections.txt @@ -1,8 +1,147 @@ <SECTION> -<FILE>tumbler-error</FILE> -TUMBLER_ERROR_DOMAIN -TUMBLER_ERROR -TumblerErrorEnum +<FILE>tumbler-thumbnailer</FILE> +TumblerThumbnailer +TumblerThumbnailerIface +tumbler_thumbnailer_create +tumbler_thumbnailer_get_hash_keys +tumbler_thumbnailer_get_mime_types +tumbler_thumbnailer_get_uri_schemes +tumbler_thumbnailer_array_copy +tumbler_thumbnailer_array_free +<SUBSECTION Standard> +TUMBLER_THUMBNAILER +TUMBLER_IS_THUMBNAILER +TUMBLER_TYPE_THUMBNAILER +tumbler_thumbnailer_get_type +TUMBLER_THUMBNAILER_GET_IFACE +</SECTION> + +<SECTION> +<FILE>tumbler-thumbnailer-provider</FILE> +TumblerThumbnailerProvider +TumblerThumbnailerProviderIface +tumbler_thumbnailer_provider_get_thumbnailers +<SUBSECTION Standard> +TUMBLER_THUMBNAILER_PROVIDER +TUMBLER_IS_THUMBNAILER_PROVIDER +TUMBLER_TYPE_THUMBNAILER_PROVIDER +tumbler_thumbnailer_provider_get_type +TUMBLER_THUMBNAILER_PROVIDER_GET_IFACE +</SECTION> + +<SECTION> +<FILE>tumbler-thumbnail</FILE> +TumblerThumbnail +TumblerThumbnailIface +tumbler_thumbnail_load +tumbler_thumbnail_needs_update +tumbler_thumbnail_save_pixbuf +tumbler_thumbnail_get_cache +tumbler_thumbnail_get_flavor +tumbler_thumbnail_get_flavors +tumbler_thumbnail_flavor_get_size +<SUBSECTION Standard> +TUMBLER_THUMBNAIL +TUMBLER_IS_THUMBNAIL +TUMBLER_TYPE_THUMBNAIL +tumbler_thumbnail_get_type +TUMBLER_THUMBNAIL_GET_IFACE +</SECTION> + +<SECTION> +<FILE>tumbler-provider-plugin</FILE> +TumblerProviderPluginPrivate +TumblerProviderPluginClass +TumblerProviderPlugin +tumbler_provider_plugin_new +tumbler_provider_plugin_get_types +<SUBSECTION Standard> +TUMBLER_PROVIDER_PLUGIN +TUMBLER_IS_PROVIDER_PLUGIN +TUMBLER_TYPE_PROVIDER_PLUGIN +tumbler_provider_plugin_get_type +TUMBLER_PROVIDER_PLUGIN_CLASS +TUMBLER_IS_PROVIDER_PLUGIN_CLASS +TUMBLER_PROVIDER_PLUGIN_GET_CLASS +</SECTION> + +<SECTION> +<FILE>tumbler-provider-factory</FILE> +TumblerProviderFactoryPrivate +TumblerProviderFactoryClass +TumblerProviderFactory +tumbler_provider_factory_get_default +tumbler_provider_factory_get_providers +<SUBSECTION Standard> +TUMBLER_PROVIDER_FACTORY +TUMBLER_IS_PROVIDER_FACTORY +TUMBLER_TYPE_PROVIDER_FACTORY +tumbler_provider_factory_get_type +TUMBLER_PROVIDER_FACTORY_CLASS +TUMBLER_IS_PROVIDER_FACTORY_CLASS +TUMBLER_PROVIDER_FACTORY_GET_CLASS +</SECTION> + +<SECTION> +<FILE>tumbler-file-info</FILE> +TumblerFileInfoPrivate +TumblerFileInfoClass +TumblerFileInfo +tumbler_file_info_new +tumbler_file_info_load +tumbler_file_info_get_uri +tumbler_file_info_get_mtime +tumbler_file_info_needs_update +tumbler_file_info_get_thumbnails +<SUBSECTION Standard> +TUMBLER_FILE_INFO +TUMBLER_IS_FILE_INFO +TUMBLER_TYPE_FILE_INFO +tumbler_file_info_get_type +TUMBLER_FILE_INFO_CLASS +TUMBLER_IS_FILE_INFO_CLASS +TUMBLER_FILE_INFO_GET_CLASS +</SECTION> + +<SECTION> +<FILE>tumbler-cache</FILE> +TumblerCache +TumblerCacheIface +tumbler_cache_get_thumbnails +<SUBSECTION Standard> +TUMBLER_CACHE +TUMBLER_IS_CACHE +TUMBLER_TYPE_CACHE +tumbler_cache_get_type +TUMBLER_CACHE_GET_IFACE +</SECTION> + +<SECTION> +<FILE>tumbler-cache-provider</FILE> +TumblerCacheProvider +TumblerCacheProviderIface +tumbler_cache_provider_get_caches +<SUBSECTION Standard> +TUMBLER_CACHE_PROVIDER +TUMBLER_IS_CACHE_PROVIDER +TUMBLER_TYPE_CACHE_PROVIDER +tumbler_cache_provider_get_type +TUMBLER_CACHE_PROVIDER_GET_IFACE +</SECTION> + +<SECTION> +<FILE>tumbler-abstract-thumbnailer</FILE> +TumblerAbstractThumbnailerPrivate +<TITLE>TumblerAbstractThumbnailer</TITLE> +TumblerAbstractThumbnailer +<SUBSECTION Standard> +TUMBLER_ABSTRACT_THUMBNAILER +TUMBLER_IS_ABSTRACT_THUMBNAILER +TUMBLER_TYPE_ABSTRACT_THUMBNAILER +tumbler_abstract_thumbnailer_get_type +TUMBLER_ABSTRACT_THUMBNAILER_CLASS +TUMBLER_IS_ABSTRACT_THUMBNAILER_CLASS +TUMBLER_ABSTRACT_THUMBNAILER_GET_CLASS </SECTION> <SECTION> @@ -20,33 +159,39 @@ G_GNUC_WARN_UNUSED_RESULT </SECTION> <SECTION> +<FILE>stamp-tumbler-marshal</FILE> +</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 +<FILE>tumbler</FILE> +TUMBLER_INSIDE_TUMBLER_H </SECTION> <SECTION> -<FILE>tumbler-enum-types</FILE> -TUMBLER_TYPE_THUMBNAIL_FLAVOR -TumblerThumbnailFlavor -tumbler_thumbnail_flavor_get_type +<FILE>tumbler-glib-extensions</FILE> +TUMBLER_ADD_INTERFACE </SECTION> <SECTION> -<FILE>tumbler</FILE> -TUMBLER_INSIDE_TUMBLER_H +<FILE>tumbler-error</FILE> +TUMBLER_ERROR_DOMAIN +TUMBLER_ERROR +TumblerErrorEnum </SECTION> <SECTION> -<FILE>stamp-tumbler-marshal</FILE> +<FILE>tumbler-enum-types</FILE> +TUMBLER_TYPE_THUMBNAIL_FLAVOR +TumblerThumbnailFlavor +tumbler_thumbnail_flavor_get_type +TUMBLER_TYPE_THUMBNAIL_FORMAT +TumblerThumbnailFormat +tumbler_thumbnail_format_get_type </SECTION> diff --git a/docs/reference/tumbler/tumbler.types b/docs/reference/tumbler/tumbler.types index bad737b..2eac2f0 100644 --- a/docs/reference/tumbler/tumbler.types +++ b/docs/reference/tumbler/tumbler.types @@ -1 +1,11 @@ +tumbler_thumbnailer_get_type +tumbler_thumbnailer_provider_get_type +tumbler_thumbnail_get_type +tumbler_provider_plugin_get_type +tumbler_provider_factory_get_type +tumbler_file_info_get_type tumbler_thumbnail_flavor_get_type +tumbler_thumbnail_format_get_type +tumbler_cache_get_type +tumbler_cache_provider_get_type +tumbler_abstract_thumbnailer_get_type |