Finished documenting GsweMomentError and GsweTimestampError

This commit is contained in:
Gergely Polonkai 2013-09-11 01:55:35 +02:00
parent ec82bfc08d
commit a57ce7cd2f
2 changed files with 22 additions and 3 deletions

View File

@ -19,8 +19,20 @@ typedef struct _GsweMomentPrivate GsweMomentPrivate;
#define GSWE_MOMENT_ERROR gswe_moment_error_quark()
GQuark gswe_moment_error_quark(void);
/*
/**
* GsweMomentError:
* @GSWE_MOMENT_ERROR_SUCCESS: no error
* @GSWE_MOMENT_ERROR_UNKNOWN_HSYS: house system provided is unknown (a
* #GsweHouseSystem value must be passed)
* @GSWE_MOMENT_ERROR_UNKNOWN_SIGN: an unknown zodiac sign is calculated
* @GSWE_MOMENT_ERROR_NONADDED_PLANET: the referenced planet is not added to
* the GsweMoment object
* @GSWE_MOMENT_ERROR_SWE_ERROR_NONFATAL: an error reported by the Swiss
* Ephemeris library. Errors marked with
* this value are not fatal, so it's
* more like a warning
* @GSWE_MOMENT_ERROR_SWE_ERROR_FATAL: a fatal error reported by the Swiss
* Ephemeris library
*
* Error values for GsweTimestamp initialization
*/

View File

@ -19,12 +19,19 @@ GQuark gswe_timestamp_error_quark(void);
/**
* GsweTimestampError:
* @GSWE_TIMESTAMP_ERROR_SUCCESS: no error
* @GSWE_TIMESTAMP_ERROR_INVALID_DATE: the Gregorian date specified in this
* #GsweTimestamp is invalid
* GsweTimestamp is invalid
* @GSWE_TIMESTAMP_ERROR_INVALID_TIME: the time specified in this
* #GsweTimestamp is invalid
* GsweTimestamp is invalid
* @GSWE_TIMESTAMP_ERROR_NO_VALID: the GsweTimestamp object holds no valid
* timestamp
* @GSWE_TIMESTAMP_ERROR_SWE_ERROR: denotes an error detected by the Swiss
* Ephemeris library, converted from their
* static char array to a #GError
*/
typedef enum {
GSWE_TIMESTAMP_ERROR_SUCCESS,
GSWE_TIMESTAMP_ERROR_INVALID_DATE,
GSWE_TIMESTAMP_ERROR_INVALID_TIME,
GSWE_TIMESTAMP_ERROR_NO_VALID,