From deff47a562860c1ab698d3861d387208e55bba06 Mon Sep 17 00:00:00 2001 From: Lars Uebernickel Date: Sun, 2 Sep 2012 12:12:59 +0200 Subject: libmessaging-menu: add @include hint to documentation --- libmessaging-menu/messaging-menu.c | 1 + 1 file changed, 1 insertion(+) (limited to 'libmessaging-menu') diff --git a/libmessaging-menu/messaging-menu.c b/libmessaging-menu/messaging-menu.c index 93727fc..4363019 100644 --- a/libmessaging-menu/messaging-menu.c +++ b/libmessaging-menu/messaging-menu.c @@ -27,6 +27,7 @@ * SECTION:messaging-menu * @title: MessagingMenuApp * @short_description: An application section in the messaging menu + * @include: messaging-menu.h * * A #MessagingMenuApp represents an application section in the * Messaging Menu. An application section is tied to an installed -- cgit v1.2.3 From 3856b84e523ec134d1429cf0cef0546f27754200 Mon Sep 17 00:00:00 2001 From: Lars Uebernickel Date: Sun, 2 Sep 2012 12:16:14 +0200 Subject: libmessaging-menu: document that @time is expressed in microseconds --- libmessaging-menu/messaging-menu.c | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'libmessaging-menu') diff --git a/libmessaging-menu/messaging-menu.c b/libmessaging-menu/messaging-menu.c index 4363019..a292461 100644 --- a/libmessaging-menu/messaging-menu.c +++ b/libmessaging-menu/messaging-menu.c @@ -763,7 +763,7 @@ void messaging_menu_app_append_source_with_count (MessagingMenuApp *app, * @id: a unique identifier for the source to be added * @icon: (allow-none): the icon associated with the source * @label: a user-visible string best describing the source - * @time: the time when the source was created + * @time: the time when the source was created, in microseconds * * Inserts a new message source into the section representing @app and * initializes it with @time. @@ -791,7 +791,7 @@ messaging_menu_app_insert_source_with_time (MessagingMenuApp *app, * @id: a unique identifier for the source to be added * @icon: (allow-none): the icon associated with the source * @label: a user-visible string best describing the source - * @time: the time when the source was created + * @time: the time when the source was created, in microseconds * * Appends a new message source to the end of the section representing @app and * initializes it with @time. @@ -1045,7 +1045,7 @@ void messaging_menu_app_set_source_count (MessagingMenuApp *app, * messaging_menu_app_set_source_time: * @app: a #MessagingMenuApp * @source_id: a source id - * @time: the new time for the source + * @time: the new time for the source, in microseconds * * Updates the time of @source_id to @time. * -- cgit v1.2.3 From 78ebf86005bf747ad7f1060e7991d4abeb5ed83f Mon Sep 17 00:00:00 2001 From: Lars Uebernickel Date: Sun, 2 Sep 2012 12:30:12 +0200 Subject: libmessaging-menu: add convenience doc The most common case when inserting a timed source is to insert a source with the current time. Emphasize this in the documentation by linking to the convenience methods from the _with_time variants. --- libmessaging-menu/messaging-menu.c | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) (limited to 'libmessaging-menu') diff --git a/libmessaging-menu/messaging-menu.c b/libmessaging-menu/messaging-menu.c index a292461..ebddf0f 100644 --- a/libmessaging-menu/messaging-menu.c +++ b/libmessaging-menu/messaging-menu.c @@ -766,7 +766,8 @@ void messaging_menu_app_append_source_with_count (MessagingMenuApp *app, * @time: the time when the source was created, in microseconds * * Inserts a new message source into the section representing @app and - * initializes it with @time. + * initializes it with @time. Use messaging_menu_app_insert_source() to + * insert a source with the current time. * * To change the time, use messaging_menu_app_set_source_time(). * @@ -793,8 +794,10 @@ messaging_menu_app_insert_source_with_time (MessagingMenuApp *app, * @label: a user-visible string best describing the source * @time: the time when the source was created, in microseconds * - * Appends a new message source to the end of the section representing @app and - * initializes it with @time. + * Appends a new message source to the end of the section representing + * @app and initializes it with @time. Use + * messaging_menu_app_append_source() to append a source with the + * current time. * * To change the time, use messaging_menu_app_set_source_time(). * -- cgit v1.2.3 From bd13abddd0740eb9cb0859c4a12cdd77d4819d21 Mon Sep 17 00:00:00 2001 From: Lars Uebernickel Date: Tue, 4 Sep 2012 20:49:44 +0200 Subject: libmessaging-menu: fix shortcut action documentation --- libmessaging-menu/messaging-menu.c | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) (limited to 'libmessaging-menu') diff --git a/libmessaging-menu/messaging-menu.c b/libmessaging-menu/messaging-menu.c index ebddf0f..8066b35 100644 --- a/libmessaging-menu/messaging-menu.c +++ b/libmessaging-menu/messaging-menu.c @@ -43,12 +43,13 @@ * desktop file. Activating this item starts the application. * * Following the application item, the Messaging Menu inserts all - * shortcuts actions found in the desktop file which are marked as - * appearing in the Messaging Menu (the TargetEnvironment or OnlyShowIn - * keywords contains "Messaging Menu"). The NotShowIn keyword contains "Messaging Menu" or whose + * OnlyShowIn keyword does not contain "Messaging Menu" + * will not appear (the * desktop file specification contains a detailed explanation of - * shortcut actions [1]. An application cannot add, remove, or change + * shortcut actions.) An application cannot add, remove, or change * these shortcut items while it is running. * * Next, an application section contains menu items for message sources. -- cgit v1.2.3