summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorChristian Hammond <chipx86@chipx86.com>2006-06-06 08:29:32 +0000
committerChristian Hammond <chipx86@chipx86.com>2006-06-06 08:29:32 +0000
commit629f6e08ca6e8222fd314ec135c7ca4232d806cf (patch)
tree4d518e3446b94a89bc286fa7d396824b6d3f4222 /docs
parent2ef25f78f9e047e844643cd6d4b9c3724af48a5a (diff)
downloadlibnotify-629f6e08ca6e8222fd314ec135c7ca4232d806cf.tar.gz
Provide more documentation.
Diffstat (limited to 'docs')
-rw-r--r--docs/reference/libnotify-sections.txt1
-rw-r--r--docs/reference/tmpl/notification.sgml47
-rw-r--r--docs/reference/tmpl/notify.sgml2
3 files changed, 27 insertions, 23 deletions
diff --git a/docs/reference/libnotify-sections.txt b/docs/reference/libnotify-sections.txt
index 7167ca4..485d96f 100644
--- a/docs/reference/libnotify-sections.txt
+++ b/docs/reference/libnotify-sections.txt
@@ -2,7 +2,6 @@
<FILE>notification</FILE>
NOTIFY_EXPIRES_DEFAULT
NOTIFY_EXPIRES_NEVER
-NotifyNotificationPrivate
<TITLE>NotifyNotification</TITLE>
NotifyNotification
NotifyUrgency
diff --git a/docs/reference/tmpl/notification.sgml b/docs/reference/tmpl/notification.sgml
index b988743..cedb907 100644
--- a/docs/reference/tmpl/notification.sgml
+++ b/docs/reference/tmpl/notification.sgml
@@ -2,11 +2,16 @@
NotifyNotification
<!-- ##### SECTION Short_Description ##### -->
-
+A passive pop-up notification.
<!-- ##### SECTION Long_Description ##### -->
<para>
-
+#NotifyNotification represents a passive pop-up notification. It can
+contain summary text, body text, and an icon, as well as hints specifying
+how the notification should be presented. The notification is rendered
+by a notification daemon, and may present the notification in any number
+of ways. As such, there is a clear separation of content and presentation,
+and this API enforces that.
</para>
<!-- ##### SECTION See_Also ##### -->
@@ -19,57 +24,57 @@ NotifyNotification
<!-- ##### MACRO NOTIFY_EXPIRES_DEFAULT ##### -->
<para>
-
+The default expiration time on a notification.
</para>
<!-- ##### MACRO NOTIFY_EXPIRES_NEVER ##### -->
<para>
-
+The notification never expires. It stays open until closed by the calling API
+or the user.
</para>
-<!-- ##### STRUCT NotifyNotificationPrivate ##### -->
-<para>
-
-</para>
-
-
<!-- ##### STRUCT NotifyNotification ##### -->
<para>
-
+This is an opaque structure representing a notification. This should
+not be used directly. Use the accessor functions below.
</para>
-@parent:
-@priv:
+@parent: The parent object.
+@priv: Private data.
<!-- ##### ENUM NotifyUrgency ##### -->
<para>
-
+The urgency level of the notification.
</para>
@NOTIFY_URGENCY_LOW:
+ Low urgency. Used for unimportant notifications.
@NOTIFY_URGENCY_NORMAL:
+ Normal urgency. Used for most standard notifications.
@NOTIFY_URGENCY_CRITICAL:
+ Critical urgency. Used for very important notifications.
<!-- ##### USER_FUNCTION NotifyActionCallback ##### -->
<para>
-
+An action callback function.
</para>
-@Param1:
-@Param2:
-@Param3:
+@Param1: The notification.
+@Param2: The action ID.
+@Param3: User data.
<!-- ##### MACRO NOTIFY_ACTION_CALLBACK ##### -->
<para>
-
+A convenience macro for casting a function to a #NotifyActionCallback. This
+is much like #G_CALLBACK().
</para>
-@func:
+@func: The function to cast.
<!-- ##### FUNCTION notify_notification_new ##### -->
@@ -171,7 +176,7 @@ NotifyNotification
</para>
@notification:
-@l:
+@urgency:
<!-- ##### FUNCTION notify_notification_set_icon_from_pixbuf ##### -->
diff --git a/docs/reference/tmpl/notify.sgml b/docs/reference/tmpl/notify.sgml
index 1668b8f..1f5b134 100644
--- a/docs/reference/tmpl/notify.sgml
+++ b/docs/reference/tmpl/notify.sgml
@@ -2,7 +2,7 @@
notify
<!-- ##### SECTION Short_Description ##### -->
-
+Notification API
<!-- ##### SECTION Long_Description ##### -->
<para>