aboutsummaryrefslogtreecommitdiffstats
path: root/shell/e-shell.h
diff options
context:
space:
mode:
authorMatthew Barnes <mbarnes@src.gnome.org>2008-10-01 11:48:51 +0800
committerMatthew Barnes <mbarnes@src.gnome.org>2008-10-01 11:48:51 +0800
commitc6795be3a8b7b17ced9e99e17db9ac6cbed6e018 (patch)
tree9623c989150fd850c5ca9dc6cfb61f599efae573 /shell/e-shell.h
parentb639d1ed02e9788d98f2a202fc53105ff4bc4387 (diff)
downloadgsoc2013-evolution-c6795be3a8b7b17ced9e99e17db9ac6cbed6e018.tar
gsoc2013-evolution-c6795be3a8b7b17ced9e99e17db9ac6cbed6e018.tar.gz
gsoc2013-evolution-c6795be3a8b7b17ced9e99e17db9ac6cbed6e018.tar.bz2
gsoc2013-evolution-c6795be3a8b7b17ced9e99e17db9ac6cbed6e018.tar.lz
gsoc2013-evolution-c6795be3a8b7b17ced9e99e17db9ac6cbed6e018.tar.xz
gsoc2013-evolution-c6795be3a8b7b17ced9e99e17db9ac6cbed6e018.tar.zst
gsoc2013-evolution-c6795be3a8b7b17ced9e99e17db9ac6cbed6e018.zip
Continue documenting the new shell API.
svn path=/branches/kill-bonobo/; revision=36511
Diffstat (limited to 'shell/e-shell.h')
-rw-r--r--shell/e-shell.h12
1 files changed, 12 insertions, 0 deletions
diff --git a/shell/e-shell.h b/shell/e-shell.h
index 5b804b3f4a..544872a554 100644
--- a/shell/e-shell.h
+++ b/shell/e-shell.h
@@ -20,6 +20,12 @@
*
*/
+/**
+ * SECTION: e-shell
+ * @short_description: the backbone of Evolution
+ * @include: shell/e-shell.h
+ **/
+
#ifndef E_SHELL_H
#define E_SHELL_H
@@ -53,6 +59,12 @@ typedef struct _EShellPrivate EShellPrivate;
typedef enum _EShellLineStatus EShellLineStatus;
+/**
+ * EShell:
+ *
+ * Contains only private data that should be read and manipulated using the
+ * functions below.
+ **/
struct _EShell {
GObject parent;
EShellPrivate *priv;