Added GTK-Doc section documentation
This commit is contained in:
parent
7d67dabf1f
commit
3174484ff4
@ -23,6 +23,18 @@
|
|||||||
|
|
||||||
#include "../swe/src/swephexp.h"
|
#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 SYNODIC 29.53058867
|
||||||
|
|
||||||
#define GSWE_MOMENT_GET_PRIVATE(obj) (G_TYPE_INSTANCE_GET_PRIVATE((obj), GSWE_TYPE_MOMENT, GsweMomentPrivate))
|
#define GSWE_MOMENT_GET_PRIVATE(obj) (G_TYPE_INSTANCE_GET_PRIVATE((obj), GSWE_TYPE_MOMENT, GsweMomentPrivate))
|
||||||
|
@ -24,6 +24,16 @@
|
|||||||
#include "swe-glib-private.h"
|
#include "swe-glib-private.h"
|
||||||
#include "gswe-timestamp.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))
|
#define GSWE_TIMESTAMP_GET_PRIVATE(obj) (G_TYPE_INSTANCE_GET_PRIVATE((obj), GSWE_TYPE_TIMESTAMP, GsweTimestampPrivate))
|
||||||
|
|
||||||
typedef enum {
|
typedef enum {
|
||||||
|
@ -22,6 +22,16 @@
|
|||||||
#include <glib.h>
|
#include <glib.h>
|
||||||
#include <glib-object.h>
|
#include <glib-object.h>
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 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:
|
* GswePlanet:
|
||||||
* @GSWE_PLANET_NONE: no planet
|
* @GSWE_PLANET_NONE: no planet
|
||||||
|
@ -23,6 +23,17 @@
|
|||||||
#include "../swe/src/swephexp.h"
|
#include "../swe/src/swephexp.h"
|
||||||
#include "swe-glib.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;
|
gboolean gswe_initialized = FALSE;
|
||||||
gchar *gswe_ephe_path = NULL;
|
gchar *gswe_ephe_path = NULL;
|
||||||
GHashTable *gswe_planet_info_table;
|
GHashTable *gswe_planet_info_table;
|
||||||
|
Loading…
x
Reference in New Issue
Block a user