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

gdate: Clarify the documentation for g_date_new_dmy() and new_julian()

Browse Source 
The documentation about validity did not match the code. Since the code
hasn’t changed in a long time (since 1998 or 2011), change the
documentation to match it.

Signed-off-by: Philip Withnall <pwithnall@endlessos.org>

Fixes: #2520
This commit is contained in:
Philip Withnall 2021-11-03 10:47:38 +00:00
parent 82be9c4f11
commit fe0346a172
1 changed files with 14 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
glib/gdate.c
View File

@ -288,11 +288,14 @@ g_date_new (void)
* @month: month of the year * @month: month of the year
* @year: year * @year: year
* *
* Like g_date_new(), but also sets the value of the date. Assuming the * Create a new #GDate representing the given day-month-year triplet.
* day-month-year triplet you pass in represents an existing day, the
* returned date will be valid.
* *
* Returns: a newly-allocated #GDate initialized with @day, @month, and @year * The triplet you pass in must represent a valid date. Use g_date_valid_dmy()
* if needed to validate it. The returned #GDate is guaranteed to be non-%NULL
* and valid.
*
* Returns: (transfer full) (not nullable): a newly-allocated #GDate
* initialized with @day, @month, and @year
*/ */
GDate* GDate*
g_date_new_dmy (GDateDay day, g_date_new_dmy (GDateDay day,
@ -320,11 +323,14 @@ g_date_new_dmy (GDateDay day,
* g_date_new_julian: * g_date_new_julian:
* @julian_day: days since January 1, Year 1 * @julian_day: days since January 1, Year 1
* *
* Like g_date_new(), but also sets the value of the date. Assuming the * Create a new #GDate representing the given Julian date.
* Julian day number you pass in is valid (greater than 0, less than an
* unreasonably large number), the returned date will be valid.
* *
* Returns: a newly-allocated #GDate initialized with @julian_day * The @julian_day you pass in must be valid. Use g_date_valid_julian() if
* needed to validate it. The returned #GDate is guaranteed to be non-%NULL and
* valid.
*
* Returns: (transfer full) (not nullable): a newly-allocated #GDate initialized
* with @julian_day
*/ */
GDate* GDate*
g_date_new_julian (guint32 julian_day) g_date_new_julian (guint32 julian_day)