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(-) 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