diff options
author | Cosimo Cecchi <cosimoc@gnome.org> | 2015-05-25 20:33:13 -0700 |
---|---|---|
committer | Cosimo Cecchi <cosimoc@gnome.org> | 2015-05-25 20:41:19 -0700 |
commit | ff5a48d13343eccc5d8fb2772aa8b83afdeb0f3a (patch) | |
tree | 7faae561dbd14a323d88f7b9620b9e877df4b535 /docs | |
parent | 545a7660fa7758f506e9aef198fe6786a84b982a (diff) | |
download | nautilus-ff5a48d13343eccc5d8fb2772aa8b83afdeb0f3a.tar.gz |
libnautilus-extension: add gtk-doc documentation coverage
A lot of the library was poorly documented. Make sure the output of the
documentation looks okay.
Diffstat (limited to 'docs')
3 files changed, 26 insertions, 29 deletions
diff --git a/docs/reference/libnautilus-extension/Makefile.am b/docs/reference/libnautilus-extension/Makefile.am index 56e3670fa..1e0dc0980 100644 --- a/docs/reference/libnautilus-extension/Makefile.am +++ b/docs/reference/libnautilus-extension/Makefile.am @@ -34,7 +34,7 @@ CFILE_GLOB=$(top_srcdir)/libnautilus-extension/*.c # Header files to ignore when scanning. IGNORE_HFILES = \ - config.h \ + nautilus-extension-private.h \ $(NULL) # Images to copy into HTML directory diff --git a/docs/reference/libnautilus-extension/libnautilus-extension-docs.xml b/docs/reference/libnautilus-extension/libnautilus-extension-docs.xml index ae0a919c4..a5d8badbe 100644 --- a/docs/reference/libnautilus-extension/libnautilus-extension-docs.xml +++ b/docs/reference/libnautilus-extension/libnautilus-extension-docs.xml @@ -24,6 +24,7 @@ <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> diff --git a/docs/reference/libnautilus-extension/libnautilus-extension-sections.txt b/docs/reference/libnautilus-extension/libnautilus-extension-sections.txt index 55ce83311..ea216d3fd 100644 --- a/docs/reference/libnautilus-extension/libnautilus-extension-sections.txt +++ b/docs/reference/libnautilus-extension/libnautilus-extension-sections.txt @@ -28,26 +28,11 @@ NAUTILUS_MENU_PROVIDER_GET_IFACE <SECTION> <FILE>nautilus-menu</FILE> -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 NautilusMenuPrivate -NautilusMenuItemDetails -<TITLE>NautilusMenu</TITLE> NautilusMenu -<TITLE>NautilusMenuItem</TITLE> -NautilusMenuItem nautilus_menu_new nautilus_menu_append_item nautilus_menu_get_items -nautilus_menu_item_list_free -nautilus_menu_item_get_type -nautilus_menu_item_new -nautilus_menu_item_activate -nautilus_menu_item_set_submenu <SUBSECTION Standard> NAUTILUS_MENU NAUTILUS_IS_MENU @@ -59,6 +44,24 @@ NAUTILUS_MENU_GET_CLASS </SECTION> <SECTION> +<FILE>nautilus-menu-item</FILE> +NautilusMenuItem +nautilus_menu_item_list_free +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 @@ -92,7 +95,6 @@ NautilusFileInfo NautilusFileInfoIface nautilus_file_info_create nautilus_file_info_create_for_uri -nautilus_file_info_getter nautilus_file_info_lookup nautilus_file_info_lookup_for_uri nautilus_file_info_list_copy @@ -126,8 +128,6 @@ NAUTILUS_FILE_INFO_GET_IFACE <SECTION> <FILE>nautilus-column</FILE> -NautilusColumnDetails -<TITLE>NautilusColumn</TITLE> NautilusColumn nautilus_column_new <SUBSECTION Standard> @@ -138,6 +138,7 @@ nautilus_column_get_type NAUTILUS_COLUMN_CLASS NAUTILUS_INFO_IS_COLUMN_CLASS NAUTILUS_COLUMN_GET_CLASS +NautilusColumnDetails </SECTION> <SECTION> @@ -145,10 +146,14 @@ NAUTILUS_COLUMN_GET_CLASS NautilusInfoProvider NautilusInfoProviderIface NautilusInfoProviderUpdateComplete +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 @@ -158,8 +163,6 @@ NAUTILUS_INFO_PROVIDER_GET_IFACE <SECTION> <FILE>nautilus-property-page</FILE> -NautilusPropertyPageDetails -<TITLE>NautilusPropertyPage</TITLE> NautilusPropertyPage nautilus_property_page_new <SUBSECTION Standard> @@ -170,20 +173,13 @@ 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_TYPE_OPERATION_RESULT -NautilusOperationHandle -NautilusOperationResult -nautilus_operation_result_get_type nautilus_module_initialize nautilus_module_shutdown nautilus_module_list_types </SECTION> -<SECTION> -<FILE>nautilus-menu-item</FILE> -</SECTION> - |