aboutsummaryrefslogtreecommitdiffstats
path: root/e-util/e-extension.h
diff options
context:
space:
mode:
authorMatthew Barnes <mbarnes@redhat.com>2010-03-22 02:33:38 +0800
committerMatthew Barnes <mbarnes@redhat.com>2010-03-22 03:49:30 +0800
commitecdb79111cdc6a38234655b668d81d1fed95ec30 (patch)
tree7c4c1d96a14f2e311d0b8df649d21ca780452882 /e-util/e-extension.h
parent11cd3fda1a54523ffa450b90f7ac859198d49fbe (diff)
downloadgsoc2013-evolution-ecdb79111cdc6a38234655b668d81d1fed95ec30.tar.gz
gsoc2013-evolution-ecdb79111cdc6a38234655b668d81d1fed95ec30.tar.zst
gsoc2013-evolution-ecdb79111cdc6a38234655b668d81d1fed95ec30.zip
Document EExtensible and EExtension.
The mechanism here is simple but hard to explain without leaning heavily on object-oriented jargon. Consider this a rough draft. Illustrations would certainly help clarify.
Diffstat (limited to 'e-util/e-extension.h')
-rw-r--r--e-util/e-extension.h6
1 files changed, 6 insertions, 0 deletions
diff --git a/e-util/e-extension.h b/e-util/e-extension.h
index 905ef412f3..e9eee64a62 100644
--- a/e-util/e-extension.h
+++ b/e-util/e-extension.h
@@ -47,6 +47,12 @@ typedef struct _EExtension EExtension;
typedef struct _EExtensionClass EExtensionClass;
typedef struct _EExtensionPrivate EExtensionPrivate;
+/**
+ * EExtension:
+ *
+ * Contains only private data that should be read and manipulated using the
+ * functions below.
+ **/
struct _EExtension {
GObject parent;
EExtensionPrivate *priv;