mirror of
https://gitlab.gnome.org/GNOME/glib.git
synced 2025-01-23 20:46:14 +01:00
GDateTime: Convert docs to markdown
In particular convert sections and lists to markdown syntax.
This commit is contained in:
Matthias Clasen
parent
5cf14b0cc2
commit
ef3796d3fd
320
glib/gdatetime.c
320
glib/gdatetime.c
@ -2540,266 +2540,82 @@ g_date_time_format_locale (GDateTime *datetime,
|
||||
*
|
||||
* The following format specifiers are supported:
|
||||
*
|
||||
* <variablelist>
|
||||
* <varlistentry><term>
|
||||
* <literal>\%a</literal>:
|
||||
* </term><listitem><simpara>
|
||||
* the abbreviated weekday name according to the current locale
|
||||
* </simpara></listitem></varlistentry>
|
||||
* <varlistentry><term>
|
||||
* <literal>\%A</literal>:
|
||||
* </term><listitem><simpara>
|
||||
* the full weekday name according to the current locale
|
||||
* </simpara></listitem></varlistentry>
|
||||
* <varlistentry><term>
|
||||
* <literal>\%b</literal>:
|
||||
* </term><listitem><simpara>
|
||||
* the abbreviated month name according to the current locale
|
||||
* </simpara></listitem></varlistentry>
|
||||
* <varlistentry><term>
|
||||
* <literal>\%B</literal>:
|
||||
* </term><listitem><simpara>
|
||||
* the full month name according to the current locale
|
||||
* </simpara></listitem></varlistentry>
|
||||
* <varlistentry><term>
|
||||
* <literal>\%c</literal>:
|
||||
* </term><listitem><simpara>
|
||||
* the preferred date and time representation for the current locale
|
||||
* </simpara></listitem></varlistentry>
|
||||
* <varlistentry><term>
|
||||
* <literal>\%C</literal>:
|
||||
* </term><listitem><simpara>
|
||||
* The century number (year/100) as a 2-digit integer (00-99)
|
||||
* </simpara></listitem></varlistentry>
|
||||
* <varlistentry><term>
|
||||
* <literal>\%d</literal>:
|
||||
* </term><listitem><simpara>
|
||||
* the day of the month as a decimal number (range 01 to 31)
|
||||
* </simpara></listitem></varlistentry>
|
||||
* <varlistentry><term>
|
||||
* <literal>\%e</literal>:
|
||||
* </term><listitem><simpara>
|
||||
* the day of the month as a decimal number (range 1 to 31)
|
||||
* </simpara></listitem></varlistentry>
|
||||
* <varlistentry><term>
|
||||
* <literal>\%F</literal>:
|
||||
* </term><listitem><simpara>
|
||||
* equivalent to <literal>\%Y-\%m-\%d</literal> (the ISO 8601 date
|
||||
* format)
|
||||
* </simpara></listitem></varlistentry>
|
||||
* <varlistentry><term>
|
||||
* <literal>\%g</literal>:
|
||||
* </term><listitem><simpara>
|
||||
* the last two digits of the ISO 8601 week-based year as a decimal
|
||||
* number (00-99). This works well with \%V and \%u.
|
||||
* </simpara></listitem></varlistentry>
|
||||
* <varlistentry><term>
|
||||
* <literal>\%G</literal>:
|
||||
* </term><listitem><simpara>
|
||||
* the ISO 8601 week-based year as a decimal number. This works well
|
||||
* - \%a: the abbreviated weekday name according to the current locale
|
||||
* - \%A: the full weekday name according to the current locale
|
||||
* - \%b: the abbreviated month name according to the current locale
|
||||
* - \%B: the full month name according to the current locale
|
||||
* - \%c: the preferred date and time rpresentation for the current locale
|
||||
* - \%C: the century number (year/100) as a 2-digit integer (00-99)
|
||||
* - \%d: the day of the month as a decimal number (range 01 to 31)
|
||||
* - \%e: the day of the month as a decimal number (range 1 to 31)
|
||||
* - \%F: equivalent to <literal>\%Y-\%m-\%d</literal> (the ISO 8601 date
|
||||
* format)
|
||||
* - \%g: the last two digits of the ISO 8601 week-based year as a decimal
|
||||
* number (00-99). This works well with \%V and \%u.
|
||||
* - \%G: the ISO 8601 week-based year as a decimal number. This works well
|
||||
* with \%V and \%u.
|
||||
* </simpara></listitem></varlistentry>
|
||||
* <varlistentry><term>
|
||||
* <literal>\%h</literal>:
|
||||
* </term><listitem><simpara>
|
||||
* equivalent to <literal>\%b</literal>
|
||||
* </simpara></listitem></varlistentry>
|
||||
* <varlistentry><term>
|
||||
* <literal>\%H</literal>:
|
||||
* </term><listitem><simpara>
|
||||
* the hour as a decimal number using a 24-hour clock (range 00 to
|
||||
* 23)
|
||||
* </simpara></listitem></varlistentry>
|
||||
* <varlistentry><term>
|
||||
* <literal>\%I</literal>:
|
||||
* </term><listitem><simpara>
|
||||
* the hour as a decimal number using a 12-hour clock (range 01 to
|
||||
* 12)
|
||||
* </simpara></listitem></varlistentry>
|
||||
* <varlistentry><term>
|
||||
* <literal>\%j</literal>:
|
||||
* </term><listitem><simpara>
|
||||
* the day of the year as a decimal number (range 001 to 366)
|
||||
* </simpara></listitem></varlistentry>
|
||||
* <varlistentry><term>
|
||||
* <literal>\%k</literal>:
|
||||
* </term><listitem><simpara>
|
||||
* the hour (24-hour clock) as a decimal number (range 0 to 23);
|
||||
* single digits are preceded by a blank
|
||||
* </simpara></listitem></varlistentry>
|
||||
* <varlistentry><term>
|
||||
* <literal>\%l</literal>:
|
||||
* </term><listitem><simpara>
|
||||
* the hour (12-hour clock) as a decimal number (range 1 to 12);
|
||||
* single digits are preceded by a blank
|
||||
* </simpara></listitem></varlistentry>
|
||||
* <varlistentry><term>
|
||||
* <literal>\%m</literal>:
|
||||
* </term><listitem><simpara>
|
||||
* the month as a decimal number (range 01 to 12)
|
||||
* </simpara></listitem></varlistentry>
|
||||
* <varlistentry><term>
|
||||
* <literal>\%M</literal>:
|
||||
* </term><listitem><simpara>
|
||||
* the minute as a decimal number (range 00 to 59)
|
||||
* </simpara></listitem></varlistentry>
|
||||
* <varlistentry><term>
|
||||
* <literal>\%p</literal>:
|
||||
* </term><listitem><simpara>
|
||||
* either "AM" or "PM" according to the given time value, or the
|
||||
* corresponding strings for the current locale. Noon is treated as
|
||||
* "PM" and midnight as "AM".
|
||||
* </simpara></listitem></varlistentry>
|
||||
* <varlistentry><term>
|
||||
* <literal>\%P</literal>:
|
||||
* </term><listitem><simpara>
|
||||
* like \%p but lowercase: "am" or "pm" or a corresponding string for
|
||||
* the current locale
|
||||
* </simpara></listitem></varlistentry>
|
||||
* <varlistentry><term>
|
||||
* <literal>\%r</literal>:
|
||||
* </term><listitem><simpara>
|
||||
* the time in a.m. or p.m. notation
|
||||
* </simpara></listitem></varlistentry>
|
||||
* <varlistentry><term>
|
||||
* <literal>\%R</literal>:
|
||||
* </term><listitem><simpara>
|
||||
* the time in 24-hour notation (<literal>\%H:\%M</literal>)
|
||||
* </simpara></listitem></varlistentry>
|
||||
* <varlistentry><term>
|
||||
* <literal>\%s</literal>:
|
||||
* </term><listitem><simpara>
|
||||
* the number of seconds since the Epoch, that is, since 1970-01-01
|
||||
* 00:00:00 UTC
|
||||
* </simpara></listitem></varlistentry>
|
||||
* <varlistentry><term>
|
||||
* <literal>\%S</literal>:
|
||||
* </term><listitem><simpara>
|
||||
* the second as a decimal number (range 00 to 60)
|
||||
* </simpara></listitem></varlistentry>
|
||||
* <varlistentry><term>
|
||||
* <literal>\%t</literal>:
|
||||
* </term><listitem><simpara>
|
||||
* a tab character
|
||||
* </simpara></listitem></varlistentry>
|
||||
* <varlistentry><term>
|
||||
* <literal>\%T</literal>:
|
||||
* </term><listitem><simpara>
|
||||
* the time in 24-hour notation with seconds (<literal>\%H:\%M:\%S</literal>)
|
||||
* </simpara></listitem></varlistentry>
|
||||
* <varlistentry><term>
|
||||
* <literal>\%u</literal>:
|
||||
* </term><listitem><simpara>
|
||||
* the ISO 8601 standard day of the week as a decimal, range 1 to 7,
|
||||
* Monday being 1. This works well with \%G and \%V.
|
||||
* </simpara></listitem></varlistentry>
|
||||
* <varlistentry><term>
|
||||
* <literal>\%V</literal>:
|
||||
* </term><listitem><simpara>
|
||||
* the ISO 8601 standard week number of the current year as a decimal
|
||||
* number, range 01 to 53, where week 1 is the first week that has at
|
||||
* least 4 days in the new year. See g_date_time_get_week_of_year().
|
||||
* This works well with \%G and \%u.
|
||||
* </simpara></listitem></varlistentry>
|
||||
* <varlistentry><term>
|
||||
* <literal>\%w</literal>:
|
||||
* </term><listitem><simpara>
|
||||
* the day of the week as a decimal, range 0 to 6, Sunday being 0.
|
||||
* This is not the ISO 8601 standard format -- use \%u instead.
|
||||
* </simpara></listitem></varlistentry>
|
||||
* <varlistentry><term>
|
||||
* <literal>\%x</literal>:
|
||||
* </term><listitem><simpara>
|
||||
* the preferred date representation for the current locale without
|
||||
* the time
|
||||
* </simpara></listitem></varlistentry>
|
||||
* <varlistentry><term>
|
||||
* <literal>\%X</literal>:
|
||||
* </term><listitem><simpara>
|
||||
* the preferred time representation for the current locale without
|
||||
* the date
|
||||
* </simpara></listitem></varlistentry>
|
||||
* <varlistentry><term>
|
||||
* <literal>\%y</literal>:
|
||||
* </term><listitem><simpara>
|
||||
* the year as a decimal number without the century
|
||||
* </simpara></listitem></varlistentry>
|
||||
* <varlistentry><term>
|
||||
* <literal>\%Y</literal>:
|
||||
* </term><listitem><simpara>
|
||||
* the year as a decimal number including the century
|
||||
* </simpara></listitem></varlistentry>
|
||||
* <varlistentry><term>
|
||||
* <literal>\%z</literal>:
|
||||
* </term><listitem><simpara>
|
||||
* the time zone as an offset from UTC (+hhmm)
|
||||
* </simpara></listitem></varlistentry>
|
||||
* <varlistentry><term>
|
||||
* <literal>\%:z</literal>:
|
||||
* </term><listitem><simpara>
|
||||
* the time zone as an offset from UTC (+hh:mm). This is a gnulib strftime extension. Since: 2.38
|
||||
* </simpara></listitem></varlistentry>
|
||||
* <varlistentry><term>
|
||||
* <literal>\%::z</literal>:
|
||||
* </term><listitem><simpara>
|
||||
* the time zone as an offset from UTC (+hh:mm:ss). This is a gnulib strftime extension. Since: 2.38
|
||||
* </simpara></listitem></varlistentry>
|
||||
* <varlistentry><term>
|
||||
* <literal>\%:::z</literal>:
|
||||
* </term><listitem><simpara>
|
||||
* the time zone as an offset from UTC, with : to necessary precision
|
||||
* (e.g., -04, +05:30). This is a gnulib strftime extension. Since: 2.38
|
||||
* </simpara></listitem></varlistentry>
|
||||
* <varlistentry><term>
|
||||
* <literal>\%Z</literal>:
|
||||
* </term><listitem><simpara>
|
||||
* the time zone or name or abbreviation
|
||||
* </simpara></listitem></varlistentry>
|
||||
* <varlistentry><term>
|
||||
* <literal>\%\%</literal>:
|
||||
* </term><listitem><simpara>
|
||||
* a literal <literal>\%</literal> character
|
||||
* </simpara></listitem></varlistentry>
|
||||
* </variablelist>
|
||||
* - \%h: equivalent to \%b
|
||||
* - \%H: the hour as a decimal number using a 24-hour clock (range 00 to 23)
|
||||
* - \%I: the hour as a decimal number using a 12-hour clock (range 01 to 12)
|
||||
* - \%j: the day of the year as a decimal number (range 001 to 366)
|
||||
* - \%k: the hour (24-hour clock) as a decimal number (range 0 to 23);
|
||||
* single digits are preceded by a blank
|
||||
* - \%l: the hour (12-hour clock) as a decimal number (range 1 to 12);
|
||||
* single digits are preceded by a blank
|
||||
* - \%m: the month as a decimal number (range 01 to 12)
|
||||
* - \%M: the minute as a decimal number (range 00 to 59)
|
||||
* - \%p: either "AM" or "PM" according to the given time value, or the
|
||||
* corresponding strings for the current locale. Noon is treated as
|
||||
* "PM" and midnight as "AM".
|
||||
* - \%P: like \%p but lowercase: "am" or "pm" or a corresponding string for
|
||||
* the current locale
|
||||
* - \%r: the time in a.m. or p.m. notation
|
||||
* - \%R: the time in 24-hour notation (\%H:\%M)
|
||||
* - \%s: the number of seconds since the Epoch, that is, since 1970-01-01
|
||||
* 00:00:00 UTC
|
||||
* - \%S: the second as a decimal number (range 00 to 60)
|
||||
* - \%t: a tab character
|
||||
* - \%T: the time in 24-hour notation with seconds (\%H:\%M:\%S)
|
||||
* - \%u: the ISO 8601 standard day of the week as a decimal, range 1 to 7,
|
||||
* Monday being 1. This works well with \%G and \%V.
|
||||
* - \%V: the ISO 8601 standard week number of the current year as a decimal
|
||||
* number, range 01 to 53, where week 1 is the first week that has at
|
||||
* least 4 days in the new year. See g_date_time_get_week_of_year().
|
||||
* This works well with \%G and \%u.
|
||||
* - \%w: the day of the week as a decimal, range 0 to 6, Sunday being 0.
|
||||
* This is not the ISO 8601 standard format -- use \%u instead.
|
||||
* - \%x: the preferred date representation for the current locale without
|
||||
* the time
|
||||
* - \%X: the preferred time representation for the current locale without
|
||||
* the date
|
||||
* - \%y: the year as a decimal number without the century
|
||||
* - \%Y: the year as a decimal number including the century
|
||||
* - \%z: the time zone as an offset from UTC (+hhmm)
|
||||
* - \%:z: the time zone as an offset from UTC (+hh:mm).
|
||||
* This is a gnulib strftime() extension. Since: 2.38
|
||||
* - \%::z: the time zone as an offset from UTC (+hh:mm:ss). This is a
|
||||
* gnulib strftime() extension. Since: 2.38
|
||||
* - \%:::z: the time zone as an offset from UTC, with : to necessary
|
||||
* precision (e.g., -04, +05:30). This is a gnulib strftime() extension. Since: 2.38
|
||||
* - \%Z: the time zone or name or abbreviation
|
||||
* - \%\%: a literal \% character
|
||||
*
|
||||
* Some conversion specifications can be modified by preceding the
|
||||
* conversion specifier by one or more modifier characters. The
|
||||
* following modifiers are supported for many of the numeric
|
||||
* conversions:
|
||||
* <variablelist>
|
||||
* <varlistentry>
|
||||
* <term>O</term>
|
||||
* <listitem>
|
||||
* Use alternative numeric symbols, if the current locale
|
||||
* supports those.
|
||||
* </listitem>
|
||||
* </varlistentry>
|
||||
* <varlistentry>
|
||||
* <term>_</term>
|
||||
* <listitem>
|
||||
* Pad a numeric result with spaces.
|
||||
* This overrides the default padding for the specifier.
|
||||
* </listitem>
|
||||
* </varlistentry>
|
||||
* <varlistentry>
|
||||
* <term>-</term>
|
||||
* <listitem>
|
||||
* Do not pad a numeric result.
|
||||
* This overrides the default padding for the specifier.
|
||||
* </listitem>
|
||||
* </varlistentry>
|
||||
* <varlistentry>
|
||||
* <term>0</term>
|
||||
* <listitem>
|
||||
* Pad a numeric result with zeros.
|
||||
* This overrides the default padding for the specifier.
|
||||
* </listitem>
|
||||
* </varlistentry>
|
||||
* </variablelist>
|
||||
*
|
||||
* - O: Use alternative numeric symbols, if the current locale supports those.
|
||||
* - _: Pad a numeric result with spaces. This overrides the default padding
|
||||
* for the specifier.
|
||||
* - -: Do not pad a numeric result. This overrides the default padding
|
||||
* for the specifier.
|
||||
* - 0: Pad a numeric result with zeros. This overrides the default padding
|
||||
* for the specifier.
|
||||
*
|
||||
* Returns: a newly allocated string formatted to the requested format
|
||||
* or %NULL in the case that there was an error. The string
|
||||
* should be freed with g_free().
|
||||
* or %NULL in the case that there was an error. The string
|
||||
* should be freed with g_free().
|
||||
*
|
||||
* Since: 2.26
|
||||
*/
|
||||
|
||||
Loading…
Reference in New Issue
Block a user