GDateTime: Convert docs to markdown

In particular convert sections and lists to markdown syntax.
This commit is contained in:
Matthias Clasen 2014-02-01 10:11:38 -05:00
parent 5cf14b0cc2
commit ef3796d3fd

View File

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