From 873ad1b167d479b2415c4e2aaa94f2f471809af6 Mon Sep 17 00:00:00 2001 From: Dominik Nakamura Date: Sun, 19 Dec 2021 16:31:31 +0900 Subject: [PATCH 1/2] docs: Document missing `overlay` field --- src/requesthandler/RequestHandler_Inputs.cpp | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/src/requesthandler/RequestHandler_Inputs.cpp b/src/requesthandler/RequestHandler_Inputs.cpp index 21e90744..ca0a0eb5 100644 --- a/src/requesthandler/RequestHandler_Inputs.cpp +++ b/src/requesthandler/RequestHandler_Inputs.cpp @@ -278,8 +278,10 @@ RequestResult RequestHandler::GetInputSettings(const Request& request) /** * Sets the settings of an input. * - * @requestField inputName | String | Name of the input to set the settings of - * @requestField inputSettings | Object | Object of settings to apply + * @requestField inputName | String | Name of the input to set the settings of + * @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 * @complexity 3 From c3e6bc323a7cec81d6933b22661bd99006a6a98a Mon Sep 17 00:00:00 2001 From: Dominik Nakamura Date: Sun, 19 Dec 2021 17:23:22 +0900 Subject: [PATCH 2/2] Adjust spacing of docs --- src/requesthandler/RequestHandler_Inputs.cpp | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/src/requesthandler/RequestHandler_Inputs.cpp b/src/requesthandler/RequestHandler_Inputs.cpp index ca0a0eb5..3e782bd5 100644 --- a/src/requesthandler/RequestHandler_Inputs.cpp +++ b/src/requesthandler/RequestHandler_Inputs.cpp @@ -280,8 +280,7 @@ RequestResult RequestHandler::GetInputSettings(const Request& request) * * @requestField inputName | String | Name of the input to set the settings of * @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 + * @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 * @complexity 3