luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-02-09 04:15:49 +01:00
Code Issues Packages Projects Releases Wiki Activity

gmarkup: Convert docs to markdown

Browse Source 
In particular, convert lists to markdown syntax.
This commit is contained in:
Matthias Clasen 2014-02-01 10:15:52 -05:00
parent 85d612a968
commit 99b53a0aaf
1 changed files with 24 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
glib/gmarkup.c
View File

@ -39,8 +39,7 @@
/** /**
* SECTION:markup * SECTION:markup
* @Title: Simple XML Subset Parser * @Title: Simple XML Subset Parser * @Short_description: parses a subset of XML
* @Short_description: parses a subset of XML
* @See_also: <ulink url="http://www.w3.org/TR/REC-xml/">XML * @See_also: <ulink url="http://www.w3.org/TR/REC-xml/">XML
* Specification</ulink> * Specification</ulink>
* *
@ -56,31 +55,33 @@
* *
* GMarkup is not guaranteed to signal an error on all invalid XML; * GMarkup is not guaranteed to signal an error on all invalid XML;
* the parser may accept documents that an XML parser would not. * the parser may accept documents that an XML parser would not.
* However, XML documents which are not well-formed<footnote * However, XML documents which are not well-formed (which is a
* id="wellformed">Being wellformed is a weaker condition than being * weaker condition than being valid. See the
* valid. See the <ulink url="http://www.w3.org/TR/REC-xml/">XML * <ulink url="http://www.w3.org/TR/REC-xml/">XML specification</ulink>
* specification</ulink> for definitions of these terms.</footnote> * for definitions of these terms.) are not considered valid GMarkup documents.
* are not considered valid GMarkup documents.
* *
* Simplifications to XML include: * Simplifications to XML include:
* <itemizedlist> *
* <listitem>Only UTF-8 encoding is allowed</listitem> * - Only UTF-8 encoding is allowed
* <listitem>No user-defined entities</listitem> *
* <listitem>Processing instructions, comments and the doctype declaration * - No user-defined entities
* are "passed through" but are not interpreted in any way</listitem> *
* <listitem>No DTD or validation.</listitem> * - Processing instructions, comments and the doctype declaration
* </itemizedlist> * are "passed through" but are not interpreted in any way
*
* - No DTD or validation
* *
* The markup format does support: * The markup format does support:
* <itemizedlist> *
* <listitem>Elements</listitem> * - Elements
* <listitem>Attributes</listitem> *
* <listitem>5 standard entities: * - Attributes
* <literal>&amp;amp; &amp;lt; &amp;gt; &amp;quot; &amp;apos;</literal> *
* </listitem> * - 5 standard entities: &amp;amp; &amp;lt; &amp;gt; &amp;quot; &amp;apos;
* <listitem>Character references</listitem> *
* <listitem>Sections marked as CDATA</listitem> * - Character references
* </itemizedlist> *
* - Sections marked as CDATA
*/ */
G_DEFINE_QUARK (g-markup-error-quark, g_markup_error) G_DEFINE_QUARK (g-markup-error-quark, g_markup_error)