From cb8fa5ff627eeb798143d95393f87a94e60b59c3 Mon Sep 17 00:00:00 2001 From: "arseny.kapoulkine" Date: Fri, 8 Dec 2006 14:59:45 +0000 Subject: Documentation update git-svn-id: http://pugixml.googlecode.com/svn/trunk@16 99668b35-9821-0410-8761-19e4c4f06640 --- docs/index.html | 26 ++++++++++++++++++++++++-- 1 file changed, 24 insertions(+), 2 deletions(-) (limited to 'docs') diff --git a/docs/index.html b/docs/index.html index 13d28b6..ff6c8b1 100644 --- a/docs/index.html +++ b/docs/index.html @@ -192,6 +192,15 @@ lifetime of the parser.
 
+

+        char* parse(const ownership_transfer_tag&, char* xmlstr, unsigned int optmsk = parse_noset);
+
+
This function parses the provided string with provided options, and returns the position where the +parsing stopped (do not expect, that parsing will stop on every error, or on most of them - as I've +said, pugixml is error ignorant). The input string is modified. The string's ownership is +managed by parser (string's memory is freed automatically when parser's destructor is called). +
 
+

         xml_parser(std::istream& stream, unsigned int optmsk = parse_default);
Just a convenience ctor, that calls the corresponding parse() function.
@@ -202,6 +211,12 @@ lifetime of the parser. xml_parser(char* xmlstr, unsigned int optmsk = parse_default);
Just a convenience ctor, that calls the corresponding parse() function.
+
 
+
+

+        xml_parser(const ownership_transfer_tag&, char* xmlstr, unsigned int optmsk = parse_default);
+
Just a convenience ctor, that calls the corresponding parse() function.
+

If you want to provide XML data after the creation of the parser, use the default ctor. Otherwise @@ -216,7 +231,7 @@ using the following functions:

xml_node document() const; -

Ok, easy part behind - now let's dive into parsing options. There is a variety of them, and you +

Ok, easy part is behind - now let's dive into parsing options. There is a variety of them, and you must choose them wisely to get the needed results and the best speed/least memory overhead. At first, there are flags that determine which parts of the document will be put into DOM tree, and which will be just skipped:

@@ -1020,6 +1035,13 @@ off. The test system is AMD Sempron 2500+, 512 Mb RAM.

FAQ

+

Q: I do not have/want STL support. How can I compile pugixml without STL?

+

A: There is an undocumented define PUGIXML_NO_STL. If you uncomment the relevant line +in pugixml header file, it will compile without any STL classes. The reason it is undocumented +are that it will make some documented functions not available (specifically, xml_parser() ctor and +parse() function that operate on std::istream, xml_node::path function, utf16 and utf8 conversion +functions). Otherwise, it will work fine.

+

I'm always open for questions; feel free to write them to arseny.kapoulkine@gmail.com.

@@ -1123,7 +1145,7 @@ OTHER DEALINGS IN THE SOFTWARE.
-

Revised 7 November, 2006

+

Revised 8 December, 2006

© Copyright Arseny Kapoulkine 2006. All Rights Reserved.

-- cgit v1.2.3