[evolution/kill-bonobo] Fix up EShell API documentation.

[Matthew Barnes <mbarnes src gnome org>]

commit 624f48121f523101fe26c3d3a8b51a4eeda90990
Author: Matthew Barnes <mbarnes redhat com>
Date:   Tue Jun 30 20:05:07 2009 -0400

    Fix up EShell API documentation.

 doc/reference/shell/eshell-sections.txt        |    5 ++++
 doc/reference/shell/tmpl/e-shell-content.sgml  |   27 ++++++++++++++++++++++++
 doc/reference/shell/tmpl/e-shell-settings.sgml |    4 +-
 doc/reference/shell/tmpl/e-shell-view.sgml     |   17 +++++++++++++++
 shell/e-shell-migrate.c                        |    1 -
 shell/e-shell-settings.h                       |    4 +-
 shell/e-shell-sidebar.c                        |    2 +
 shell/e-shell-view.h                           |    1 +
 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 c635f1c..ef49359 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 0ddc175..2ffe528 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 1e1d245..edc6af5 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 15c6097..408e869 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 f18c846..18e085f 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 c400fac..c56df44 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 ad4cb92..7763e64 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 b323839..b9a12ab 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 0533b92..c647827 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)
 {