Arseny Kapoulkine
f1f532acfc
docs: Reword last bullet point of thread safety guarantees
...
This was worded somewhat confusingly; we should be explicit that it's
okay to access multiple documents concurrently as long as access to each
one is serialized.
2024-11-05 07:43:54 -08:00
Arseny Kapoulkine
d5f14adb3c
docs: Update documentation to address PUGIXML_HAS_STRING_VIEW changes
...
The PUGIXML_STRING_VIEW define is no longer necessary but
_HAS_STRING_VIEW can be enabled manually if the compiler supports it
without advertising C++17 support.
2024-10-30 10:36:36 -07:00
dantargz
4d0043fb6c
Update VERSION in Makefile and add documentation for string_view_t ( #641 )
...
We now document PUGIXML_HAS_STRING_VIEW and PUGIXML_STRING_VIEW (the latter will be removed in the future) configuration as well as string_view_t type and overloads.
Makefile also had to be fixed to recognize the version properly after pugixml.hpp changes.
2024-10-28 08:06:42 -07:00
Arseny Kapoulkine
7e702740ff
Merge pull request #623 from r-barnes/master
...
throw() -> noexcept
2024-10-22 18:59:45 -07:00
Arseny Kapoulkine
3b17184379
docs: Work around asciidoc bug with TOC numbering
...
For some reason using a code import right before a header breaks
numbering on that header; fix by moving the import above text.
2024-09-12 09:49:35 -07:00
Richard Barnes
6247ece208
throw() -> noexcept
2024-07-16 06:48:23 -07:00
Arseny Kapoulkine
7c66cf7b06
docs: Add C++20 ranges documentation
...
This doesn't require any implementation changes, as the existing support
for C++11 ranged for loops automatically makes nodes and node/attribute
range objects work as C++20 ranges.
Fixes #613 .
2024-05-19 13:24:34 -07:00
Arseny Kapoulkine
b2b4664030
docs: Adjust docs wrt parse_merge_pcdata x parse_embed_pcdata
...
parse_merge_pcdata expects to find node_pcdata nodes which aren't
present when parse_embed_pcdata is active. For now we mention this in
the documentation; changing this is possible in the future, but carries
a small performance penalty so it requires a specific use case.
Fixes #600
2024-01-26 09:23:26 -08:00
Arseny Kapoulkine
3cc2daf449
Update year to 2024 everywhere
...
... except .html files that will be regenerated later.
2024-01-26 09:18:48 -08:00
Arseny Kapoulkine
db78afc2b7
Update version to 1.14 everywhere
2023-09-07 11:55:13 -07:00
Arseny Kapoulkine
bd70bd7662
docs: Update release notes and regenerate HTML documentation
...
The large amount of changes seems to be due to asciidoctor now omitting
empty spans in formatted code.
2023-09-07 11:52:15 -07:00
Arseny Kapoulkine
1a9a41b0f4
Update copyright year (2022 => 2023)
2023-09-06 20:39:25 -07:00
Arseny Kapoulkine
1118066f0b
Merge pull request #576 from vineethkuttan/Merge-pcdata-#546
...
Implement parse_merge_pcdata
2023-09-06 08:01:56 -07:00
Arseny Kapoulkine
efb76c1128
docs: Update external XPath links
...
Both w3schools tutorial and the W3C spec have changed their URLs; I
don't think we actually need the second tutorial so we can simply drop
that one.
2023-08-28 21:26:09 -07:00
Arseny Kapoulkine
5a33d2b1d7
docs: Add forgotten set_name overloads to API reference
2023-08-26 08:38:42 -07:00
Stefan Roellin
f4d4316eba
Add overloads with size_t type argument
...
* bool xml_attribute::set_name(const char_t* rhs, size_t sz)
* bool xml_node::set_name(const char_t* rhs, size_t sz)
2023-08-26 11:30:49 +02:00
Arseny Kapoulkine
0189471a3a
docs: Fix up grammar
2023-08-25 18:48:32 -07:00
vineeth-11316
a28252205a
Final Commit
2023-08-20 10:21:26 +05:30
vineeth-11316
068aa22b1a
documentation Change
2023-08-19 09:54:01 +05:30
Arseny Kapoulkine
e383ce5d82
docs: Update HTML documentation
2023-03-19 15:41:31 -07:00
Arseny Kapoulkine
02930331f8
docs: Add a note to parse_fragment documentation
...
Fixes #554
2023-03-19 15:41:12 -07:00
Arseny Kapoulkine
1dc3266fff
docs: Add missing documentation for xml_node::attribute with hint
...
The feature was added in 2015 but somehow was never documented.
2022-11-08 16:49:34 -08:00
Arseny Kapoulkine
c5b288d91a
Update HTML documentation
2022-10-20 20:20:45 -07:00
Arseny Kapoulkine
0ef3da1e6e
Update release notes and manual for 1.13
...
This includes a previously unnoticed link fix for xml_text::set
2022-10-20 20:18:08 -07:00
Arseny Kapoulkine
314baf6605
docs: Regenerate HTML documentation
2022-02-08 20:09:10 -08:00
Arseny Kapoulkine
eb918f2078
docs: Update manual with 1.12 changelog
2022-02-08 19:59:44 -08:00
Arseny Kapoulkine
25c4fb74a8
Update copyright year to 2022
2022-02-08 19:58:58 -08:00
Arseny Kapoulkine
8bd209fb8b
docs: Update manual to be more explicit about save_file return
...
The function returns true on success and false on failure.
2021-07-09 17:27:01 -07:00
Arseny Kapoulkine
5a0fd5d85f
docs: Rebuild HTML documentation
2020-12-04 16:31:20 -08:00
Ben Boeckel
d1d415e666
docs: add a note about the new imported target name for CMake
2020-12-02 17:17:21 -05:00
Arseny Kapoulkine
fe4bc946b2
Update copyright year to 2020 everywhere
2020-11-26 01:00:27 -08:00
Arseny Kapoulkine
70bd6a6b0a
Update version to 1.11 and update documentation
2020-11-25 10:18:42 -08:00
Arseny Kapoulkine
f49d7acdfb
Clarify the document element behavior.
...
pugixml currently unconditionally accepts documents with multiple
top-level element nodes in absence of parse_fragment. This is an
unfortunate omission; while it can be corrected, it will result in
regressions for some users, and it's trivial to perform the validity
check after the parse is done.
Because of this, for now we're just going to amend documentation here to
both highlight this in the W3C Conformance section, but also to more
strongly push users into realizing that there's just a single document
element (normally).
We might decide to change the behavior here to prohibit such documents
by default in the future, but for now a documentation change seems like
a better tradeoff.
Fixes #337
2020-05-02 09:47:34 -07:00
Tuan Anh Tran
b9b2aeecaf
Custom precision ( #300 )
...
Fixes #285
2019-09-22 08:42:41 -07:00
Tuan Anh Tran
fd7326fb91
feat: add remove_attributes() and remove_children() ( #296 )
...
These functions remove all attributes / child nodes in bulk which is faster than removing them one at a time.
2019-09-17 20:18:41 -07:00
Arseny Kapoulkine
3c59df555b
docs: Update documentation for 1.10 release
...
Update changelog and regenerate HTML documentation.
2019-09-11 21:51:02 -07:00
m-naumann
5a867cb1e3
Add support for using single quotes to enclose attribute values
...
This change adds format_attribute_single_quote flag that uses single quotes (`'`) instead of double quotes (`"`) for formatting attribute values.
Internal quotation marks are escaped using `"` and `'`.
2019-06-18 19:51:10 -07:00
Arseny Kapoulkine
b01569918a
docs: Regenerate HTML documentation
...
Includes wording fixes and format_skip_control_chars
2019-03-09 06:55:55 -08:00
Yan Pas
138976fd95
unit test and doc
2019-03-08 19:17:19 +03:00
Arseny Kapoulkine
160c1c23d9
docs: Improve null node comparison wording
...
Change confusing wording: null nodes compare as equal to null handles, the previous wording implied that each null handle is unique
2019-01-25 16:42:25 -08:00
Arseny Kapoulkine
b67ef29c08
docs: Draw attention to the fact that you have to compile pugixml.cpp
...
This may or may not make it more clear that pugixml.cpp has to be
compiled - either as one of the projects or as a standalone project via
CMake et al - for it to work by default.
Fixes #256 .
2019-01-19 18:25:25 -08:00
Arseny Kapoulkine
9fcae40bb5
Happy New Year!
2019-01-01 23:05:04 +03:00
Arseny Kapoulkine
fa686f004a
Update all URLs to pugixml.org to https://
2018-11-12 12:28:54 -08:00
Arseny Kapoulkine
e584ea337e
docs: Mention that node is a container of children in ranged for section
...
This is implicitly true due to the following section, but that was
written before C++11 so this does deserve a special mention in ranged
for section as well.
Fixes #210 .
2018-05-17 08:04:47 -07:00
Arseny Kapoulkine
341cea5a32
docs: Fix changelog formatting
2018-04-04 08:26:21 -07:00
Arseny Kapoulkine
be260a09c1
docs: Regenerate HTML documentation
2018-04-02 21:46:57 -07:00
Arseny Kapoulkine
cff1933ec9
docs: Update changelog
2018-04-02 21:07:58 -07:00
Arseny Kapoulkine
cb0e8937da
docs: Update v1.9 release date to 04.04
2018-04-02 19:15:23 -07:00
Arseny Kapoulkine
cec32da2b5
docs: Update changelog
...
Mention ubsan fixes; these fixes probably fix compact mode on some
64-bit architecture where unaligned pointer reads aren't valid as well
but it's probably not very relevant...
2018-03-16 21:34:56 -07:00
Arseny Kapoulkine
655bc825a1
docs: Add preliminary 1.9 changelog
...
Still trying to decide if the next version should be 1.9 or 1.8x and
what other changes need to go in.
2018-03-12 19:00:31 -07:00
Arseny Kapoulkine
3f28a5d97a
Update all copyright notices to specify year 2018
2018-01-07 20:28:42 -08:00
Arseny Kapoulkine
f360842d48
docs: Fix a typo in dom_tree.png
...
<mesh> node attribute name is "name", not "mesh".
2017-12-29 17:03:54 -08:00
Arseny Kapoulkine
cb7b78b039
docs: Fixed quickstart links
...
Fixes #176 .
2017-12-22 10:40:42 -08:00
Arseny Kapoulkine
900a1cc943
docs: Clarify Unicode validation behavior
...
It has always been the case that pugixml does not perform Unicode
validation or name/tag Unicode character class validation, but it wasn't
very obvious from documentation.
Fixes #162
2017-08-29 20:46:30 -07:00
Arseny Kapoulkine
4f2ad720c8
docs: Update encoding conversion description
...
We support Latin-1 and automatically detect it by parsing the encoding
from document declaration; both of these were omitted from the
description of the automatic detection.
Additionally, the description has been rewritten to be more concise and
a bit more abstract - there's no need to specify the algorithm precisely
here.
Fixes #158 .
2017-08-21 20:54:38 -07:00
Arseny Kapoulkine
d3b9e4e1e8
Update copyright year to 2017
2017-01-26 20:12:06 -08:00
Arseny Kapoulkine
91bf70231a
docs: Regenerate HTML documentation
2016-11-24 00:23:19 -08:00
Arseny Kapoulkine
80adb4ca5c
Set 1.8 release date to (tentatively) Nov 24.
2016-11-13 17:04:33 -08:00
Arseny Kapoulkine
c225b722cf
docs: Add documentation for format_no_empty_element_tags
...
Also add it to the changelog for 1.8
2016-11-09 09:19:19 -08:00
Arseny Kapoulkine
57ef4ad459
docs: Add changelog draft for 1.8
2016-11-09 08:56:43 -08:00
Diga Widyaprana
ddc8c1a795
Fix broken link
2016-09-22 14:03:13 +08:00
Arseny Kapoulkine
ac4a84df4d
docs: Add documentation for long setters
2016-02-02 08:52:47 -08:00
Stephan Beyer
f7aa65db8a
Fix whitespace issues
...
Git warns when it finds "whitespace errors". This commit gets
rid of these whitespace errors for code and adoc files.
2016-01-24 14:05:44 +01:00
Arseny Kapoulkine
7aef75f43d
docs: Adjust as_int documentation to match implementation
...
Also remove the description of behavior for trailing non-numeric characters.
It's likely this will become a parse error in the future so better leave it
as unspecified for now.
Fixes #80 .
2016-01-19 21:17:08 -08:00
Arseny Kapoulkine
85238132d3
docs: Add parse_embed_pcdata documentation
2016-01-12 20:38:45 -08:00
Arseny Kapoulkine
ad3b492c1a
docs: Regenerate HTML documentation
2015-12-31 17:22:41 +03:00
Arseny Kapoulkine
5f58e9bd0c
Update all license/copyright texts to 2016
2015-12-31 17:22:21 +03:00
Arseny Kapoulkine
af7177e77d
docs: Use ISO-8601 for changelog dates
2015-12-31 17:11:54 +03:00
Arseny Kapoulkine
a3a9d53860
docs: Fix CDATA example
...
Fixes #61 .
2015-10-19 20:55:39 -07:00
Arseny Kapoulkine
7d2842e670
docs: Add iOS to the list of supported platforms
2015-10-19 00:11:10 -07:00
Arseny Kapoulkine
5b2f014fc7
docs: Update packaging info
2015-10-18 21:01:14 -07:00
Arseny Kapoulkine
0c8024920f
docs: Update release date
2015-10-18 20:13:52 -07:00
Arseny Kapoulkine
471f2260d0
docs: Rewrite Portability section
2015-10-18 18:23:17 -07:00
Arseny Kapoulkine
67702277e6
docs: Add a note about moving xpath_query
2015-10-17 08:59:41 -07:00
Arseny Kapoulkine
9aa28f1d05
docs: Regenerate HTML documentation
2015-10-10 13:51:34 -07:00
Arseny Kapoulkine
6b26a9a7f6
docs: Correct the acknowledgment section
2015-10-10 13:42:56 -07:00
Arseny Kapoulkine
6fa0b39390
docs: Update changelog for 1.7
2015-10-10 13:04:06 -07:00
Arseny Kapoulkine
ce4ac17780
docs: Clarify UTF-8 vs wchar_t memory efficiency
2015-08-14 07:55:24 -07:00
Arseny Kapoulkine
c55e551235
docs: Add PUGIXML_COMPACT documentation
...
Also add PUGIXML_COMPACT to pugiconfig.hpp
2015-08-14 07:55:24 -07:00
Arseny Kapoulkine
d4fedd6775
docs: Clarify hash_value behavior
...
Fixes #43 .
2015-06-24 09:45:26 -07:00
Arseny Kapoulkine
e977f04fe2
docs: Add format_indent_attributes documentation
...
Slightly reword format_indent description.
2015-04-13 21:50:24 -07:00
Arseny Kapoulkine
f04b56e178
Permit custom allocation function to throw
...
Ensure that all the necessary cleanup is performed in case the allocation fails
with an exception - files are closed, buffers are reclaimed, etc.
Any test that triggers a simulated out-of-memory condition is ran once again
with a throwing allocation function. Unobserved std::bad_alloc count as test
failures and require CHECK_ALLOC_FAIL macro.
Fixes #17 .
2015-04-12 21:46:48 -07:00
Arseny Kapoulkine
9b8553bf4b
docs: Update release date
2015-04-10 20:49:47 -07:00
Arseny Kapoulkine
10ff488eb9
docs: Use automatically retrieved version for docs
...
This eliminates one more hardcoded version from the repo, yay!
2015-03-24 20:59:04 -07:00
Arseny Kapoulkine
e35058cfda
docs: Add generated documentation
2015-03-24 20:07:19 -07:00
Arseny Kapoulkine
80a8a77af4
docs: Finishing touches
...
It's almost done; the only remaining issue is that some section titles are too long.
2015-03-24 10:03:08 -07:00
Arseny Kapoulkine
9a55571725
docs: Reword documentation note
2015-03-22 10:44:46 -07:00
Arseny Kapoulkine
c0374b8a48
docs: Minor API reference improvements
2015-03-22 10:40:18 -07:00
Arseny Kapoulkine
3f3e4525e1
docs: Fix several internal links
2015-03-22 10:08:35 -07:00
Arseny Kapoulkine
5644027990
docs: HTML validity fixes
...
Also minor wording fixes.
2015-03-22 09:50:55 -07:00
Arseny Kapoulkine
40fa405751
docs: Converted some samples to Unix newline
2015-03-22 01:01:46 -07:00
Arseny Kapoulkine
56bdc6c5ea
docs: Extract configuration to config.adoc
2015-03-22 00:35:06 -07:00
Arseny Kapoulkine
c94e8a7c0e
docs: Remove old Quickbook sources
2015-03-22 00:16:14 -07:00
Arseny Kapoulkine
d4f9047b2f
docs: Fix PUGIXML_HEADER_ONLY description
...
Users no longer need to #include "pugixml.cpp"
2015-03-22 00:14:48 -07:00
Arseny Kapoulkine
11054219de
docs: A lot of small fixes
...
Mostly added correct quotation to changelog.
2015-03-22 00:11:19 -07:00
Arseny Kapoulkine
55081aca8b
docs: Set up cross-referencing and anchors
...
This is mostly done using regex replaces of original Quickbook markup, plus a
bit of manual fixup for multiple references to the single point from different
lines that AsciiDoc does not seem to handle.
2015-03-21 23:37:33 -07:00
Arseny Kapoulkine
054bffb195
docs: API reference is closer to being done
...
Still need to replace [link ] with actual links.
Also a bunch of small fixes here and there.
2015-03-21 23:09:29 -07:00
Arseny Kapoulkine
363b7a3b22
docs: Fix nested lists and changelog
2015-03-21 22:23:03 -07:00
Arseny Kapoulkine
5f8cd17ff6
docs: Fix tables and images in the manual
...
Also remove redundant [lbr]
2015-03-21 21:56:54 -07:00
Arseny Kapoulkine
b9177ab7b5
docs: Remove image thumbnails
2015-03-21 21:53:50 -07:00