diff options
Diffstat (limited to 'docs/reference')
6 files changed, 267 insertions, 0 deletions
diff --git a/docs/reference/libnautilus-extension/libnautilus-extension-docs.xml b/docs/reference/libnautilus-extension/libnautilus-extension-docs.xml new file mode 100644 index 0000000..9ef66a2 --- /dev/null +++ b/docs/reference/libnautilus-extension/libnautilus-extension-docs.xml @@ -0,0 +1,42 @@ +<?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>Nautilus Extension Reference Manual</title> + <releaseinfo>For Nautilus-Extension &version;</releaseinfo> + + </bookinfo> + + <part> + <title>API Reference</title> + + <chapter> + <title>Core Classes</title> + <xi:include href="xml/nautilus-column.xml" /> + <xi:include href="xml/nautilus-file-info.xml" /> + <xi:include href="xml/nautilus-menu.xml" /> + <xi:include href="xml/nautilus-property-page.xml" /> + </chapter> + + <xi:include href="xml/nautilus-extension.xml" /> + + <chapter> + <title>Extension Interfaces</title> + <xi:include href="xml/nautilus-column-provider.xml" /> + <xi:include href="xml/nautilus-info-provider.xml" /> + <xi:include href="xml/nautilus-location-widget-provider.xml" /> + <xi:include href="xml/nautilus-menu-provider.xml" /> + <xi:include href="xml/nautilus-property-page-provider.xml" /> + </chapter> + + </part> + <index> + <title id="index-all">Index</title> + </index> + + <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include> +</book> diff --git a/docs/reference/libnautilus-extension/libnautilus-extension-overrides.txt b/docs/reference/libnautilus-extension/libnautilus-extension-overrides.txt new file mode 100644 index 0000000..e69de29 --- /dev/null +++ b/docs/reference/libnautilus-extension/libnautilus-extension-overrides.txt diff --git a/docs/reference/libnautilus-extension/libnautilus-extension-sections.txt b/docs/reference/libnautilus-extension/libnautilus-extension-sections.txt new file mode 100644 index 0000000..22e091b --- /dev/null +++ b/docs/reference/libnautilus-extension/libnautilus-extension-sections.txt @@ -0,0 +1,203 @@ +<INCLUDE>nautilus-extension.h</INCLUDE> + +<SECTION> +<FILE>nautilus-extension</FILE> +nautilus_module_initialize +nautilus_module_shutdown +nautilus_module_list_types +</SECTION> + +<SECTION> +<FILE>nautilus-location-widget-provider</FILE> +NautilusLocationWidgetProvider +NautilusLocationWidgetProviderInterface +nautilus_location_widget_provider_get_widget + +<SUBSECTION Standard> +NAUTILUS_LOCATION_WIDGET_PROVIDER +NAUTILUS_IS_LOCATION_WIDGET_PROVIDER +NAUTILUS_TYPE_LOCATION_WIDGET_PROVIDER +NAUTILUS_LOCATION_WIDGET_PROVIDER_GET_IFACE + +<SUBSECTION Private> +nautilus_location_widget_provider_get_type +</SECTION> + +<SECTION> +<FILE>nautilus-menu-provider</FILE> +NautilusMenuProvider +NautilusMenuProviderInterface +nautilus_menu_provider_get_file_items +nautilus_menu_provider_get_background_items +nautilus_menu_provider_emit_items_updated_signal + +<SUBSECTION Standard> +NAUTILUS_MENU_PROVIDER +NAUTILUS_IS_MENU_PROVIDER +NAUTILUS_TYPE_MENU_PROVIDER +NAUTILUS_PROVIDER_GET_IFACE + +<SUBSECTION Private> +nautilus_menu_provider_get_type +</SECTION> + +<SECTION> +<FILE>nautilus-menu</FILE> +NautilusMenu +NautilusMenuItem +nautilus_menu_new +nautilus_menu_append_item +nautilus_menu_get_items +nautilus_menu_item_list_free +nautilus_menu_item_new +nautilus_menu_item_activate +nautilus_menu_item_set_submenu + +<SUBSECTION Standard> +NAUTILUS_MENU +NAUTILUS_IS_MENU +NAUTILUS_TYPE_MENU +NAUTILUS_MENU_CLASS +NAUTILUS_IS_MENU_CLASS +NAUTILUS_MENU_GET_CLASS +NAUTILUS_MENU_ITEM +NAUTILUS_IS_MENU_ITEM +NAUTILUS_TYPE_MENU_ITEM +NAUTILUS_MENU_ITEM_CLASS +NAUTILUS_IS_MENU_ITEM_CLASS +NAUTILUS_MENU_ITEM_GET_CLASS + +<SUBSECTION Private> +nautilus_menu_get_type +nautilus_menu_item_get_type +</SECTION> + +<SECTION> +<FILE>nautilus-column-provider</FILE> +NautilusColumnProvider +NautilusColumnProviderInterface +nautilus_column_provider_get_columns + +<SUBSECTION Standard> +NAUTILUS_COLUMN_PROVIDER +NAUTILUS_IS_COLUMN_PROVIDER +NAUTILUS_TYPE_COLUMN_PROVIDER +NAUTILUS_COLUMN_PROVIDER_CLASS +NAUTILUS_IS_COLUMN_PROVIDER_CLASS +NAUTILUS_COLUMN_PROVIDER_GET_CLASS + +<SUBSECTION Private> +nautilus_column_provider_get_type +</SECTION> + +<SECTION> +<FILE>nautilus-property-page-provider</FILE> +NautilusPropertyPageProvider +NautilusPropertyPageProviderInterface +nautilus_property_page_provider_get_pages + +<SUBSECTION Standard> +NAUTILUS_PROPERTY_PAGE_PROVIDER +NAUTILUS_IS_PROPERTY_PAGE_PROVIDER +NAUTILUS_TYPE_PROPERTY_PAGE_PROVIDER +NAUTILUS_PROPERTY_PAGE_PROVIDER_GET_IFACE + +<SUBSECTION Private> +nautilus_property_page_provider_get_type +</SECTION> + +<SECTION> +<FILE>nautilus-file-info</FILE> +NautilusFile +NautilusFileInfo +NautilusFileInfoInterface +nautilus_file_info_create +nautilus_file_info_create_for_uri +nautilus_file_info_lookup +nautilus_file_info_lookup_for_uri +nautilus_file_info_list_copy +nautilus_file_info_list_free +nautilus_file_info_is_gone +nautilus_file_info_get_file_type +nautilus_file_info_get_location +nautilus_file_info_get_name +nautilus_file_info_get_uri +nautilus_file_info_get_activation_uri +nautilus_file_info_get_parent_location +nautilus_file_info_get_parent_uri +nautilus_file_info_get_mount +nautilus_file_info_get_uri_scheme +nautilus_file_info_get_parent_info +nautilus_file_info_get_mime_type +nautilus_file_info_is_mime_type +nautilus_file_info_is_directory +nautilus_file_info_can_write +nautilus_file_info_add_emblem +nautilus_file_info_get_string_attribute +nautilus_file_info_add_string_attribute +nautilus_file_info_invalidate_extension_info + +<SUBSECTION Standard> +NAUTILUS_FILE_INFO +NAUTILUS_IS_FILE_INFO +NAUTILUS_TYPE_FILE_INFO +NAUTILUS_FILE_INFO_GET_IFACE + +<SUBSECTION Private> +nautilus_file_info_get_type +</SECTION> + +<SECTION> +<FILE>nautilus-column</FILE> +NautilusColumn +nautilus_column_new + +<SUBSECTION Standard> +NAUTILUS_COLUMN +NAUTILUS_IS_COLUMN +NAUTILUS_TYPE_COLUMN +NAUTILUS_COLUMN_CLASS +NAUTILUS_IS_COLUMN_CLASS +NAUTILUS_COLUMN_GET_CLASS + +<SUBSECTION Private> +nautilus_column_get_type +</SECTION> + +<SECTION> +<FILE>nautilus-info-provider</FILE> +NautilusInfoProvider +NautilusInfoProviderInterface +NautilusOperationHandle +NautilusOperationResult +nautilus_info_provider_update_file_info +nautilus_info_provider_cancel_update +nautilus_info_provider_update_complete_invoke + +<SUBSECTION Standard> +NAUTILUS_INFO_PROVIDER +NAUTILUS_IS_INFO_PROVIDER +NAUTILUS_TYPE_INFO_PROVIDER +NAUTILUS_INFO_PROVIDER_GET_IFACE + +<SUBSECTION Private> +nautilus_info_provider_get_type +</SECTION> + +<SECTION> +<FILE>nautilus-property-page</FILE> +NautilusPropertyPage +nautilus_property_page_new + +<SUBSECTION Standard> +NAUTILUS_PROPERTY_PAGE +NAUTILUS_IS_PROPERTY_PAGE +NAUTILUS_TYPE_PROPERTY_PAGE +NAUTILUS_PROPERTY_PAGE_CLASS +NAUTILUS_IS_PROPERTY_PAGE_CLASS +NAUTILUS_PROPERTY_PAGE_GET_CLASS + +<SUBSECTION Private> +nautilus_property_page_get_type +</SECTION> + diff --git a/docs/reference/libnautilus-extension/meson.build b/docs/reference/libnautilus-extension/meson.build new file mode 100644 index 0000000..44e4484 --- /dev/null +++ b/docs/reference/libnautilus-extension/meson.build @@ -0,0 +1,20 @@ +docs_conf = configuration_data() +docs_conf.set('NAUTILUS_EXTENSION_VERSION_INFO', nautilus_extension_version) + +configure_file( + input: 'version.xml.in', + output: 'version.xml', + configuration: docs_conf +) + +gnome.gtkdoc( + 'libnautilus-extension', + main_xml: 'libnautilus-extension-docs.xml', + src_dir: join_paths(meson.source_root(), 'libnautilus-extension'), + dependencies: nautilus_extension, + install: true, + scan_args: [ + '--ignore-headers=nautilus-extension-private.h', + '--rebuild-types' + ], +) diff --git a/docs/reference/libnautilus-extension/version.xml.in b/docs/reference/libnautilus-extension/version.xml.in new file mode 100644 index 0000000..4ac8296 --- /dev/null +++ b/docs/reference/libnautilus-extension/version.xml.in @@ -0,0 +1 @@ +@NAUTILUS_EXTENSION_VERSION_INFO@ diff --git a/docs/reference/meson.build b/docs/reference/meson.build new file mode 100644 index 0000000..a352d26 --- /dev/null +++ b/docs/reference/meson.build @@ -0,0 +1 @@ +subdir('libnautilus-extension') |