Document skipBom in CharReaderBuilder

axic · axic · commit 02605187158e · 2021-09-21T00:54:32.000+01:00
diff --git a/include/json/reader.h b/include/json/reader.h
@@ -324,6 +324,8 @@ 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.

Original file line number	Diff line number	Diff line change
`@@ -324,6 +324,8 @@ class JSON_API CharReaderBuilder : public CharReader::Factory {`
`324`	`324`	* - `"allowSpecialFloats": false or true`
`325`	`325`	`* - If true, special float values (NaNs and infinities) are allowed and`
`326`	`326`	`* their values are lossfree restorable.`
	`327`	+ * - `"skipBom": false or true`
	`328`	`+ * - If true, if the input starts with the Unicode byte order mark (BOM), it is skipped.`
`327`	`329`	`*`
`328`	`330`	* You can examine 'settings_` yourself to see the defaults. You can also
`329`	`331`	`* write and read them just like any JSON Value.`