From dca2071c88cca9c846c1fcfa99bfd195e8fc5783 Mon Sep 17 00:00:00 2001 From: Gergely Polonkai Date: Wed, 16 Jul 2014 22:38:47 +0200 Subject: [PATCH] Move GsweError and GSWE_ERROR documentation to .c file This is to hide documentation details from installed .h files --- src/swe-glib.c | 26 ++++++++++++++++++++++++++ src/swe-glib.h | 25 ------------------------- 2 files changed, 26 insertions(+), 25 deletions(-) diff --git a/src/swe-glib.c b/src/swe-glib.c index b7acd7b..9b7872e 100644 --- a/src/swe-glib.c +++ b/src/swe-glib.c @@ -34,6 +34,32 @@ * objects, but on the library as a whole, including global tables. */ +/** + * GsweError: + * @GSWE_ERROR_SUCCESS: No error + * @GSWE_ERROR_SWE_NONFATAL: Non-fatal Swiss Ephemeris library error + * @GSWE_ERROR_SWE_FATAL: Fatal Swiss Ephemeris library error + * @GSWE_ERROR_INVALID_DATE: The specified Gregorian date is invalid + * @GSWE_ERROR_INVALID_TIME: The specified time is invalid + * @GSWE_ERROR_NO_VALID_VALUE: the #GsweTimestamp object holds no valid values + * @GSWE_ERROR_UNKNOWN_HSYS: the requested house system is unknown + * @GSWE_ERROR_UNKNOWN_SIGN: an invalid zodiac sign would have been returned + * @GSWE_ERROR_UNKNOWN_PLANET: the referenced planet was not added with + * gswe_moment_add_planet() + * @GSWE_ERROR_UNKNOWN_ANTISCION_AXIS: the given axis is unknown to SWE-GLib + * @GSWE_ERROR_UNKNOWN_ASPECT: the given aspect is unknown to SWE-GLib + * + * Error codes returned by the SWE-GLib functions. + */ + +/** + * GSWE_ERROR: + * + * Error domain for SWE-GLib in general. Since 2.0, all errors generated by + * SWE-GLib functions are from this domain. See #GError for more information on + * error domains. + */ + gboolean gswe_initialized = FALSE; gchar *gswe_ephe_path = NULL; GHashTable *gswe_planet_info_table; diff --git a/src/swe-glib.h b/src/swe-glib.h index ff9dfc6..d8ae27f 100644 --- a/src/swe-glib.h +++ b/src/swe-glib.h @@ -34,23 +34,6 @@ #include "gswe-moment.h" #include "gswe-enumtypes.h" -/** - * GsweError: - * @GSWE_ERROR_SUCCESS: No error - * @GSWE_ERROR_SWE_NONFATAL: Non-fatal Swiss Ephemeris library error - * @GSWE_ERROR_SWE_FATAL: Fatal Swiss Ephemeris library error - * @GSWE_ERROR_INVALID_DATE: The specified Gregorian date is invalid - * @GSWE_ERROR_INVALID_TIME: The specified time is invalid - * @GSWE_ERROR_NO_VALID_VALUE: the #GsweTimestamp object holds no valid values - * @GSWE_ERROR_UNKNOWN_HSYS: the requested house system is unknown - * @GSWE_ERROR_UNKNOWN_SIGN: an invalid zodiac sign would have been returned - * @GSWE_ERROR_UNKNOWN_PLANET: the referenced planet was not added with - * gswe_moment_add_planet() - * @GSWE_ERROR_UNKNOWN_ANTISCION_AXIS: the given axis is unknown to SWE-GLib - * @GSWE_ERROR_UNKNOWN_ASPECT: the given aspect is unknown to SWE-GLib - * - * Error codes returned by the SWE-GLib functions. - */ typedef enum { GSWE_ERROR_SUCCESS, GSWE_ERROR_SWE_NONFATAL, @@ -65,13 +48,6 @@ typedef enum { GSWE_ERROR_UNKNOWN_ASPECT, } GsweError; -/** - * GSWE_ERROR: - * - * Error domain for SWE-GLib in general. Since 2.0, all errors generated by - * SWE-GLib functions are from this domain. See #GError for more information on - * error domains. - */ #define GSWE_ERROR gswe_error_quark() GQuark gswe_error_quark(void); @@ -92,4 +68,3 @@ GsweAntiscionAxisInfo *gswe_find_antiscion_axis_info_by_id( GError **err); #endif /* __SWE_GLIB_H__ */ -