aboutsummaryrefslogtreecommitdiffstats
path: root/shell
diff options
context:
space:
mode:
authorMatthew Barnes <mbarnes@redhat.com>2012-12-14 06:18:51 +0800
committerMatthew Barnes <mbarnes@redhat.com>2012-12-14 06:28:32 +0800
commit6b53dd8da13d35ce3e8130b25584371473927a4f (patch)
tree9c59d7e2aec1cb2d018c58d0329d6d690d96369d /shell
parent71c7a293ef624766a5eba11c402bec54e3b217dc (diff)
downloadgsoc2013-evolution-6b53dd8da13d35ce3e8130b25584371473927a4f.tar
gsoc2013-evolution-6b53dd8da13d35ce3e8130b25584371473927a4f.tar.gz
gsoc2013-evolution-6b53dd8da13d35ce3e8130b25584371473927a4f.tar.bz2
gsoc2013-evolution-6b53dd8da13d35ce3e8130b25584371473927a4f.tar.lz
gsoc2013-evolution-6b53dd8da13d35ce3e8130b25584371473927a4f.tar.xz
gsoc2013-evolution-6b53dd8da13d35ce3e8130b25584371473927a4f.tar.zst
gsoc2013-evolution-6b53dd8da13d35ce3e8130b25584371473927a4f.zip
libeshell documentation cleanups.
Diffstat (limited to 'shell')
-rw-r--r--shell/e-shell-backend.c5
-rw-r--r--shell/e-shell-migrate.c4
-rw-r--r--shell/e-shell-switcher.h2
-rw-r--r--shell/e-shell-utils.c5
-rw-r--r--shell/e-shell-view.c7
-rw-r--r--shell/e-shell-view.h10
-rw-r--r--shell/e-shell.h1
-rw-r--r--shell/es-event.c6
8 files changed, 28 insertions, 12 deletions
diff --git a/shell/e-shell-backend.c b/shell/e-shell-backend.c
index d546bc7c1b..f4aed9b28b 100644
--- a/shell/e-shell-backend.c
+++ b/shell/e-shell-backend.c
@@ -609,8 +609,9 @@ e_shell_backend_start (EShellBackend *shell_backend)
* e_shell_backend_is_started:
* @shell_backend: an #EShellBackend
*
- * Returns whether was shelll_backend already started, by
- * calling e_shell_backend_start().
+ * Returns whether e_shell_backend_start() was called for @shell_backend.
+ *
+ * Returns: whether @shell_backend is started
**/
gboolean
e_shell_backend_is_started (EShellBackend *shell_backend)
diff --git a/shell/e-shell-migrate.c b/shell/e-shell-migrate.c
index 22552daeba..b36cfc06fe 100644
--- a/shell/e-shell-migrate.c
+++ b/shell/e-shell-migrate.c
@@ -882,13 +882,13 @@ e_shell_migrate_attempt (EShell *shell)
shell, "event::ready-to-start",
G_CALLBACK (shell_migrate_ready_to_start_event_cb), NULL);
- /** @Event: Shell attempted upgrade
+ /* @Event: Shell attempted upgrade
* @Id: upgrade.done
* @Target: ESMenuTargetState
*
* This event is emitted whenever the shell successfully attempts
* an upgrade.
- **/
+ */
ese = es_event_peek ();
e_event_emit (
(EEvent *) ese, "upgrade.done",
diff --git a/shell/e-shell-switcher.h b/shell/e-shell-switcher.h
index b18546d58f..70b321309e 100644
--- a/shell/e-shell-switcher.h
+++ b/shell/e-shell-switcher.h
@@ -22,7 +22,7 @@
#ifndef E_SHELL_SWITCHER_H
#define E_SHELL_SWITCHER_H
-#include <e-shell-common.h>
+#include <shell/e-shell-common.h>
/* Standard GObject macros */
#define E_TYPE_SHELL_SWITCHER \
diff --git a/shell/e-shell-utils.c b/shell/e-shell-utils.c
index e790d5811a..1bdc82913d 100644
--- a/shell/e-shell-utils.c
+++ b/shell/e-shell-utils.c
@@ -285,11 +285,12 @@ e_shell_utils_import_uris (EShell *shell,
* e_shell_hide_widgets_for_express_mode:
* @shell: an #EShell
* @builder: a #GtkBuilder
- * @widget_name: NULL-terminated list of strings
+ * @widget_name: first widget name to hide
+ * @...: %NULL-terminated list of additional widget names to hide
*
* If Evolution is running in Express mode (i.e. if the specified @shell is
* in Express mode), then this function will hide a list of widgets, based
- * on their specified names. The list of names must be NULL-terminated,
+ * on their specified names. The list of names must be %NULL-terminated,
* and each element of that list must be the name of a widget present in
* @builder. Those widgets will then get hidden.
*
diff --git a/shell/e-shell-view.c b/shell/e-shell-view.c
index e6626666b3..9b3aa4a0f1 100644
--- a/shell/e-shell-view.c
+++ b/shell/e-shell-view.c
@@ -1401,6 +1401,8 @@ e_shell_view_get_search_rule (EShellView *shell_view)
* @shell_view: an #EShellView
*
* Returns the searchbar widget for @shell_view.
+ *
+ * Returns: the searchbar widget for @shell_view
**/
GtkWidget *
e_shell_view_get_searchbar (EShellView *shell_view)
@@ -1688,7 +1690,10 @@ e_shell_view_unblock_execute_search (EShellView *shell_view)
* e_shell_view_is_execute_search_blocked:
* @shell_view: an #EShellView
*
- * Returns whether e_shell_view_execute_search() is blocked.
+ * Returns whether e_shell_view_execute_search() is blocked as a result
+ * of previous e_shell_view_block_execute_search() calls.
+ *
+ * Returns: %TRUE if e_shell_view_execute_search() is blocked
**/
gboolean
e_shell_view_is_execute_search_blocked (EShellView *shell_view)
diff --git a/shell/e-shell-view.h b/shell/e-shell-view.h
index 6aea66f536..65c32b2982 100644
--- a/shell/e-shell-view.h
+++ b/shell/e-shell-view.h
@@ -108,6 +108,16 @@ struct _EShellView {
* See e_shell_view_get_shell_sidebar().
* @new_shell_taskbar: Factory method for the shell view's #EShellTaskbar.
* See e_shell_view_get_shell_taskbar().
+ * @new_shell_searchbar:
+ * Factory method for the shell view's #EShellSearchbar.
+ * See e_shell_view_get_searchbar().
+ * @construct_searchbar:
+ * Class method to create, configure and pack a search
+ * bar widget. The search bar differs in normal shell
+ * mode versus "express" mode.
+ * @get_search_name: Class method to obtain a suitable name for the
+ * current search criteria. Subclasses should rarely
+ * need to override the default behavior.
* @toggled: Class method for the #EShellView::toggled signal.
* Subclasses should rarely need to override the
* default behavior.
diff --git a/shell/e-shell.h b/shell/e-shell.h
index 84bb9f2d5c..a0ef1f6bae 100644
--- a/shell/e-shell.h
+++ b/shell/e-shell.h
@@ -57,7 +57,6 @@ typedef struct _EShellPrivate EShellPrivate;
/**
* EShellQuitReason:
- *
* @E_SHELL_QUIT_ACTION:
* @E_SHELL_WINDOW_ACTION_QUIT was activated.
* @E_SHELL_QUIT_LAST_WINDOW:
diff --git a/shell/es-event.c b/shell/es-event.c
index 4dc3a5ad25..2fdf432ba0 100644
--- a/shell/es-event.c
+++ b/shell/es-event.c
@@ -56,7 +56,7 @@ es_event_peek (void)
{
if (es_event == NULL) {
es_event = g_object_new (es_event_get_type (), NULL);
- /** @HookPoint: Shell Events Hookpoint
+ /* @HookPoint: Shell Events Hookpoint
* Id: org.gnome.evolution.shell.events
*
* This is the hook point which emits shell events.
@@ -100,12 +100,12 @@ es_event_hook_class_init (ESEventHookClass *class)
EEventHookClass *event_hook_class;
gint i;
- /** @HookClass: Shell Main Menu
+ /* @HookClass: Shell Main Menu
* @Id: org.gnome.evolution.shell.events:1.0
* @Target: ESEventTargetState
*
* A hook for events coming from the shell.
- **/
+ */
plugin_hook_class = E_PLUGIN_HOOK_CLASS (class);
plugin_hook_class->id = "org.gnome.evolution.shell.events:1.0";