Some minor enhancements to the in-source documentation.. Approved by jenkins, Charles Kerr.

1 files changed, 15 insertions, 10 deletions

diff --git a/libmessaging-menu/messaging-menu.c b/libmessaging-menu/messaging-menu.c
index 93727fc..8066b35 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
@@ -42,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 <ulink
+ * shortcut actions found in the desktop file.  Actions whose
+ * <code>NotShowIn</code> keyword contains "Messaging Menu" or whose
+ * <code>OnlyShowIn</code> keyword does not contain "Messaging Menu"
+ * will not appear (the <ulink
  * url="http://standards.freedesktop.org/desktop-entry-spec/desktop-entry-spec-1.1.html#extra-actions">
  * desktop file specification</ulink> 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.
@@ -762,10 +764,11 @@ 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.
+ * 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().
  *
@@ -790,10 +793,12 @@ 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.
+ * 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().
  *
@@ -1044,7 +1049,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.
  *