From dd9cdb33aa9fbadcd2d46cee062fc89560f05a33 Mon Sep 17 00:00:00 2001 From: Matthias Clasen Date: Fri, 9 Nov 2007 03:59:00 +0000 Subject: [PATCH] Some cleanupos svn path=/trunk/; revision=5844 --- docs/reference/glib/tmpl/date.sgml | 244 ++++++++++++++++++------------------- 1 file changed, 122 insertions(+), 122 deletions(-) diff --git a/docs/reference/glib/tmpl/date.sgml b/docs/reference/glib/tmpl/date.sgml index 3064fe3..f4fa67c 100644 --- a/docs/reference/glib/tmpl/date.sgml +++ b/docs/reference/glib/tmpl/date.sgml @@ -81,8 +81,8 @@ Similar to the struct timeval returned by the gettimeofday() UNIX call. -@tv_sec: seconds. -@tv_usec: microseconds. +@tv_sec: seconds +@tv_usec: microseconds @@ -100,7 +100,7 @@ depending on hardware and operating system; don't rely on the exact length of the sleep. -@microseconds: number of microseconds to pause. +@microseconds: number of microseconds to pause @@ -203,19 +203,19 @@ Enumeration representing a month; values are #G_DATE_JANUARY, #G_DATE_FEBRUARY, etc. #G_DATE_BAD_MONTH is the invalid value. -@G_DATE_BAD_MONTH: invalid value. -@G_DATE_JANUARY: January. -@G_DATE_FEBRUARY: February. -@G_DATE_MARCH: March. -@G_DATE_APRIL: April. -@G_DATE_MAY: May. -@G_DATE_JUNE: June. -@G_DATE_JULY: July. -@G_DATE_AUGUST: August. -@G_DATE_SEPTEMBER: September. -@G_DATE_OCTOBER: October. -@G_DATE_NOVEMBER: November. -@G_DATE_DECEMBER: December. +@G_DATE_BAD_MONTH: invalid value +@G_DATE_JANUARY: January +@G_DATE_FEBRUARY: February +@G_DATE_MARCH: March +@G_DATE_APRIL: April +@G_DATE_MAY: May +@G_DATE_JUNE: June +@G_DATE_JULY: July +@G_DATE_AUGUST: August +@G_DATE_SEPTEMBER: September +@G_DATE_OCTOBER: October +@G_DATE_NOVEMBER: November +@G_DATE_DECEMBER: December @@ -231,14 +231,14 @@ Enumeration representing a day of the week; #G_DATE_MONDAY, #G_DATE_TUESDAY, etc. #G_DATE_BAD_WEEKDAY is an invalid weekday. -@G_DATE_BAD_WEEKDAY: invalid value. -@G_DATE_MONDAY: Monday. -@G_DATE_TUESDAY: Tuesday. -@G_DATE_WEDNESDAY: Wednesday. -@G_DATE_THURSDAY: Thursday. -@G_DATE_FRIDAY: Friday. -@G_DATE_SATURDAY: Saturday. -@G_DATE_SUNDAY: Sunday. +@G_DATE_BAD_WEEKDAY: invalid value +@G_DATE_MONDAY: Monday +@G_DATE_TUESDAY: Tuesday +@G_DATE_WEDNESDAY: Wednesday +@G_DATE_THURSDAY: Thursday +@G_DATE_FRIDAY: Friday +@G_DATE_SATURDAY: Saturday +@G_DATE_SUNDAY: Sunday @@ -268,7 +268,7 @@ be cleared (as if you'd called g_date_clear()) but invalid (it won't represent an existing day). Free the return value with g_date_free(). -@Returns: a newly-allocated #GDate. +@Returns: a newly-allocated #GDate @@ -278,10 +278,10 @@ day-month-year triplet you pass in represents an existing day, the returned date will be valid. -@day: day of the month. -@month: month of the year. +@day: day of the month +@month: month of the year @year: year -@Returns: a newly-allocated #GDate initialized with @day, @month, and @year. +@Returns: a newly-allocated #GDate initialized with @day, @month, and @year @@ -291,8 +291,8 @@ Julian day number you pass in is valid (greater than 0, less than an unreasonably large number), the returned date will be valid. -@julian_day: days since January 1, Year 1. -@Returns: a newly-allocated #GDate initialized with @julian_day. +@julian_day: days since January 1, Year 1 +@Returns: a newly-allocated #GDate initialized with @julian_day @@ -303,8 +303,8 @@ not contain garbage. Useful to init a date declared on the stack. Validity can be tested with g_date_valid(). -@date: pointer to one or more dates to clear. -@n_dates: number of dates to clear. +@date: pointer to one or more dates to clear +@n_dates: number of dates to clear @@ -312,7 +312,7 @@ Validity can be tested with g_date_valid(). Frees a #GDate returned from g_date_new(). -@date: a #GDate. +@date: a #GDate @@ -321,8 +321,8 @@ Sets the day of the month for a #GDate. If the resulting day-month-year triplet is invalid, the date will be invalid. -@date: a #GDate. -@day: day to set. +@date: a #GDate +@day: day to set @@ -331,8 +331,8 @@ Sets the month of the year for a #GDate. If the resulting day-month-year triplet is invalid, the date will be invalid. -@date: a #GDate. -@month: month to set. +@date: a #GDate +@month: month to set @@ -341,8 +341,8 @@ Sets the year for a #GDate. If the resulting day-month-year triplet is invalid, the date will be invalid. -@date: a #GDate. -@year: year to set. +@date: a #GDate +@year: year to set @@ -352,10 +352,10 @@ triplet must be valid; if you aren't sure it is, call g_date_valid_dmy() to check before you set it. -@date: a #GDate. -@day: day. -@month: month. -@y: year. +@date: a #GDate +@day: day +@month: month +@y: year @@ -363,8 +363,8 @@ check before you set it. Sets the value of a #GDate from a Julian day number. -@date: a #GDate. -@julian_date: Julian day number (days since January 1, Year 1). +@date: a #GDate +@julian_date: Julian day number (days since January 1, Year 1) @@ -411,8 +411,8 @@ user means by a given string (and it does work pretty well in that capacity). -@date: a #GDate to fill in. -@str: string to parse. +@date: a #GDate to fill in +@str: string to parse @@ -421,8 +421,8 @@ Increments a date some number of days. To move forward by weeks, add weeks*7 days. The date must be valid. -@date: a #GDate to increment. -@n_days: number of days to move the date forward. +@date: a #GDate to increment +@n_days: number of days to move the date forward @@ -431,8 +431,8 @@ Moves a date some number of days into the past. To move by weeks, just move by weeks*7 days. The date must be valid. -@date: a #GDate to decrement. -@n_days: number of days to move. +@date: a #GDate to decrement +@n_days: number of days to move @@ -443,8 +443,8 @@ the destination month may not have the current day in it). The date must be valid. -@date: a #GDate to increment. -@n_months: number of months to move forward. +@date: a #GDate to increment +@n_months: number of months to move forward @@ -454,8 +454,8 @@ the month doesn't exist in the destination month, the day of the month may change. The date must be valid. -@date: a #GDate to decrement. -@n_months: number of months to move. +@date: a #GDate to decrement +@n_months: number of months to move @@ -465,8 +465,8 @@ and the destination year is not a leap year, the date will be changed to February 28. The date must be valid. -@date: a #GDate to increment. -@n_years: number of years to move forward. +@date: a #GDate to increment +@n_years: number of years to move forward @@ -477,8 +477,8 @@ move to a non-leap-year) then the day is changed to February 29. The date must be valid. -@date: a #GDate to decrement. -@n_years: number of years to move. +@date: a #GDate to decrement +@n_years: number of years to move @@ -488,21 +488,21 @@ If @date2 is prior to @date1, the returned value is negative. Both dates must be valid. -@date1: the first date. -@date2: the second date. -@Returns: the number of days between @date1 and @date2. +@date1: the first date +@date2: the second date +@Returns: the number of days between @date1 and @date2 -qsort()-style comparsion function for dates. Both +qsort()-style comparsion function for dates. Both dates must be valid. -@lhs: first date to compare. -@rhs: second date to compare. +@lhs: first date to compare +@rhs: second date to compare @Returns: 0 for equal, less than zero if @lhs is less than @rhs, -greater than zero if @lhs is greater than @rhs. + greater than zero if @lhs is greater than @rhs @@ -513,9 +513,9 @@ Either @min_date and @max_date may be %NULL. All non-%NULL dates must be valid. -@date: a #GDate to clamp. -@min_date: minimum accepted value for @date. -@max_date: maximum accepted value for @date. +@date: a #GDate to clamp +@min_date: minimum accepted value for @date +@max_date: maximum accepted value for @date @@ -524,8 +524,8 @@ Checks if @date1 is less than or equal to @date2, and swap the values if this is not the case. -@date1: the first date. -@date2: the second date. +@date1: the first date +@date2: the second date @@ -533,8 +533,8 @@ and swap the values if this is not the case. Returns the day of the month. The date must be valid. -@date: a #GDate to extract the day of the month from. -@Returns: day of the month. +@date: a #GDate to extract the day of the month from +@Returns: day of the month @@ -542,8 +542,8 @@ Returns the day of the month. The date must be valid. Returns the month of the year. The date must be valid. -@date: a #GDate to get the month from. -@Returns: month of the year as a #GDateMonth. +@date: a #GDate to get the month from +@Returns: month of the year as a #GDateMonth @@ -551,8 +551,8 @@ Returns the month of the year. The date must be valid. Returns the year of a #GDate. The date must be valid. -@date: a #GDate. -@Returns: year in which the date falls. +@date: a #GDate +@Returns: year in which the date falls @@ -563,8 +563,8 @@ January 1, Year 1 is Julian day 1; January 2, Year 1 is Julian day 2, etc. The date must be valid. -@date: a #GDate to extract the Julian day from. -@Returns: Julian day. +@date: a #GDate to extract the Julian day from +@Returns: Julian day @@ -582,8 +582,8 @@ Returns the day of the year, where Jan 1 is the first day of the year. The date must be valid. -@date: a #GDate to extract day of year from. -@Returns: day of the year. +@date: a #GDate to extract day of year from +@Returns: day of the year @@ -591,9 +591,9 @@ year. The date must be valid. Returns the number of days in a month, taking leap years into account. -@month: month. -@year: year. -@Returns: number of days in @month during the @year. +@month: month +@year: year +@Returns: number of days in @month during the @year @@ -601,8 +601,8 @@ Returns the number of days in a month, taking leap years into account. Returns %TRUE if the date is on the first of a month. The date must be valid. -@date: a #GDate to check. -@Returns: %TRUE if the date is the first of the month. +@date: a #GDate to check +@Returns: %TRUE if the date is the first of the month @@ -610,8 +610,8 @@ Returns %TRUE if the date is on the first of a month. The date must be valid. Returns %TRUE if the date is the last day of the month. The date must be valid. -@date: a #GDate to check. -@Returns: %TRUE if the date is the last day of the month. +@date: a #GDate to check +@Returns: %TRUE if the date is the last day of the month @@ -619,8 +619,8 @@ Returns %TRUE if the date is the last day of the month. The date must be valid. Returns %TRUE if the year is a leap year. -@year: year to check. -@Returns: %TRUE if the year is a leap year. +@year: year to check +@Returns: %TRUE if the year is a leap year @@ -630,8 +630,8 @@ Monday. If the date is before the first Monday of the year, return 0. The date must be valid. -@date: a #GDate. -@Returns: week of the year. +@date: a #GDate +@Returns: week of the year @@ -644,8 +644,8 @@ the year, i.e. there are 53 Mondays if one of the extra days happens to be a Monday.) -@year: a year. -@Returns: number of Mondays in the year. +@year: a year +@Returns: number of Mondays in the year @@ -655,8 +655,8 @@ are understood to being on Sunday. The date must be valid. Can return 0 if the day is before the first Sunday of the year. -@date: a #GDate. -@Returns: week number. +@date: a #GDate +@Returns: week number @@ -669,8 +669,8 @@ the year, i.e. there are 53 Sundays if one of the extra days happens to be a Sunday.) -@year: year to count weeks in. -@Returns: number of weeks. +@year: year to count weeks in +@Returns: number of weeks @@ -699,11 +699,11 @@ expect that using g_date_strftime() would make the %F provided by the C99 strftime() work on Windows where the C library only complies to C89. -@s: destination buffer. -@slen: buffer size. -@format: format string. -@date: valid #GDate. -@Returns: number of characters written to the buffer, or 0 the buffer was too small. +@s: destination buffer +@slen: buffer size +@format: format string +@date: valid #GDate +@Returns: number of characters written to the buffer, or 0 the buffer was too small @@ -724,8 +724,8 @@ contain garbage; it should have been initialized with g_date_clear() if it wasn't allocated by one of the g_date_new() variants. -@date: a #GDate to check. -@Returns: Whether the date is valid. +@date: a #GDate to check +@Returns: Whether the date is valid @@ -734,8 +734,8 @@ Returns %TRUE if the day of the month is valid (a day is valid if it's between 1 and 31 inclusive). -@day: day to check. -@Returns: %TRUE if the day is valid. +@day: day to check +@Returns: %TRUE if the day is valid @@ -744,8 +744,8 @@ Returns %TRUE if the month value is valid. The 12 #GDateMonth enumeration values are the only valid months. -@month: month. -@Returns: %TRUE if the month is valid. +@month: month +@Returns: %TRUE if the month is valid @@ -754,8 +754,8 @@ Returns %TRUE if the year is valid. Any year greater than 0 is valid, though there is a 16-bit limit to what #GDate will understand. -@year: year. -@Returns: %TRUE if the year is valid. +@year: year +@Returns: %TRUE if the year is valid @@ -765,29 +765,29 @@ in the range of days #GDate understands (Year 1 or later, no more than a few thousand years in the future). -@day: day. -@month: month. -@year: year. -@Returns: %TRUE if the date is a valid one. +@day: day +@month: month +@year: year +@Returns: %TRUE if the date is a valid one -Returns %TRUE if the Julian day is valid. Anything greater than zero is basically a -valid Julian, though there is a 32-bit limit. +Returns %TRUE if the Julian day is valid. Anything greater than zero +is basically a valid Julian, though there is a 32-bit limit. -@julian_date: Julian day to check. -@Returns: %TRUE if the Julian day is valid. +@julian_date: Julian day to check +@Returns: %TRUE if the Julian day is valid -Returns %TRUE if the weekday is valid. The 7 #GDateWeekday enumeration +Returns %TRUE if the weekday is valid. The seven #GDateWeekday enumeration values are the only valid weekdays. -@weekday: weekday. -@Returns: %TRUE if the weekday is valid. +@weekday: weekday +@Returns: %TRUE if the weekday is valid -- 2.7.4