From c516c89c97ecd2a440d9183eb2a8e455e14ad6c9 Mon Sep 17 00:00:00 2001 From: Brendan Hagan Date: Wed, 25 Oct 2017 11:59:14 -0500 Subject: [PATCH] docs: Add deprecated attribute --- WSRequestHandler.cpp | 4 ++++ docs/protocol.hbs | 9 ++++++++- 2 files changed, 12 insertions(+), 1 deletion(-) diff --git a/WSRequestHandler.cpp b/WSRequestHandler.cpp index a104268b..3b594d9b 100644 --- a/WSRequestHandler.cpp +++ b/WSRequestHandler.cpp @@ -422,6 +422,7 @@ void WSRequestHandler::HandleGetSceneList(WSRequestHandler* req) { * @name SetSourceRender * @category sources * @since 0.3 + * @deprecated Since unreleased. Prefer the use of SetSceneItemProperties. */ void WSRequestHandler::HandleSetSceneItemRender(WSRequestHandler* req) { if (!req->hasField("source") || @@ -1190,6 +1191,7 @@ void WSRequestHandler::HandleGetSyncOffset(WSRequestHandler* req) { * @name SetSceneItemPosition * @category sources * @since 4.0.0 + * @deprecated Since unreleased. Prefer the use of SetSceneItemProperties. */ void WSRequestHandler::HandleSetSceneItemPosition(WSRequestHandler* req) { if (!req->hasField("item") || @@ -1241,6 +1243,7 @@ void WSRequestHandler::HandleSetSceneItemPosition(WSRequestHandler* req) { * @name SetSceneItemTransform * @category sources * @since 4.0.0 + * @deprecated Since unreleased. Prefer the use of SetSceneItemProperties. */ void WSRequestHandler::HandleSetSceneItemTransform(WSRequestHandler* req) { if (!req->hasField("item") || @@ -1297,6 +1300,7 @@ void WSRequestHandler::HandleSetSceneItemTransform(WSRequestHandler* req) { * @name SetSceneItemCrop * @category sources * @since 4.1.0 + * @deprecated Since unreleased. Prefer the use of SetSceneItemProperties. */ void WSRequestHandler::HandleSetSceneItemCrop(WSRequestHandler* req) { if (!req->hasField("item")) { diff --git a/docs/protocol.hbs b/docs/protocol.hbs index 28bbd5a6..592d03b7 100644 --- a/docs/protocol.hbs +++ b/docs/protocol.hbs @@ -15,6 +15,10 @@ {{#each this}} ### {{name}} +{{#if deprecated}} +- **⚠️ Deprecated. {{deprecated}} ⚠️** +{{/if}} + {{#eq since "unreleased"}} - Unreleased {{else}} @@ -51,6 +55,10 @@ _No additional response items._ {{#each this}} ### {{name}} +{{#if deprecated}} +- **⚠️ Deprecated. {{deprecated}} ⚠️** +{{/if}} + {{#eq since "unreleased"}} - Unreleased {{else}} @@ -89,4 +97,3 @@ _No additional response items._ {{/each}} {{/each}} -