Document skipBom in CharReaderBuilder (open-source-parsers#1332)

lytsfeng · Sep 21, 2021 · 94a6220 · 94a6220
1 parent c39fbda
commit 94a6220
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/include/json/reader.h b/include/json/reader.h
@@ -324,6 +324,9 @@ class JSON_API CharReaderBuilder : public CharReader::Factory {
    * - `"allowSpecialFloats": false or true`
    *   - If true, special float values (NaNs and infinities) are allowed and
    *     their values are lossfree restorable.
+   * - `"skipBom": false or true`
+   *   - If true, if the input starts with the Unicode byte order mark (BOM),
+   *     it is skipped.
    *
    * You can examine 'settings_` yourself to see the defaults. You can also
    * write and read them just like any JSON Value.