summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorErnestas Kulik <ernestask@gnome.org>2018-02-01 13:41:39 +0200
committerErnestas Kulik <ernestask@gnome.org>2018-02-09 06:32:38 +0200
commit7e2605c681d065e6b0a3d779c30b892932597991 (patch)
tree44bccc88603a7cc530a80de6349df69d3413a148 /docs
parent2128efccae664ba12a870deb1720a08e58954dd2 (diff)
downloadnautilus-7e2605c681d065e6b0a3d779c30b892932597991.tar.gz
general: refactor extension library
The changes include: * adding a single-include header and deprecating nautilus-extension-types.h and direct inclusions of individual headers; * type definition simplifications - this causes some breakages in nautilus-file, because NautilusFile used to be typedefed to NautilusFileInfo, and that is no longer possible, so the interface implementation was moved to static functions and the public NautilusFile API provides thin wrappers for them to maintain compatibility; * documentation cleanups and reorganization; * general build rule and code cleanups: mostly g_auto* sprinkled around and style changes (sorry)
Diffstat (limited to 'docs')
-rw-r--r--docs/reference/libnautilus-extension/libnautilus-extension-docs.xml17
-rw-r--r--docs/reference/libnautilus-extension/libnautilus-extension-sections.txt102
2 files changed, 26 insertions, 93 deletions
diff --git a/docs/reference/libnautilus-extension/libnautilus-extension-docs.xml b/docs/reference/libnautilus-extension/libnautilus-extension-docs.xml
index a5d8badbe..1c88c6339 100644
--- a/docs/reference/libnautilus-extension/libnautilus-extension-docs.xml
+++ b/docs/reference/libnautilus-extension/libnautilus-extension-docs.xml
@@ -15,18 +15,23 @@
<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-menu-item.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-column.xml" />
- <xi:include href="xml/nautilus-extension-types.xml" />
- <xi:include href="xml/nautilus-file-info.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-menu.xml" />
- <xi:include href="xml/nautilus-menu-item.xml" />
<xi:include href="xml/nautilus-property-page-provider.xml" />
- <xi:include href="xml/nautilus-property-page.xml" />
</chapter>
</part>
diff --git a/docs/reference/libnautilus-extension/libnautilus-extension-sections.txt b/docs/reference/libnautilus-extension/libnautilus-extension-sections.txt
index ea216d3fd..e7d9d7340 100644
--- a/docs/reference/libnautilus-extension/libnautilus-extension-sections.txt
+++ b/docs/reference/libnautilus-extension/libnautilus-extension-sections.txt
@@ -1,46 +1,34 @@
+<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
-NautilusLocationWidgetProviderIface
+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_type
-NAUTILUS_LOCATION_WIDGET_PROVIDER_GET_IFACE
</SECTION>
<SECTION>
<FILE>nautilus-menu-provider</FILE>
NautilusMenuProvider
-NautilusMenuProviderIface
+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_menu_provider_get_type
-NAUTILUS_MENU_PROVIDER_GET_IFACE
</SECTION>
<SECTION>
<FILE>nautilus-menu</FILE>
-NautilusMenuPrivate
NautilusMenu
nautilus_menu_new
nautilus_menu_append_item
nautilus_menu_get_items
-<SUBSECTION Standard>
-NAUTILUS_MENU
-NAUTILUS_IS_MENU
-NAUTILUS_TYPE_MENU
-nautilus_menu_get_type
-NAUTILUS_MENU_CLASS
-NAUTILUS_IS_MENU_CLASS
-NAUTILUS_MENU_GET_CLASS
</SECTION>
<SECTION>
@@ -51,40 +39,20 @@ nautilus_menu_item_get_type
nautilus_menu_item_new
nautilus_menu_item_activate
nautilus_menu_item_set_submenu
-<SUBSECTION Standard>
-NAUTILUS_TYPE_MENU_ITEM
-NAUTILUS_MENU_ITEM
-NAUTILUS_MENU_ITEM_CLASS
-NAUTILUS_MENU_IS_ITEM
-NAUTILUS_MENU_IS_ITEM_CLASS
-NAUTILUS_MENU_ITEM_GET_CLASS
-NautilusMenuItemDetails
</SECTION>
<SECTION>
<FILE>nautilus-column-provider</FILE>
NautilusColumnProvider
-NautilusColumnProviderIface
+NautilusColumnProviderInterface
nautilus_column_provider_get_columns
-<SUBSECTION Standard>
-NAUTILUS_COLUMN_PROVIDER
-NAUTILUS_IS_COLUMN_PROVIDER
-NAUTILUS_TYPE_COLUMN_PROVIDER
-nautilus_column_provider_get_type
-NAUTILUS_COLUMN_PROVIDER_GET_IFACE
</SECTION>
<SECTION>
<FILE>nautilus-property-page-provider</FILE>
NautilusPropertyPageProvider
-NautilusPropertyPageProviderIface
+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_type
-NAUTILUS_PROPERTY_PAGE_PROVIDER_GET_IFACE
</SECTION>
<SECTION>
@@ -92,7 +60,7 @@ NAUTILUS_PROPERTY_PAGE_PROVIDER_GET_IFACE
NAUTILUS_FILE_DEFINED
NautilusFile
NautilusFileInfo
-NautilusFileInfoIface
+NautilusFileInfoInterface
nautilus_file_info_create
nautilus_file_info_create_for_uri
nautilus_file_info_lookup
@@ -118,68 +86,28 @@ 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_type
-NAUTILUS_FILE_INFO_GET_IFACE
</SECTION>
<SECTION>
<FILE>nautilus-column</FILE>
NautilusColumn
nautilus_column_new
-<SUBSECTION Standard>
-NAUTILUS_COLUMN
-NAUTILUS_INFO_IS_COLUMN
-NAUTILUS_TYPE_COLUMN
-nautilus_column_get_type
-NAUTILUS_COLUMN_CLASS
-NAUTILUS_INFO_IS_COLUMN_CLASS
-NAUTILUS_COLUMN_GET_CLASS
-NautilusColumnDetails
</SECTION>
<SECTION>
<FILE>nautilus-info-provider</FILE>
NautilusInfoProvider
-NautilusInfoProviderIface
-NautilusInfoProviderUpdateComplete
+NautilusInfoProviderInterface
NautilusOperationHandle
NautilusOperationResult
nautilus_info_provider_update_file_info
nautilus_info_provider_cancel_update
nautilus_info_provider_update_complete_invoke
-<SUBSECTION Standard>
-NAUTILUS_TYPE_OPERATION_RESULT
-nautilus_operation_result_get_type
-NAUTILUS_INFO_PROVIDER
-NAUTILUS_IS_INFO_PROVIDER
-NAUTILUS_TYPE_INFO_PROVIDER
-nautilus_info_provider_get_type
-NAUTILUS_INFO_PROVIDER_GET_IFACE
</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_get_type
-NAUTILUS_PROPERTY_PAGE_CLASS
-NAUTILUS_IS_PROPERTY_PAGE_CLASS
-NAUTILUS_PROPERTY_PAGE_GET_CLASS
-NautilusPropertyPageDetails
-</SECTION>
-
-<SECTION>
-<FILE>nautilus-extension-types</FILE>
-nautilus_module_initialize
-nautilus_module_shutdown
-nautilus_module_list_types
</SECTION>