gergely/astrognome
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Added some documentation

Browse Source
This commit is contained in:
Gergely Polonkai 2013-09-02 16:17:23 +02:00
parent 770af8c2c0
commit ad6f87baae
2 changed files with 17 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
swe-glib/src/gswe-moment.c
View File

@ -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 void
gswe_moment_set_timestamp(GsweMoment *moment, GsweTimestamp *timestamp) gswe_moment_set_timestamp(GsweMoment *moment, GsweTimestamp *timestamp)
{ {
@ -177,6 +188,10 @@ gswe_moment_set_timestamp(GsweMoment *moment, GsweTimestamp *timestamp)
* gswe_moment_get_timestamp: * gswe_moment_get_timestamp:
* @moment: The GsweMoment object of which you requent its timestamp object * @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 * Returns: a #GsweTimestamp object assigned to the given moment
*/ */
GsweTimestamp * GsweTimestamp *

2
swe-glib/src/gswe-types.h
View File

@ -88,6 +88,8 @@ typedef enum {
* (or -1, if the planet has no such ID) * (or -1, if the planet has no such ID)
* @orb: the planet's “personal” orb * @orb: the planet's “personal” orb
* @name: the planet's name * @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_1: the first sign in which the planet is domicile
* @domicile_sign_2: the second 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 * @exile_sign_1: the first sign in which the planet is in exile