From ab0ea462f39d13d56f10ccefeae882cc001469e4 Mon Sep 17 00:00:00 2001 From: Matthew Barnes Date: Wed, 19 Nov 2008 23:54:02 +0000 Subject: Documentation improvements. svn path=/branches/kill-bonobo/; revision=36806 --- doc/reference/shell/eshell-docs.sgml | 10 +- doc/reference/shell/eshell-sections.txt | 31 +- doc/reference/shell/tmpl/e-shell-content.sgml | 276 ++++++++++++++++ doc/reference/shell/tmpl/e-shell-module.sgml | 9 + doc/reference/shell/tmpl/e-shell-sidebar.sgml | 54 ++++ doc/reference/shell/tmpl/e-shell-taskbar.sgml | 35 +++ doc/reference/shell/tmpl/e-shell-view.sgml | 19 ++ doc/reference/shell/tmpl/e-shell-window.sgml | 117 +++++++ doc/reference/shell/tmpl/e-shell.sgml | 36 +++ doc/reference/shell/tmpl/eshell-unused.sgml | 435 ++------------------------ doc/reference/shell/tmpl/shell-actions.sgml | 8 + 11 files changed, 623 insertions(+), 407 deletions(-) (limited to 'doc/reference') diff --git a/doc/reference/shell/eshell-docs.sgml b/doc/reference/shell/eshell-docs.sgml index 6baba61429..0e2c83cc77 100644 --- a/doc/reference/shell/eshell-docs.sgml +++ b/doc/reference/shell/eshell-docs.sgml @@ -5,9 +5,9 @@ Evolution Shell Reference Manual - for eshell [VERSION] The latest version of this documentation can be found on-line at - http://[SERVER]/eshell/. + http://mbarnes.fedorapeople.org/docs/eshell/. @@ -20,6 +20,7 @@ + @@ -30,6 +31,11 @@ + + Object Hierarchy + + + Index diff --git a/doc/reference/shell/eshell-sections.txt b/doc/reference/shell/eshell-sections.txt index 44daecdc46..9b77e535e7 100644 --- a/doc/reference/shell/eshell-sections.txt +++ b/doc/reference/shell/eshell-sections.txt @@ -3,12 +3,14 @@ EShell EShell EShellLineStatus -e_shell_new +e_shell_get_default e_shell_list_modules e_shell_get_canonical_name e_shell_get_module_by_name e_shell_get_module_by_scheme +e_shell_get_settings e_shell_create_window +e_shell_get_focused_window e_shell_handle_uri e_shell_send_receive e_shell_get_online_mode @@ -16,6 +18,7 @@ e_shell_set_online_mode e_shell_get_line_status e_shell_set_line_status e_shell_get_preferences_window +e_shell_event e_shell_is_busy e_shell_do_quit e_shell_quit @@ -40,6 +43,7 @@ e_shell_migrate_error_quirk EShellContent EShellContent e_shell_content_new +e_shell_content_check_state e_shell_content_get_shell_view e_shell_content_get_context e_shell_content_set_context @@ -94,6 +98,7 @@ e_shell_module_get_config_dir e_shell_module_get_data_dir e_shell_module_get_filename e_shell_module_get_shell +e_shell_module_get_shell_view_type e_shell_module_add_activity e_shell_module_is_busy e_shell_module_shutdown @@ -112,11 +117,31 @@ e_shell_module_get_type EShellModulePrivate +
+e-shell-settings +EShellSettings +EShellSettings +e_shell_settings_install_property +e_shell_settings_bind_to_gconf + +E_SHELL_SETTINGS +E_IS_SHELL_SETTINGS +E_TYPE_SHELL_SETTINGS +E_SHELL_SETTINGS_CLASS +E_IS_SHELL_SETTINGS_CLASS +E_SHELL_SETTINGS_GET_CLASS +EShellSettingsClass +e_shell_settings_get_type + +EShellSettingsPrivate +
+
e-shell-sidebar EShellSidebar EShellSidebar e_shell_sidebar_new +e_shell_sidebar_check_state e_shell_sidebar_get_shell_view e_shell_sidebar_get_primary_text e_shell_sidebar_set_primary_text @@ -195,6 +220,7 @@ e_shell_view_get_view_id e_shell_view_set_view_id e_shell_view_is_active e_shell_view_get_page_num +e_shell_view_set_page_num e_shell_view_get_size_group e_shell_view_get_shell_content e_shell_view_get_shell_sidebar @@ -203,6 +229,7 @@ e_shell_view_get_shell_window e_shell_view_get_shell_module e_shell_view_update_actions e_shell_view_show_popup_menu +e_shell_view_new_view_instance E_SHELL_VIEW E_IS_SHELL_VIEW @@ -222,6 +249,7 @@ EShellWindow e_shell_window_new e_shell_window_get_shell e_shell_window_get_shell_view +e_shell_window_get_shell_view_action e_shell_window_get_ui_manager e_shell_window_get_action e_shell_window_get_action_group @@ -281,6 +309,7 @@ E_SHELL_WINDOW_ACTION_SHOW_STATUSBAR E_SHELL_WINDOW_ACTION_SHOW_SWITCHER E_SHELL_WINDOW_ACTION_SHOW_TOOLBAR E_SHELL_WINDOW_ACTION_SUBMIT_BUG +E_SHELL_WINDOW_ACTION_SWITCHER_INITIAL E_SHELL_WINDOW_ACTION_SWITCHER_STYLE_BOTH E_SHELL_WINDOW_ACTION_SWITCHER_STYLE_ICONS E_SHELL_WINDOW_ACTION_SWITCHER_STYLE_TEXT diff --git a/doc/reference/shell/tmpl/e-shell-content.sgml b/doc/reference/shell/tmpl/e-shell-content.sgml index bb62b33070..cb09ae28e7 100644 --- a/doc/reference/shell/tmpl/e-shell-content.sgml +++ b/doc/reference/shell/tmpl/e-shell-content.sgml @@ -92,3 +92,279 @@ EShellContent @Returns: + + + + + +@shell_content: +@Returns: + + + + + + + +@shell_content: +@Returns: + + + + + + + +@shell_content: +@Returns: + + + + + + + +@shell_content: +@context: + + + + + + + +@shell_content: +@Returns: + + + + + + + +@shell_content: +@filter_action: + + + + + + + +@shell_content: +@Returns: + + + + + + + +@shell_content: +@filter_value: + + + + + + + +@shell_content: +@Returns: + + + + + + + +@shell_content: +@filter_visible: + + + + + + + +@shell_content: +@action_value: + + + + + + + +@shell_content: +@Returns: + + + + + + + +@shell_content: +@Returns: + + + + + + + +@shell_content: +@search_rule: + + + + + + + +@shell_content: +@Returns: + + + + + + + +@shell_content: +@search_text: + + + + + + + +@shell_content: +@Returns: + + + + + + + +@shell_content: +@search_value: + + + + + + + +@shell_content: +@Returns: + + + + + + + +@shell_content: +@search_visible: + + + + + + + +@shell_content: +@Returns: + + + + + + + +@shell_content: +@scope_action: + + + + + + + +@shell_content: +@Returns: + + + + + + + +@shell_content: +@scope_value: + + + + + + + +@shell_content: +@Returns: + + + + + + + +@shell_content: +@scope_visible: + + + + + + + +@shell_content: +@Returns: + + + + + + + +@shell_content: +@view_id: + + + + + + + +@shell_content: + + + + + + + +@shell_content: + + + + + + + +@shell_content: + + diff --git a/doc/reference/shell/tmpl/e-shell-module.sgml b/doc/reference/shell/tmpl/e-shell-module.sgml index 313a0aa989..883ae1a9af 100644 --- a/doc/reference/shell/tmpl/e-shell-module.sgml +++ b/doc/reference/shell/tmpl/e-shell-module.sgml @@ -110,6 +110,15 @@ EShellModule @Returns: + + + + + +@shell_module: +@Returns: + + diff --git a/doc/reference/shell/tmpl/e-shell-sidebar.sgml b/doc/reference/shell/tmpl/e-shell-sidebar.sgml index de7fd21433..6e3d22d620 100644 --- a/doc/reference/shell/tmpl/e-shell-sidebar.sgml +++ b/doc/reference/shell/tmpl/e-shell-sidebar.sgml @@ -47,3 +47,57 @@ EShellSidebar @Returns: + + + + + +@shell_sidebar: +@Returns: + + + + + + + +@shell_sidebar: +@Returns: + + + + + + + +@shell_sidebar: +@Returns: + + + + + + + +@shell_sidebar: +@primary_text: + + + + + + + +@shell_sidebar: +@Returns: + + + + + + + +@shell_sidebar: +@secondary_text: + + diff --git a/doc/reference/shell/tmpl/e-shell-taskbar.sgml b/doc/reference/shell/tmpl/e-shell-taskbar.sgml index ff99855e5e..6aa90f1c72 100644 --- a/doc/reference/shell/tmpl/e-shell-taskbar.sgml +++ b/doc/reference/shell/tmpl/e-shell-taskbar.sgml @@ -42,3 +42,38 @@ EShellTaskbar @Returns: + + + + + +@shell_taskbar: +@Returns: + + + + + + + +@shell_taskbar: +@Returns: + + + + + + + +@shell_taskbar: +@message: + + + + + + + +@shell_taskbar: + + diff --git a/doc/reference/shell/tmpl/e-shell-view.sgml b/doc/reference/shell/tmpl/e-shell-view.sgml index 60798be7e5..1ea1eb6118 100644 --- a/doc/reference/shell/tmpl/e-shell-view.sgml +++ b/doc/reference/shell/tmpl/e-shell-view.sgml @@ -168,6 +168,15 @@ EShellView @Returns: + + + + + +@shell_view: +@page_num: + + @@ -240,3 +249,13 @@ EShellView @event: + + + + + +@shell_view: +@instance_id: +@Returns: + + diff --git a/doc/reference/shell/tmpl/e-shell-window.sgml b/doc/reference/shell/tmpl/e-shell-window.sgml index 750f9cf529..48f51ef992 100644 --- a/doc/reference/shell/tmpl/e-shell-window.sgml +++ b/doc/reference/shell/tmpl/e-shell-window.sgml @@ -57,3 +57,120 @@ EShellWindow @Returns: + + + + + +@shell_window: +@view_name: +@Returns: + + + + + + + +@shell_window: +@view_name: +@Returns: + + + + + + + +@shell_window: +@Returns: + + + + + + + +@shell_window: +@action_name: +@Returns: + + + + + + + +@shell_window: +@group_name: +@Returns: + + + + + + + +@shell_window: +@widget_path: +@Returns: + + + + + + + +@shell_window: +@Returns: + + + + + + + +@shell_window: +@view_name: + + + + + + + +@shell_window: +@Returns: + + + + + + + +@shell_window: +@safe_mode: + + + + + + + +@shell_window: +@module_name: +@entries: +@n_entries: + + + + + + + +@shell_window: +@module_name: +@entries: +@n_entries: + + diff --git a/doc/reference/shell/tmpl/e-shell.sgml b/doc/reference/shell/tmpl/e-shell.sgml index 2b1b292778..f5e844dce5 100644 --- a/doc/reference/shell/tmpl/e-shell.sgml +++ b/doc/reference/shell/tmpl/e-shell.sgml @@ -84,6 +84,14 @@ EShell @E_SHELL_LINE_STATUS_OFFLINE: @E_SHELL_LINE_STATUS_FORCED_OFFLINE: + + + + + +@Returns: + + @@ -123,6 +131,15 @@ EShell @Returns: + + + + + +@shell: +@Returns: + + @@ -132,6 +149,15 @@ EShell @Returns: + + + + + +@shell: +@Returns: + + @@ -195,6 +221,16 @@ EShell @Returns: + + + + + +@shell: +@event_name: +@event_data: + + diff --git a/doc/reference/shell/tmpl/eshell-unused.sgml b/doc/reference/shell/tmpl/eshell-unused.sgml index 334903498f..3ed67b59d1 100644 --- a/doc/reference/shell/tmpl/eshell-unused.sgml +++ b/doc/reference/shell/tmpl/eshell-unused.sgml @@ -142,6 +142,30 @@ e-shell-constants e-shell-marshal + + + + + + + + + + + + + + + + + + + + + +Migration + + @@ -1697,243 +1721,6 @@ intelligent @revision: @Returns: - - - - - -@shell_content: -@action_value: - - - - - - -@shell_content: -@Returns: - - - - - - -@shell_content: -@Returns: - - - - - - -@shell_content: -@Returns: - - - - - - -@shell_content: -@Returns: - - - - - - -@shell_content: -@Returns: - - - - - - -@shell_content: -@Returns: - - - - - - -@shell_content: -@Returns: - - - - - - -@shell_content: -@Returns: - - - - - - -@shell_content: -@Returns: - - - - - - -@shell_content: -@Returns: - - - - - - -@shell_content: -@Returns: - - - - - - -@shell_content: -@Returns: - - - - - - -@shell_content: -@Returns: - - - - - - -@shell_content: -@Returns: - - - - - - -@shell_content: - - - - - - -@shell_content: - - - - - - -@shell_content: - - - - - - -@shell_content: -@context: - - - - - - -@shell_content: -@filter_action: - - - - - - -@shell_content: -@filter_value: - - - - - - -@shell_content: -@filter_visible: - - - - - - -@shell_content: -@scope_action: - - - - - - -@shell_content: -@scope_value: - - - - - - -@shell_content: -@scope_visible: - - - - - - -@shell_content: -@search_rule: - - - - - - -@shell_content: -@search_text: - - - - - - -@shell_content: -@search_value: - - - - - - -@shell_content: -@search_visible: - - - - - - -@shell_content: -@view_id: - @@ -1952,6 +1739,13 @@ intelligent + + + + + +@Returns: + @@ -1972,77 +1766,6 @@ intelligent @online: @Returns: - - - - - -@shell_sidebar: -@Returns: - - - - - - -@shell_sidebar: -@Returns: - - - - - - -@shell_sidebar: -@Returns: - - - - - - -@shell_sidebar: -@primary_text: - - - - - - -@shell_sidebar: -@secondary_text: - - - - - - -@shell_taskbar: -@Returns: - - - - - - -@shell_taskbar: -@Returns: - - - - - - -@shell_taskbar: -@message: - - - - - - -@shell_taskbar: - @@ -2051,102 +1774,6 @@ intelligent @shell: @Returns: - - - - - -@shell_window: -@action_name: -@Returns: - - - - - - -@shell_window: -@group_name: -@Returns: - - - - - - -@shell_window: -@Returns: - - - - - - -@shell_window: -@widget_path: -@Returns: - - - - - - -@shell_window: -@Returns: - - - - - - -@shell_window: -@view_name: -@Returns: - - - - - - -@shell_window: -@Returns: - - - - - - -@shell_window: -@module_name: -@entries: -@n_entries: - - - - - - -@shell_window: -@module_name: -@entries: -@n_entries: - - - - - - -@shell_window: -@view_name: - - - - - - -@shell_window: -@safe_mode: - diff --git a/doc/reference/shell/tmpl/shell-actions.sgml b/doc/reference/shell/tmpl/shell-actions.sgml index 170ca0e502..60001d61bb 100644 --- a/doc/reference/shell/tmpl/shell-actions.sgml +++ b/doc/reference/shell/tmpl/shell-actions.sgml @@ -225,6 +225,14 @@ Shell Actions @window: + + + + + +@window: + + -- cgit v1.2.3