aboutsummaryrefslogtreecommitdiff
path: root/libindicate
diff options
context:
space:
mode:
authorTed Gould <ted@canonical.com>2009-04-30 16:57:51 -0500
committerTed Gould <ted@canonical.com>2009-04-30 16:57:51 -0500
commit933bcaaa5942e9990e07da32bcde392d0e9a7883 (patch)
tree1a076c142b52a6896197708273faaacc2cd9028e /libindicate
parent298abb13418fe50b5c2c5e66fcad5c21c4732d41 (diff)
downloadlibayatana-indicator-933bcaaa5942e9990e07da32bcde392d0e9a7883.tar.gz
libayatana-indicator-933bcaaa5942e9990e07da32bcde392d0e9a7883.tar.bz2
libayatana-indicator-933bcaaa5942e9990e07da32bcde392d0e9a7883.zip
Adding in message documentation and cleaning up some mistakes as I see them.
Diffstat (limited to 'libindicate')
-rw-r--r--libindicate/indicator-message.c7
-rw-r--r--libindicate/indicator-message.h38
-rw-r--r--libindicate/indicator.c2
3 files changed, 40 insertions, 7 deletions
diff --git a/libindicate/indicator-message.c b/libindicate/indicator-message.c
index 4e8ef30..9cd735a 100644
--- a/libindicate/indicator-message.c
+++ b/libindicate/indicator-message.c
@@ -85,6 +85,13 @@ indicate_indicator_message_finalize (GObject *object)
G_OBJECT_CLASS (indicate_indicator_message_parent_class)->finalize (object);
}
+/**
+ indicate_indicator_message_new:
+
+ Builds a new indicator message object using #g_object_new.
+
+ Return value: A pointer to a new #IndicateIndicatorMessage object.
+*/
static const gchar *
get_indicator_type (IndicateIndicator * indicator)
{
diff --git a/libindicate/indicator-message.h b/libindicate/indicator-message.h
index 0910477..62a41b7 100644
--- a/libindicate/indicator-message.h
+++ b/libindicate/indicator-message.h
@@ -47,19 +47,45 @@ G_BEGIN_DECLS
typedef struct _IndicateIndicatorMessage IndicateIndicatorMessage;
typedef struct _IndicateIndicatorMessageClass IndicateIndicatorMessageClass;
-struct _IndicateIndicatorMessageClass
-{
-IndicateIndicatorClass parent_class;
+/**
+ IndicateIndicatorMessageClass:
+
+ Subclass of #IndicateIndicator with no new functions or signals.
+*/
+struct _IndicateIndicatorMessageClass {
+ IndicateIndicatorClass parent_class;
};
-struct _IndicateIndicatorMessage
-{
-IndicateIndicator parent;
+/**
+ IndicateIndicatorMessage:
+
+ A class to represent indicators who's 'type' is "message". These
+ are basically indicators that represent messages from humans to
+ humans via computers. Things like instance messages, micro blogging
+ entries or e-mails. All of these qualify as messages.
+
+ TODO: This should include a list of properties that are supported.
+*/
+struct _IndicateIndicatorMessage {
+ IndicateIndicator parent;
};
GType indicate_indicator_message_get_type (void);
IndicateIndicatorMessage * indicate_indicator_message_new (void);
+/**
+ SECTION:indicator-message
+ @short_description: A representation of human generated messages
+ @stability: Unstable
+ @include: libindicate/indicator-message.h
+
+ The message indicators represent messages that come from humans
+ to humans using computers. They come in all different forms with
+ various different interaction protocols, but they all want the human
+ at the computer to interact back with the human that sent the
+ message.
+*/
+
G_END_DECLS
#endif
diff --git a/libindicate/indicator.c b/libindicate/indicator.c
index c867a9a..15788d4 100644
--- a/libindicate/indicator.c
+++ b/libindicate/indicator.c
@@ -181,7 +181,7 @@ indicate_indicator_finalize (GObject * obj)
/**
indicate_indicator_new:
- Builds a new indicator object using #g_object_new.
+ Builds a new indicator object using g_object_new().
Return value: A pointer to a new #IndicateIndicator object.
*/