[gnome-desktop] [WallClock] document the get_clock method



commit cbed695628d9e60eff7c64830cb87c717304fd8c
Author: Paolo Borelli <pborelli gnome org>
Date:   Tue Feb 12 08:46:27 2013 +0100

    [WallClock] document the get_clock method

 libgnome-desktop/gnome-wall-clock.c |   11 +++++++++++
 1 files changed, 11 insertions(+), 0 deletions(-)
---
diff --git a/libgnome-desktop/gnome-wall-clock.c b/libgnome-desktop/gnome-wall-clock.c
index 6b5ade6..b1f7296 100644
--- a/libgnome-desktop/gnome-wall-clock.c
+++ b/libgnome-desktop/gnome-wall-clock.c
@@ -348,6 +348,17 @@ on_tz_changed (GFileMonitor      *monitor,
 	update_timezone (user_data);
 }
 
+/**
+ * gnome_wall_clock_get_clock:
+ * @clock: a #GnomeWallClock
+ *
+ * Returns the string representing the current time of this clock
+ * according to the user settings.
+ *
+ * Return value: the time of the clock as a string.
+ *      This string points to internally allocated storage and
+ *      must not be freed, modified or stored.
+ */
 const char *
 gnome_wall_clock_get_clock (GnomeWallClock *clock)
 {


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]