Merge pull request #880 from dnaka91/input-settings-overlay

docs: Document missing `overlay` field
This commit is contained in:
tt2468
2021-12-19 17:11:18 +07:00
committed by GitHub

View File

@ -278,8 +278,9 @@ RequestResult RequestHandler::GetInputSettings(const Request& request)
/** /**
* Sets the settings of an input. * Sets the settings of an input.
* *
* @requestField inputName | String | Name of the input to set the settings of * @requestField inputName | String | Name of the input to set the settings of
* @requestField inputSettings | Object | Object of settings to apply * @requestField inputSettings | Object | Object of settings to apply
* @requestField ?overlay | Boolean | True == apply the settings on top of existing ones, False == reset the input to its defaults, then apply settings. | true
* *
* @requestType SetInputSettings * @requestType SetInputSettings
* @complexity 3 * @complexity 3