Merge pull request #523 from libexpat/issue-522-fix-return-value-docs

[docs] Fix return value docs on XML_SetBillionLaughs[..] functions (fixes #522)
This commit is contained in:
Sebastian Pipping 2021-12-14 14:56:30 +01:00 committed by GitHub
commit bf2c3f3d89
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 4 additions and 2 deletions

View File

@ -12,6 +12,8 @@ Release 2.4.2 xxx xxx xx xxxx
#495 CMake: MinGW: Fix pkg-config section "Libs" for
- non-release build types (e.g. -DCMAKE_BUILD_TYPE=Debug)
- multi-config CMake generators (e.g. Ninja Multi-Config)
#522 #523 docs: Fix return value docs for both
XML_SetBillionLaughsAttackProtection* functions
Special thanks to:
Dong-hee Na

View File

@ -2102,7 +2102,7 @@ XML_SetBillionLaughsAttackProtectionMaximumAmplification(XML_Parser p,
<a href="https://en.wikipedia.org/wiki/Billion_laughs_attack">billion laughs attacks</a>
(default: <code>100.0</code>)
of parser <code>p</code> to <code>maximumAmplificationFactor</code>, and
returns <code>XML_TRUE</code> upon success and <code>XML_TRUE</code> upon error.
returns <code>XML_TRUE</code> upon success and <code>XML_FALSE</code> upon error.
</p>
The amplification factor is calculated as ..
@ -2152,7 +2152,7 @@ XML_SetBillionLaughsAttackProtectionActivationThreshold(XML_Parser p,
<a href="https://en.wikipedia.org/wiki/Billion_laughs_attack">billion laughs attacks</a>
(default: <code>8 MiB</code>)
of parser <code>p</code> to <code>activationThresholdBytes</code>, and
returns <code>XML_TRUE</code> upon success and <code>XML_TRUE</code> upon error.
returns <code>XML_TRUE</code> upon success and <code>XML_FALSE</code> upon error.
</p>
<p>For a call to <code>XML_SetBillionLaughsAttackProtectionActivationThreshold</code> to succeed:</p>