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

Added some function documentation

Browse Source
This commit is contained in:
Gergely Polonkai 2013-09-03 11:26:53 +02:00
parent b954f0584e
commit a7368d92c5
1 changed files with 23 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -689,6 +689,16 @@ gswe_moment_calculate_aspects(GsweMoment *moment)
moment->priv->aspect_revision = moment->priv->revision;
}
/**
* gswe_moment_get_aspects:
* @moment: the GsweMoment to operate on
*
* Gets all planetary aspects between the planets added by
* gswe_moment_add_planet() or gswe_moment_add_all_planets().
*
* Returns: a GList of #GsweAspectData. Both the GList and GsweAspectData
* objects belong to @moment, and should not be freed or modified.
*/
GList *
gswe_moment_get_aspects(GsweMoment *moment)
{
@ -697,6 +707,19 @@ gswe_moment_get_aspects(GsweMoment *moment)
return moment->priv->aspect_list;
}
/**
* gswe_moment_get_planet_aspects:
* @moment: the GsweMoment to operate on
* @planet: the planet whose aspects you want to get
*
* Get all the aspects between @planet and all the other planets added with
* gswe_moment_add_planet() or gswe_moment_add_all_planets().
*
* Returns: a GList of #GsweAspectData. The GsweAspectData structures belong to
* @moment, but the GList should be freed using g_list_free(). If the
* planet has no aspects, or the planet has not been added to @moment,
* returns NULL.
*/
GList *
gswe_moment_get_planet_aspects(GsweMoment *moment, GswePlanet planet)
{