/**
* SECTION:markup
- * @Title: Simple XML Subset Parser * @Short_description: parses a subset of XML
- * @See_also: <ulink url="http://www.w3.org/TR/REC-xml/">XML
- * Specification</ulink>
+ * @Title: Simple XML Subset Parser
+ * @Short_description: parses a subset of XML
+ * @See_also: [XML Specification](http://www.w3.org/TR/REC-xml/)
*
* The "GMarkup" parser is intended to parse a simple markup format
* that's a subset of XML. This is a small, efficient, easy-to-use
* the parser may accept documents that an XML parser would not.
* However, XML documents which are not well-formed (which is a
* weaker condition than being valid. See the
- * <ulink url="http://www.w3.org/TR/REC-xml/">XML specification</ulink>
- * for definitions of these terms.) are not considered valid GMarkup documents.
+ * [XML specification](http://www.w3.org/TR/REC-xml/)
+ * for definitions of these terms.) are not considered valid GMarkup
+ * documents.
*
* Simplifications to XML include:
*
*
* - Attributes
*
- * - 5 standard entities: &amp; &lt; &gt; &quot; &apos;
+ * - 5 standard entities: & < > " '
*
* - Character references
*
* the parse context can't continue to parse text (you have to
* free it and create a new parse context).
*
- * Return value: a new #GMarkupParseContext
+ * Returns: a new #GMarkupParseContext
**/
GMarkupParseContext *
g_markup_parse_context_new (const GMarkupParser *parser,
normalize_attribute = FALSE;
/*
- * Meeks' theorum: unescaping can only shrink text.
+ * Meeks' theorem: unescaping can only shrink text.
* for < etc. this is obvious, for  more
* thought is required, but this is patently so.
*/
* is reported, no further data may be fed to the #GMarkupParseContext;
* all errors are fatal.
*
- * Return value: %FALSE if an error occurred, %TRUE on success
+ * Returns: %FALSE if an error occurred, %TRUE on success
*/
gboolean
g_markup_parse_context_parse (GMarkupParseContext *context,
* This function reports an error if the document isn't complete,
* for example if elements are still open.
*
- * Return value: %TRUE on success, %FALSE if an error was set
+ * Returns: %TRUE on success, %FALSE if an error was set
*/
gboolean
g_markup_parse_context_end_parse (GMarkupParseContext *context,
* if (strcmp (element_name, "count-these") == 0)
* start_counting (context);
*
- * /* else, handle other tags... */
+ * // else, handle other tags...
* }
*
* static void end_element (context, element_name, ...)
* if (strcmp (element_name, "count-these") == 0)
* g_print ("Counted %d tags\n", end_counting (context));
*
- * /* else, handle other tags... */
+ * // else, handle other tags...
* }
* ]|
*
* of line endings and attribute values.
*
* Note also that this function will produce character references in
- * the range of &#x1; ... &#x1f; for all control sequences
+ * the range of  ...  for all control sequences
* except for tabstop, newline and carriage return. The character
* references in this range are not valid XML 1.0, but they are
* valid XML 1.1 and will be accepted by the GMarkup parser.
*
- * Return value: a newly allocated string with the escaped text
+ * Returns: a newly allocated string with the escaped text
*/
gchar*
g_markup_escape_text (const gchar *text,
* Partially based on code from printf-parser.c,
* Copyright (C) 1999-2000, 2002-2003 Free Software Foundation, Inc.
*
- * Return value: pointer to the next conversion in @format,
+ * Returns: pointer to the next conversion in @format,
* or %NULL, if none.
*/
static const char *
* all string and character arguments in the fashion
* of g_markup_escape_text(). See g_markup_printf_escaped().
*
- * Return value: newly allocated result from formatting
+ * Returns: newly allocated result from formatting
* operation. Free with g_free().
*
* Since: 2.4
* To find the span of the first argument, we find the first position
* where the two arguments differ, which tells us that the first
* argument formatted to "Susan & Fred". We then escape that
- * to "Susan & Fred" and join up with the intermediate portions
+ * to "Susan & Fred" and join up with the intermediate portions
* of the format string and the second argument to get
- * "Susan & Fred ate 5 apples".
+ * "Susan & Fred ate 5 apples".
*/
/* Create the two modified format strings
* store, item);
* ]|
*
- * Return value: newly allocated result from formatting
+ * Returns: newly allocated result from formatting
* operation. Free with g_free().
*
* Since: 2.4
* %G_MARKUP_ERROR_INVALID_CONTENT). In all of these cases %FALSE
* will be returned and @error will be set as appropriate.
*
- * Return value: %TRUE if successful
+ * Returns: %TRUE if successful
*
* Since: 2.16
**/
projects / platform / upstream / glib.git / blobdiff