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

docs: Clean up the GDate types description

Browse Source 
Split the first paragraph.

Use the correct gtk-doc sigil for enumeration value.

Use the appropriate term for negative years in the Western calendar.
This commit is contained in:
Emmanuele Bassi 2021-08-02 14:53:29 +01:00
parent 2aedaf293b
commit 1b666b7f12
1 changed files with 20 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
glib/gdate.c
View File

@ -115,7 +115,8 @@
* @tv_usec: microseconds * @tv_usec: microseconds
* *
* Represents a precise time, with seconds and microseconds. * Represents a precise time, with seconds and microseconds.
* Similar to the struct timeval returned by the gettimeofday() *
* Similar to the struct timeval returned by the `gettimeofday()`
* UNIX system call. * UNIX system call.
* *
* GLib is attempting to unify around the use of 64-bit integers to * GLib is attempting to unify around the use of 64-bit integers to
@ -141,7 +142,7 @@
* Represents a day between January 1, Year 1 and a few thousand years in * Represents a day between January 1, Year 1 and a few thousand years in
* the future. None of its members should be accessed directly. * the future. None of its members should be accessed directly.
* *
* If the #GDate-struct is obtained from g_date_new(), it will be safe * If the `GDate` is obtained from g_date_new(), it will be safe
* to mutate but invalid and thus not safe for calendrical computations. * to mutate but invalid and thus not safe for calendrical computations.
* *
* If it's declared on the stack, it will contain garbage so must be * If it's declared on the stack, it will contain garbage so must be
@ -156,7 +157,9 @@
* *
* Simply a replacement for `time_t`. It has been deprecated * Simply a replacement for `time_t`. It has been deprecated
* since it is not equivalent to `time_t` on 64-bit platforms * since it is not equivalent to `time_t` on 64-bit platforms
* with a 64-bit `time_t`. Unrelated to #GTimer. * with a 64-bit `time_t`.
*
* Unrelated to #GTimer.
* *
* Note that #GTime is defined to always be a 32-bit integer, * Note that #GTime is defined to always be a 32-bit integer,
* unlike `time_t` which may be 64-bit on some systems. Therefore, * unlike `time_t` which may be 64-bit on some systems. Therefore,
@ -165,6 +168,7 @@
* function. * function.
* *
* Instead, do the following: * Instead, do the following:
*
* |[<!-- language="C" --> * |[<!-- language="C" -->
* time_t ttime; * time_t ttime;
* GTime gtime; * GTime gtime;
@ -191,7 +195,8 @@
* GDateDay: * GDateDay:
* *
* Integer representing a day of the month; between 1 and 31. * Integer representing a day of the month; between 1 and 31.
* #G_DATE_BAD_DAY represents an invalid day of the month. *
* The %G_DATE_BAD_DAY value represents an invalid day of the month.
*/ */
/** /**
@ -210,16 +215,20 @@
* @G_DATE_NOVEMBER: November * @G_DATE_NOVEMBER: November
* @G_DATE_DECEMBER: December * @G_DATE_DECEMBER: December
* *
* Enumeration representing a month; values are #G_DATE_JANUARY, * Enumeration representing a month; values are %G_DATE_JANUARY,
* #G_DATE_FEBRUARY, etc. #G_DATE_BAD_MONTH is the invalid value. * %G_DATE_FEBRUARY, etc. %G_DATE_BAD_MONTH is the invalid value.
*/ */
/** /**
* GDateYear: * GDateYear:
* *
* Integer representing a year; #G_DATE_BAD_YEAR is the invalid * Integer type representing a year.
* value. The year must be 1 or higher; negative (BC) years are not *
* allowed. The year is represented with four digits. * The %G_DATE_BAD_YEAR value is the invalid value. The year
* must be 1 or higher; negative ([BCE](https://en.wikipedia.org/wiki/Common_Era))
* years are not allowed.
*
* The year is represented with four digits.
*/ */
/** /**