First pass at trying to create some function documentation for Indicator

1 files changed, 8 insertions, 0 deletions

diff --git a/libindicate/indicator.h b/libindicate/indicator.h
index 8af5568..4536cf5 100644
--- a/libindicate/indicator.h
+++ b/libindicate/indicator.h
@@ -56,6 +56,14 @@ G_BEGIN_DECLS
 typedef struct _IndicateIndicator IndicateIndicator;
 typedef struct _IndicateIndicatorClass IndicateIndicatorClass;
 
+/**
+	IndicateInidcator:
+
+	The indicator object represents a single item that is shared over the
+	indicator bus.  This could be something like one IM, one e-mail or 
+	a single system update.  It should be accessed only through its
+	accessors.
+*/
 struct _IndicateIndicator {
 	GObject parent;
 };