diff options
author | Matthew Barnes <mbarnes@redhat.com> | 2009-07-01 08:05:07 +0800 |
---|---|---|
committer | Matthew Barnes <mbarnes@redhat.com> | 2009-07-01 08:05:07 +0800 |
commit | 624f48121f523101fe26c3d3a8b51a4eeda90990 (patch) | |
tree | 69ef64248fa291df664aea303852899af0211f77 | |
parent | bfc5ba2511dc5fd9f5aa9868946c8860afad81bf (diff) | |
download | gsoc2013-evolution-624f48121f523101fe26c3d3a8b51a4eeda90990.tar gsoc2013-evolution-624f48121f523101fe26c3d3a8b51a4eeda90990.tar.gz gsoc2013-evolution-624f48121f523101fe26c3d3a8b51a4eeda90990.tar.bz2 gsoc2013-evolution-624f48121f523101fe26c3d3a8b51a4eeda90990.tar.lz gsoc2013-evolution-624f48121f523101fe26c3d3a8b51a4eeda90990.tar.xz gsoc2013-evolution-624f48121f523101fe26c3d3a8b51a4eeda90990.tar.zst gsoc2013-evolution-624f48121f523101fe26c3d3a8b51a4eeda90990.zip |
Fix up EShell API documentation.
-rw-r--r-- | doc/reference/shell/eshell-sections.txt | 5 | ||||
-rw-r--r-- | doc/reference/shell/tmpl/e-shell-content.sgml | 27 | ||||
-rw-r--r-- | doc/reference/shell/tmpl/e-shell-settings.sgml | 4 | ||||
-rw-r--r-- | doc/reference/shell/tmpl/e-shell-view.sgml | 17 | ||||
-rw-r--r-- | shell/e-shell-migrate.c | 1 | ||||
-rw-r--r-- | shell/e-shell-settings.h | 4 | ||||
-rw-r--r-- | shell/e-shell-sidebar.c | 2 | ||||
-rw-r--r-- | shell/e-shell-view.h | 1 | ||||
-rw-r--r-- | shell/es-event.c | 3 |
9 files changed, 57 insertions, 7 deletions
diff --git a/doc/reference/shell/eshell-sections.txt b/doc/reference/shell/eshell-sections.txt index c635f1c6bc..ef49359e0e 100644 --- a/doc/reference/shell/eshell-sections.txt +++ b/doc/reference/shell/eshell-sections.txt @@ -82,6 +82,8 @@ e_shell_content_set_filter_visible e_shell_content_add_filter_separator_before e_shell_content_add_filter_separator_after e_shell_content_get_search_context +e_shell_content_get_search_hint +e_shell_content_set_search_hint e_shell_content_get_search_rule e_shell_content_set_search_rule e_shell_content_get_search_text @@ -99,6 +101,7 @@ e_shell_content_set_view_id e_shell_content_run_advanced_search_dialog e_shell_content_run_edit_searches_dialog e_shell_content_run_save_search_dialog +e_shell_content_restore_state <SUBSECTION Standard> E_SHELL_CONTENT E_IS_SHELL_CONTENT @@ -235,6 +238,8 @@ e_shell_view_get_shell_content e_shell_view_get_shell_sidebar e_shell_view_get_shell_taskbar e_shell_view_get_shell_window +e_shell_view_get_state_key_file +e_shell_view_set_state_dirty e_shell_view_update_actions e_shell_view_show_popup_menu e_shell_view_new_view_instance diff --git a/doc/reference/shell/tmpl/e-shell-content.sgml b/doc/reference/shell/tmpl/e-shell-content.sgml index 0ddc175d77..2ffe528e98 100644 --- a/doc/reference/shell/tmpl/e-shell-content.sgml +++ b/doc/reference/shell/tmpl/e-shell-content.sgml @@ -191,6 +191,24 @@ EShellContent @Returns: +<!-- ##### FUNCTION e_shell_content_get_search_hint ##### --> +<para> + +</para> + +@shell_content: +@Returns: + + +<!-- ##### FUNCTION e_shell_content_set_search_hint ##### --> +<para> + +</para> + +@shell_content: +@search_hint: + + <!-- ##### FUNCTION e_shell_content_get_search_rule ##### --> <para> @@ -341,3 +359,12 @@ EShellContent @shell_content: +<!-- ##### FUNCTION e_shell_content_restore_state ##### --> +<para> + +</para> + +@shell_content: +@group_name: + + diff --git a/doc/reference/shell/tmpl/e-shell-settings.sgml b/doc/reference/shell/tmpl/e-shell-settings.sgml index 1e1d2452e0..edc6af5b32 100644 --- a/doc/reference/shell/tmpl/e-shell-settings.sgml +++ b/doc/reference/shell/tmpl/e-shell-settings.sgml @@ -134,7 +134,7 @@ EShellSettings </para> -@shell_setting: +@shell_settings: @property_name: @Returns: @@ -144,7 +144,7 @@ EShellSettings </para> -@shell_setting: +@shell_settings: @property_name: @v_pointer: diff --git a/doc/reference/shell/tmpl/e-shell-view.sgml b/doc/reference/shell/tmpl/e-shell-view.sgml index 15c6097c4f..408e869528 100644 --- a/doc/reference/shell/tmpl/e-shell-view.sgml +++ b/doc/reference/shell/tmpl/e-shell-view.sgml @@ -237,6 +237,23 @@ EShellView @Returns: +<!-- ##### FUNCTION e_shell_view_get_state_key_file ##### --> +<para> + +</para> + +@shell_view: +@Returns: + + +<!-- ##### FUNCTION e_shell_view_set_state_dirty ##### --> +<para> + +</para> + +@shell_view: + + <!-- ##### FUNCTION e_shell_view_update_actions ##### --> <para> diff --git a/shell/e-shell-migrate.c b/shell/e-shell-migrate.c index f18c84685d..18e085f0cc 100644 --- a/shell/e-shell-migrate.c +++ b/shell/e-shell-migrate.c @@ -323,7 +323,6 @@ check_old: g_free (string); /** @Event: Shell attempted upgrade - * @Shell: an #EShell * @Id: upgrade.done * @Target: ESMenuTargetState * diff --git a/shell/e-shell-settings.h b/shell/e-shell-settings.h index c400facfd3..c56df44514 100644 --- a/shell/e-shell-settings.h +++ b/shell/e-shell-settings.h @@ -103,9 +103,9 @@ gpointer e_shell_settings_get_object (EShellSettings *shell_settings, void e_shell_settings_set_object (EShellSettings *shell_settings, const gchar *property_name, gpointer v_object); -gpointer e_shell_settings_get_pointer (EShellSettings *shell_setting, +gpointer e_shell_settings_get_pointer (EShellSettings *shell_settings, const gchar *property_name); -void e_shell_settings_set_pointer (EShellSettings *shell_setting, +void e_shell_settings_set_pointer (EShellSettings *shell_settings, const gchar *property_name, gpointer v_pointer); diff --git a/shell/e-shell-sidebar.c b/shell/e-shell-sidebar.c index ad4cb92970..7763e64918 100644 --- a/shell/e-shell-sidebar.c +++ b/shell/e-shell-sidebar.c @@ -551,6 +551,8 @@ e_shell_sidebar_get_icon_name (EShellSidebar *shell_sidebar) /** * e_shell_sidebar_set_icon_name: + * @shell_sidebar: an #EShellSidebar + * @icon_name: a themed icon name * * Sets the icon name displayed at the top of the sidebar. **/ diff --git a/shell/e-shell-view.h b/shell/e-shell-view.h index b323839478..b9a12ab893 100644 --- a/shell/e-shell-view.h +++ b/shell/e-shell-view.h @@ -101,6 +101,7 @@ struct _EShellView { * for subclasses, but subclasses are still responsible * for adding the appropriate #GalView factories to the * view collection. + * @shell_backend: The corresponding #EShellBackend for the shell view. * @new_shell_content: Factory method for the shell view's #EShellContent. * See e_shell_view_get_shell_content(). * @new_shell_sidebar: Factory method for the shell view's #EShellSidebar. diff --git a/shell/es-event.c b/shell/es-event.c index 0533b92fec..c647827586 100644 --- a/shell/es-event.c +++ b/shell/es-event.c @@ -91,11 +91,10 @@ es_event_get_type(void) /** * es_event_peek: - * @void: * * Get the singular instance of the shell event handler. * - * Return value: + * Return: the shell event handler **/ ESEvent *es_event_peek(void) { |