kewlnamehuh / pugixml

Automatically exported from code.google.com/p/pugixml
0 stars 0 forks source link

Inconsistent/incorrect documentation of format_no_escapes #201

Closed GoogleCodeExporter closed 9 years ago

GoogleCodeExporter commented 9 years ago
The documentation of format_no_escapes in the manual currently reads:

"format_no_escapes disables output escaping for attribute values and PCDATA 
contents. If this flag is on, special symbols (', &, <, >) and all 
non-printable characters (those with codepoint values less than 32) are 
converted to XML escape sequences (i.e. &amp;) during output. If this flag is 
off, no text processing is performed; therefore, output XML can be malformed if 
output contents contains invalid symbols (i.e. having a stray < in the PCDATA 
will make the output malformed). This flag is on by default."

The source comment reads:
"Don't escape attribute values and PCDATA contents. This flag is off by 
default."

The latter is more consistent with the name of the flag and the format_default 
value, so I believe the documentation should read:

"format_no_escapes disables output escaping for attribute values and PCDATA 
contents. If this flag is off, special symbols (', &, <, >) and all 
non-printable characters (those with codepoint values less than 32) are 
converted to XML escape sequences (i.e. &amp;) during output. If this flag is 
on, no text processing is performed; therefore, output XML can be malformed if 
output contents contains invalid symbols (i.e. having a stray < in the PCDATA 
will make the output malformed). This flag is off by default."

Original issue reported on code.google.com by adam.m.a.bowen@gmail.com on 6 Mar 2013 at 12:22

GoogleCodeExporter commented 9 years ago
You're right. Thanks for noticing! I'll correct the documentation.

Original comment by arseny.k...@gmail.com on 6 Mar 2013 at 4:05

GoogleCodeExporter commented 9 years ago
Fixed in r945; I can't update online docs yet since they include documentation 
for some new features.

Original comment by arseny.k...@gmail.com on 20 Mar 2013 at 2:37