GKeyFile: Convert docs to markdown

In particular, convert lists to markdown syntax.
This commit is contained in:
Matthias Clasen 2014-02-01 10:14:59 -05:00
parent 9f896667f8
commit c4da8f426a

View File

@ -132,20 +132,21 @@
* *
* This syntax is obviously inspired by the .ini files commonly met * This syntax is obviously inspired by the .ini files commonly met
* on Windows, but there are some important differences: * on Windows, but there are some important differences:
* <itemizedlist> *
* <listitem>.ini files use the ';' character to begin comments, * - .ini files use the ';' character to begin comments,
* key files use the '#' character.</listitem> * key files use the '#' character.
* <listitem>Key files do not allow for ungrouped keys meaning only *
* comments can precede the first group.</listitem> * - Key files do not allow for ungrouped keys meaning only
* <listitem>Key files are always encoded in UTF-8.</listitem> * comments can precede the first group.
* <listitem>Key and Group names are case-sensitive. For example, a *
* group called <literal>[GROUP]</literal> is a different from * - Key files are always encoded in UTF-8.
* <literal>[group]</literal>.</listitem> *
* <listitem>.ini files don't have a strongly typed boolean entry type, * - Key and Group names are case-sensitive. For example, a group called
* they only have GetProfileInt(). In key files, only * [GROUP] is a different from [group].
* <literal>true</literal> and <literal>false</literal> (in lower case) *
* are allowed.</listitem> * - .ini files don't have a strongly typed boolean entry type,
* </itemizedlist> * they only have GetProfileInt(). In key files, only
* true and false (in lower case) are allowed.
* *
* Note that in contrast to the * Note that in contrast to the
* <ulink url="http://freedesktop.org/Standards/desktop-entry-spec">Desktop * <ulink url="http://freedesktop.org/Standards/desktop-entry-spec">Desktop