From ad6f87baae7ed93fbdef112f36c0563de988bec1 Mon Sep 17 00:00:00 2001 From: "Gergely POLONKAI (W00d5t0ck)" Date: Mon, 2 Sep 2013 16:17:23 +0200 Subject: [PATCH] Added some documentation --- swe-glib/src/gswe-moment.c | 15 +++++++++++++++ swe-glib/src/gswe-types.h | 2 ++ 2 files changed, 17 insertions(+) diff --git a/swe-glib/src/gswe-moment.c b/swe-glib/src/gswe-moment.c index c0ac960..25e378b 100644 --- a/swe-glib/src/gswe-moment.c +++ b/swe-glib/src/gswe-moment.c @@ -157,6 +157,17 @@ gswe_moment_get_property(GObject *object, guint prop_id, GValue *value, GParamSp } } +/** + * gswe_moment_set_timestamp: + * @moment: A GsweMoment object + * @timestamp: A GsweTimestamp object. The moment object holds a reference on + * timestamp, which is cleared when a new timestamp is set, or the + * moment object is disposed. + * + * Sets a new timestamp for this planetary moment. Also emits the ::changed + * signal to notify owner of this change. This helps redrawing screen data + * according to the new time value. + */ void gswe_moment_set_timestamp(GsweMoment *moment, GsweTimestamp *timestamp) { @@ -177,6 +188,10 @@ gswe_moment_set_timestamp(GsweMoment *moment, GsweTimestamp *timestamp) * gswe_moment_get_timestamp: * @moment: The GsweMoment object of which you requent its timestamp object * + * Get the timestamp object of the given GsweMoment. The moment object holds a + * reference to this object, so if you need the timestamp object after moment + * is disposed, call g_object_ref() on it! + * * Returns: a #GsweTimestamp object assigned to the given moment */ GsweTimestamp * diff --git a/swe-glib/src/gswe-types.h b/swe-glib/src/gswe-types.h index d84e930..6da6187 100644 --- a/swe-glib/src/gswe-types.h +++ b/swe-glib/src/gswe-types.h @@ -88,6 +88,8 @@ typedef enum { * (or -1, if the planet has no such ID) * @orb: the planet's “personal” orb * @name: the planet's name + * @points: the value this planet counts in the element/quality points + * table * @domicile_sign_1: the first sign in which the planet is domicile * @domicile_sign_2: the second sign in which the planet is domicile * @exile_sign_1: the first sign in which the planet is in exile