gergely/swe-glib
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Move GsweError and GSWE_ERROR documentation to .c file

Browse Source 
This is to hide documentation details from installed .h files
This commit is contained in:
Gergely Polonkai 2014-07-16 22:38:47 +02:00
parent cb9cf3a4ce
commit dca2071c88
2 changed files with 26 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
src/swe-glib.c
View File

@ -34,6 +34,32 @@
* objects, but on the library as a whole, including global tables. * 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; gboolean gswe_initialized = FALSE;
gchar *gswe_ephe_path = NULL; gchar *gswe_ephe_path = NULL;
GHashTable *gswe_planet_info_table; GHashTable *gswe_planet_info_table;

25
src/swe-glib.h
View File

@ -34,23 +34,6 @@
#include "gswe-moment.h" #include "gswe-moment.h"
#include "gswe-enumtypes.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 { typedef enum {
GSWE_ERROR_SUCCESS, GSWE_ERROR_SUCCESS,
GSWE_ERROR_SWE_NONFATAL, GSWE_ERROR_SWE_NONFATAL,
@ -65,13 +48,6 @@ typedef enum {
GSWE_ERROR_UNKNOWN_ASPECT, GSWE_ERROR_UNKNOWN_ASPECT,
} GsweError; } 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() #define GSWE_ERROR gswe_error_quark()
GQuark gswe_error_quark(void); GQuark gswe_error_quark(void);
@ -92,4 +68,3 @@ GsweAntiscionAxisInfo *gswe_find_antiscion_axis_info_by_id(
GError **err); GError **err);
#endif /* __SWE_GLIB_H__ */ #endif /* __SWE_GLIB_H__ */