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

Expand the g_date_time_format documentation

Browse Source 
Mention strftime, and explain supported modifiers.
This commit is contained in:
Matthias Clasen 2011-05-05 13:40:51 -04:00
parent d23c33a04b
commit e15ecab048
1 changed files with 41 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
glib/gdatetime.c
View File

@ -2088,6 +2088,12 @@ get_numeric_format (gchar *fmt,
*
* Creates a newly allocated string representing the requested @format.
*
* The format strings understood by this function are a subset of the
* strftime() format language. In contrast to strftime(), this function
* always produces a UTF-8 string, regardless of the current locale.
* Note that the rendering of many formats is locale-dependent and may
* not match the strftime() output exactly.
*
* The following format specifiers are supported:
*
* <variablelist>
@ -2264,6 +2270,41 @@ get_numeric_format (gchar *fmt,
* </simpara></listitem></varlistentry>
* </variablelist>
*
* 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>
*
* 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().