summaryrefslogtreecommitdiff
path: root/docs/manual.qbk
diff options
context:
space:
mode:
authorArseny Kapoulkine <arseny.kapoulkine@gmail.com>2014-11-17 19:52:23 -0800
committerArseny Kapoulkine <arseny.kapoulkine@gmail.com>2014-11-17 19:52:23 -0800
commite9956ae3a6593efc6f8cb344a00432ece51d1574 (patch)
tree7a26d5c9e7faf32a5119bcc10040aa959b4b8686 /docs/manual.qbk
parent79ed320f894c406dd3548e7d34cadd07fa82fb53 (diff)
Rename xml_document::load to load_string
This should completely eliminate the confusion between load and load_file. Of course, for compatibility reasons we have to preserve the old variant - it will be deprecated in a future version and subsequently removed.
Diffstat (limited to 'docs/manual.qbk')
-rw-r--r--docs/manual.qbk4
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/manual.qbk b/docs/manual.qbk
index 617a971..6d7f4e1 100644
--- a/docs/manual.qbk
+++ b/docs/manual.qbk
@@ -602,7 +602,7 @@ The best way from the performance/memory point of view is to load document using
[#xml_document::load_string]
There is also a simple helper function for cases when you want to load the XML document from null-terminated character string:
- xml_parse_result xml_document::load(const char_t* contents, unsigned int options = parse_default);
+ xml_parse_result xml_document::load_string(const char_t* contents, unsigned int options = parse_default);
It is equivalent to calling `load_buffer` with `size` being either `strlen(contents)` or `wcslen(contents) * sizeof(wchar_t)`, depending on the character type. This function assumes native encoding for input data, so it does not do any encoding conversion. In general, this function is fine for loading small documents from string literals, but has more overhead and less functionality than the buffer loading functions.
@@ -2503,7 +2503,7 @@ Classes:
* `xml_parse_result `[link xml_document::load_stream load]`(std::wistream& stream, unsigned int options = parse_default);`
[lbr]
- * `xml_parse_result `[link xml_document::load_string load]`(const char_t* contents, unsigned int options = parse_default);`
+ * `xml_parse_result `[link xml_document::load_string load_string]`(const char_t* contents, unsigned int options = parse_default);`
[lbr]
* `xml_parse_result `[link xml_document::load_file load_file]`(const char* path, unsigned int options = parse_default, xml_encoding encoding = encoding_auto);`