From 3174484ff4b8547167ee09388950165916a2d16a Mon Sep 17 00:00:00 2001 From: "Gergely POLONKAI (W00d5t0ck)" Date: Mon, 16 Sep 2013 11:34:32 +0200 Subject: [PATCH] Added GTK-Doc section documentation --- src/gswe-moment.c | 12 ++++++++++++ src/gswe-timestamp.c | 10 ++++++++++ src/gswe-types.h | 10 ++++++++++ src/swe-glib.c | 11 +++++++++++ 4 files changed, 43 insertions(+) diff --git a/src/gswe-moment.c b/src/gswe-moment.c index 8375a05..b8b6937 100644 --- a/src/gswe-moment.c +++ b/src/gswe-moment.c @@ -23,6 +23,18 @@ #include "../swe/src/swephexp.h" +/** + * SECTION:gswe-moment + * @short_description: an exact moment of the sky, as seen from a given point + * of Earth at a given time + * @title: GsweMoment + * @stability: Stable + * @include: swe-glib/swe-glib.h + * + * This class represents an exact moment of the sky, as it can be seen from + * one given point on Earth at a given time. + */ + #define SYNODIC 29.53058867 #define GSWE_MOMENT_GET_PRIVATE(obj) (G_TYPE_INSTANCE_GET_PRIVATE((obj), GSWE_TYPE_MOMENT, GsweMomentPrivate)) diff --git a/src/gswe-timestamp.c b/src/gswe-timestamp.c index 6ccdf45..5a351f4 100644 --- a/src/gswe-timestamp.c +++ b/src/gswe-timestamp.c @@ -24,6 +24,16 @@ #include "swe-glib-private.h" #include "gswe-timestamp.h" +/** + * SECTION:gswe-timestamp + * @short_description: conversion between Gregorian dates and Julian day values + * @title: GsweTimestamp + * @stability: Stable + * @include: swe-glib/swe-glib.h + * + * This object converts Gregorian dates to Julian days and vice versa. + */ + #define GSWE_TIMESTAMP_GET_PRIVATE(obj) (G_TYPE_INSTANCE_GET_PRIVATE((obj), GSWE_TYPE_TIMESTAMP, GsweTimestampPrivate)) typedef enum { diff --git a/src/gswe-types.h b/src/gswe-types.h index 9efcd1a..72a4220 100644 --- a/src/gswe-types.h +++ b/src/gswe-types.h @@ -22,6 +22,16 @@ #include #include +/** + * SECTION:gswe-types + * @short_description: Base types of SWE-GLib + * @title: Base types + * @stability: Stable + * @include: swe-glib/swe-glib.h + * + * These are the base types used throughout SWE-GLib. + */ + /** * GswePlanet: * @GSWE_PLANET_NONE: no planet diff --git a/src/swe-glib.c b/src/swe-glib.c index 80625bc..462e558 100644 --- a/src/swe-glib.c +++ b/src/swe-glib.c @@ -23,6 +23,17 @@ #include "../swe/src/swephexp.h" #include "swe-glib.h" +/** + * SECTION:swe-glib + * @short_description: Utility and initialization functions + * @title: Utility functions + * @stability: Stable + * @include: swe-glib/swe-glib.h + * + * Basic utility and initialization functions. They don't operate on SWE-GLib's + * objects, but on the library as a whole, including global tables. + */ + gboolean gswe_initialized = FALSE; gchar *gswe_ephe_path = NULL; GHashTable *gswe_planet_info_table;