luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2024-12-26 15:36:14 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: Move the GTimeZone SECTION

Browse Source 
Move the contents to the struct docs.

Helps: #3037
This commit is contained in:
Matthias Clasen 2023-09-25 07:49:52 -04:00 committed by Philip Withnall
parent 7b4d00e0a4
commit 5a415ee93f
1 changed files with 14 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
glib/gtimezone.c
View File

@ -53,25 +53,23 @@
#endif #endif
/** /**
* SECTION:timezone * GTimeZone:
* @title: GTimeZone
* @short_description: a structure representing a time zone
* @see_also: #GDateTime
* *
* #GTimeZone is a structure that represents a time zone, at no * A `GTimeZone` represents a time zone, at no particular point in time.
* particular point in time. It is refcounted and immutable. *
* The `GTimeZone` struct is refcounted and immutable.
* *
* Each time zone has an identifier (for example, ‘Europe/London’) which is * Each time zone has an identifier (for example, ‘Europe/London’) which is
* platform dependent. See g_time_zone_new() for information on the identifier * platform dependent. See [method@GLib.TimeZone.new] for information on the
* formats. The identifier of a time zone can be retrieved using * identifier formats. The identifier of a time zone can be retrieved using
* g_time_zone_get_identifier(). * [method@GLib.TimeZone.get_identifier].
* *
* A time zone contains a number of intervals. Each interval has * A time zone contains a number of intervals. Each interval has an abbreviation
* an abbreviation to describe it (for example, ‘PDT’), an offset to UTC and a * to describe it (for example, ‘PDT’), an offset to UTC and a flag indicating
* flag indicating if the daylight savings time is in effect during that * if the daylight savings time is in effect during that interval. A time zone
* interval. A time zone always has at least one interval — interval 0. Note * always has at least one interval — interval 0. Note that interval abbreviations
* that interval abbreviations are not the same as time zone identifiers * are not the same as time zone identifiers (apart from ‘UTC’), and cannot be
* (apart from ‘UTC’), and cannot be passed to g_time_zone_new(). * passed to [method@GLib.TimeZone.new].
* *
* Every UTC time is contained within exactly one interval, but a given * Every UTC time is contained within exactly one interval, but a given
* local time may be contained within zero, one or two intervals (due to * local time may be contained within zero, one or two intervals (due to
@ -84,17 +82,8 @@
* that some properties (like the abbreviation) change between intervals * that some properties (like the abbreviation) change between intervals
* without other properties changing. * without other properties changing.
* *
* #GTimeZone is available since GLib 2.26.
*/
/**
* GTimeZone:
*
* #GTimeZone is an opaque structure whose members cannot be accessed
* directly.
*
* Since: 2.26 * Since: 2.26
**/ */
/* IANA zoneinfo file format {{{1 */ /* IANA zoneinfo file format {{{1 */