summaryrefslogtreecommitdiff
path: root/libnautilus-extension
diff options
context:
space:
mode:
authorSven Herzberg <herzi@lanedo.com>2009-03-09 10:16:53 +0000
committerCosimo Cecchi <cosimoc@src.gnome.org>2009-03-09 10:16:53 +0000
commit72a49ea8cc842955745da1ff27979f54cd864ce2 (patch)
tree32ae5ac009d98647322e6b74308b0561dfa7cd60 /libnautilus-extension
parent998a06a6d7077fbd334d0d7249912248b586e4f1 (diff)
downloadnautilus-72a49ea8cc842955745da1ff27979f54cd864ce2.tar.gz
Bug 574546 – Document nautilus_property_page_provider_get_pages()
2009-03-08 Sven Herzberg <herzi@lanedo.com> Bug 574546 – Document nautilus_property_page_provider_get_pages() * libnautilus-extension/nautilus-property-page-provider.c: document the function * src/nautilus-image-properties-page.c, * src/nautilus-notes-viewer.c: drop the function documentation, it's in the API reference now svn path=/trunk/; revision=15070
Diffstat (limited to 'libnautilus-extension')
-rw-r--r--libnautilus-extension/nautilus-property-page-provider.c15
1 files changed, 14 insertions, 1 deletions
diff --git a/libnautilus-extension/nautilus-property-page-provider.c b/libnautilus-extension/nautilus-property-page-provider.c
index 8c08cc25b..eb07596fa 100644
--- a/libnautilus-extension/nautilus-property-page-provider.c
+++ b/libnautilus-extension/nautilus-property-page-provider.c
@@ -60,9 +60,22 @@ nautilus_property_page_provider_get_type (void)
return type;
}
+/**
+ * nautilus_property_page_provider_get_pages:
+ * @provider: a #NautilusPropertyPageProvider
+ * @files: a #GList of #NautilusFileInfo
+ *
+ * This function is called by Nautilus when it wants property page
+ * items from the extension.
+ *
+ * This function is called in the main thread before a property page
+ * is shown, so it should return quickly.
+ *
+ * Returns: A #GList of allocated #NautilusPropertyPage items.
+ */
GList *
nautilus_property_page_provider_get_pages (NautilusPropertyPageProvider *provider,
- GList *files)
+ GList *files)
{
g_return_val_if_fail (NAUTILUS_IS_PROPERTY_PAGE_PROVIDER (provider), NULL);
g_return_val_if_fail (NAUTILUS_PROPERTY_PAGE_PROVIDER_GET_IFACE (provider)->get_pages != NULL, NULL);