diff --git a/glib/gdate.c b/glib/gdate.c index f60ec0cbf..11d852ce5 100644 --- a/glib/gdate.c +++ b/glib/gdate.c @@ -60,21 +60,21 @@ #endif /** - * SECTION:date - * @title: Date and Time Functions - * @short_description: calendrical calculations and miscellaneous time stuff + * GDate: * - * The #GDate data structure represents a day between January 1, Year 1, + * `GDate` is a struct for calendrical calculations. + * + * The `GDate` data structure represents a day between January 1, Year 1, * and sometime a few thousand years in the future (right now it will go - * to the year 65535 or so, but g_date_set_parse() only parses up to the - * year 8000 or so - just count on "a few thousand"). #GDate is meant to + * to the year 65535 or so, but [method@GLib.Date.set_parse] only parses up to the + * year 8000 or so - just count on "a few thousand"). `GDate` is meant to * represent everyday dates, not astronomical dates or historical dates * or ISO timestamps or the like. It extrapolates the current Gregorian * calendar forward and backward in time; there is no attempt to change - * the calendar to match time periods or locations. #GDate does not store + * the calendar to match time periods or locations. `GDate` does not store * time information; it represents a day. * - * The #GDate implementation has several nice features; it is only a + * The `GDate` implementation has several nice features; it is only a * 64-bit struct, so storing large numbers of dates is very efficient. It * can keep both a Julian and day-month-year representation of the date, * since some calculations are much easier with one representation or the @@ -84,25 +84,23 @@ * technical sense; technically, Julian dates count from the start of the * Julian period, Jan 1, 4713 BC). * - * #GDate is simple to use. First you need a "blank" date; you can get a - * dynamically allocated date from g_date_new(), or you can declare an - * automatic variable or array and initialize it by - * calling g_date_clear(). A cleared date is safe; it's safe to call - * g_date_set_dmy() and the other mutator functions to initialize the - * value of a cleared date. However, a cleared date is initially - * invalid, meaning that it doesn't represent a day that exists. - * It is undefined to call any of the date calculation routines on an - * invalid date. If you obtain a date from a user or other - * unpredictable source, you should check its validity with the - * g_date_valid() predicate. g_date_valid() is also used to check for - * errors with g_date_set_parse() and other functions that can - * fail. Dates can be invalidated by calling g_date_clear() again. + * `GDate` is simple to use. First you need a "blank" date; you can get a + * dynamically allocated date from [method@GLib.Date.new], or you can declare an + * automatic variable or array and initialize it by calling [method@GLib.Date.clear]. + * A cleared date is safe; it's safe to call [method@GLib.Date.set_dmy] and the other + * mutator functions to initialize the value of a cleared date. However, a cleared date + * is initially invalid, meaning that it doesn't represent a day that exists. + * It is undefined to call any of the date calculation routines on an invalid date. + * If you obtain a date from a user or other unpredictable source, you should check + * its validity with the [method@GLib.Date.valid] predicate. [method@GLib.Date.valid] + * is also used to check for errors with [method@GLib.Date.set_parse] and other functions + * that can fail. Dates can be invalidated by calling [method@GLib.Date.clear] again. * - * It is very important to use the API to access the #GDate - * struct. Often only the day-month-year or only the Julian - * representation is valid. Sometimes neither is valid. Use the API. + * It is very important to use the API to access the `GDate` struct. Often only the + * day-month-year or only the Julian representation is valid. Sometimes neither is valid. + * Use the API. * - * GLib also features #GDateTime which represents a precise time. + * GLib also features `GDateTime` which represents a precise time. */ /** diff --git a/glib/gdate.h b/glib/gdate.h index 5ef21cbf9..35a2e912d 100644 --- a/glib/gdate.h +++ b/glib/gdate.h @@ -38,15 +38,6 @@ G_BEGIN_DECLS -/* GDate - * - * Date calculations (not time for now, to be resolved). These are a - * mutant combination of Steffen Beyer's DateCalc routines - * (http://www.perl.com/CPAN/authors/id/STBEY/) and Jon Trowbridge's - * date routines (written for in-house software). Written by Havoc - * Pennington - */ - typedef gint32 GTime GLIB_DEPRECATED_TYPE_IN_2_62_FOR(GDateTime); typedef guint16 GDateYear; typedef guint8 GDateDay; /* day of the month */