From 4eed03e221b0c1e1705e978631a35d9c494b414a Mon Sep 17 00:00:00 2001 From: Gergely Polonkai Date: Mon, 26 Aug 2013 01:56:33 +0200 Subject: [PATCH] Added some documentation to test GTK-Doc --- src/calculate.c | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/src/calculate.c b/src/calculate.c index d29c64b..3944874 100644 --- a/src/calculate.c +++ b/src/calculate.c @@ -2,6 +2,16 @@ #include "calculate.h" +/** + * SECTION:calculate + * @short_description: functions for astronomical calculations + * @title: Astronomical calculation functions + * @section_id: + * @include: calculate.h + * + * These functions are for astronomical calculations. They are deprecated by SWE-GLib on the long run + */ + const signTypePair_t signType[] = { { 0, 0, 0, 0, 0, 0, 0 }, // Type Element Dominating planet Detriment planet Fall planet @@ -20,6 +30,16 @@ const signTypePair_t signType[] = { { TYPE_MUTABLE, ELEMENT_WATER, SE_NEPTUNE, SE_JUPITER, SE_MERCURY, SE_VENUS, SE_MERCURY }, // Pisces }; +/** + * get_house: + * @position: the latitude position of the celestial body on the sky + * @cusps: an array of gdoubles, which contains the position of the house + * cusps. MUST contain 12 gdouble values! + * + * Calculates in which house the given position is. + * + * Returns: the number of the house in which the given position is + */ guint get_house(gdouble position, gdouble cusps[]) {