AIR/mxml
1
0
Fork 0
mirror of https://github.com/michaelrsweet/mxml.git synced 2024-11-24 11:25:30 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add a Note: for all of the text/opaque string support (Issue #190)

Browse Source
This commit is contained in:
Michael R Sweet 2018-07-02 18:56:43 -04:00
parent 0b896710b8
commit e796fe4caf
No known key found for this signature in database
GPG Key ID: 999559A027815955
2 changed files with 25 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
mxml-file.c
View File

@ -106,6 +106,12 @@ static int mxml_write_ws(mxml_node_t *node, void *p,
* The constants @code MXML_INTEGER_CALLBACK@, @code MXML_OPAQUE_CALLBACK@,
* @code MXML_REAL_CALLBACK@, and @code MXML_TEXT_CALLBACK@ are defined for
* loading child (data) nodes of the specified type.
*
* Note: The most common programming error when using the Mini-XML library is
* to load an XML file using the @code MXML_TEXT_CALLBACK@, which returns inline
* text as a series of whitespace-delimited words, instead of using the
* @code MXML_OPAQUE_CALLBACK@ which returns the inline text as a single string
* (including whitespace).
*/
mxml_node_t * /* O - First node or @code NULL@ if the file could not be read. */
@ -142,6 +148,12 @@ mxmlLoadFd(mxml_node_t *top, /* I - Top node */
* The constants @code MXML_INTEGER_CALLBACK@, @code MXML_OPAQUE_CALLBACK@,
* @code MXML_REAL_CALLBACK@, and @code MXML_TEXT_CALLBACK@ are defined for
* loading child (data) nodes of the specified type.
*
* Note: The most common programming error when using the Mini-XML library is
* to load an XML file using the @code MXML_TEXT_CALLBACK@, which returns inline
* text as a series of whitespace-delimited words, instead of using the
* @code MXML_OPAQUE_CALLBACK@ which returns the inline text as a single string
* (including whitespace).
*/
mxml_node_t * /* O - First node or @code NULL@ if the file could not be read. */
@ -167,6 +179,12 @@ mxmlLoadFile(mxml_node_t *top, /* I - Top node */
* The constants @code MXML_INTEGER_CALLBACK@, @code MXML_OPAQUE_CALLBACK@,
* @code MXML_REAL_CALLBACK@, and @code MXML_TEXT_CALLBACK@ are defined for
* loading child (data) nodes of the specified type.
*
* Note: The most common programming error when using the Mini-XML library is
* to load an XML file using the @code MXML_TEXT_CALLBACK@, which returns inline
* text as a series of whitespace-delimited words, instead of using the
* @code MXML_OPAQUE_CALLBACK@ which returns the inline text as a single string
* (including whitespace).
*/
mxml_node_t * /* O - First node or @code NULL@ if the string has errors. */

8
mxml-get.c
View File

@ -1,7 +1,7 @@
/*
* Node get functions for Mini-XML, a small XML file parsing library.
*
* Copyright 2014-2017 by Michael R Sweet.
* Copyright 2014-2018 by Michael R Sweet.
*
* These coded instructions, statements, and computer programs are the
* property of Michael R Sweet and are protected by Federal copyright
@ -346,6 +346,12 @@ mxmlGetReal(mxml_node_t *node) /* I - Node to get */
* @code NULL@ is returned if the node (or its first child) is not a text node.
* The "whitespace" argument can be @code NULL@.
*
* Note: Text nodes consist of whitespace-delimited words. You will only get
* single words of text when reading an XML file with @code MXML_TEXT@ nodes.
* If you want the entire string between elements in the XML file, you MUST read
* the XML file with @code MXML_OPAQUE@ nodes and get the resulting strings
* using the @link mxmlGetOpaque@ function instead.
*
* @since Mini-XML 2.7@
*/