Mirrored_Repos/obs-websocket
1
0
Fork 0
mirror of https://github.com/Palakis/obs-websocket.git synced 2024-08-30 18:12:16 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #148 from haganbmj/docs-deprecated

Browse Source 
docs: Add deprecated attribute
This commit is contained in:
Stéphane L 2017-10-27 10:31:16 +02:00 committed by GitHub
commit 8efb30c4ee
2 changed files with 12 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
WSRequestHandler.cpp
View File

@ -420,6 +420,7 @@ void WSRequestHandler::HandleGetSceneList(WSRequestHandler* req) {
* @name SetSourceRender * @name SetSourceRender
* @category sources * @category sources
* @since 0.3 * @since 0.3
* @deprecated Since unreleased. Prefer the use of SetSceneItemProperties.
*/ */
void WSRequestHandler::HandleSetSceneItemRender(WSRequestHandler* req) { void WSRequestHandler::HandleSetSceneItemRender(WSRequestHandler* req) {
if (!req->hasField("source") || if (!req->hasField("source") ||
@ -1180,6 +1181,7 @@ void WSRequestHandler::HandleGetSyncOffset(WSRequestHandler* req) {
* @name SetSceneItemPosition * @name SetSceneItemPosition
* @category sources * @category sources
* @since 4.0.0 * @since 4.0.0
* @deprecated Since unreleased. Prefer the use of SetSceneItemProperties.
*/ */
void WSRequestHandler::HandleSetSceneItemPosition(WSRequestHandler* req) { void WSRequestHandler::HandleSetSceneItemPosition(WSRequestHandler* req) {
if (!req->hasField("item") || if (!req->hasField("item") ||
@ -1231,6 +1233,7 @@ void WSRequestHandler::HandleSetSceneItemPosition(WSRequestHandler* req) {
* @name SetSceneItemTransform * @name SetSceneItemTransform
* @category sources * @category sources
* @since 4.0.0 * @since 4.0.0
* @deprecated Since unreleased. Prefer the use of SetSceneItemProperties.
*/ */
void WSRequestHandler::HandleSetSceneItemTransform(WSRequestHandler* req) { void WSRequestHandler::HandleSetSceneItemTransform(WSRequestHandler* req) {
if (!req->hasField("item") || if (!req->hasField("item") ||
@ -1287,6 +1290,7 @@ void WSRequestHandler::HandleSetSceneItemTransform(WSRequestHandler* req) {
* @name SetSceneItemCrop * @name SetSceneItemCrop
* @category sources * @category sources
* @since 4.1.0 * @since 4.1.0
* @deprecated Since unreleased. Prefer the use of SetSceneItemProperties.
*/ */
void WSRequestHandler::HandleSetSceneItemCrop(WSRequestHandler* req) { void WSRequestHandler::HandleSetSceneItemCrop(WSRequestHandler* req) {
if (!req->hasField("item")) { if (!req->hasField("item")) {

9
docs/protocol.hbs
View File

@ -15,6 +15,10 @@
{{#each this}} {{#each this}}
### {{name}} ### {{name}}
{{#if deprecated}}
- **⚠️ Deprecated. {{deprecated}} ⚠️**
{{/if}}
{{#eq since "unreleased"}} {{#eq since "unreleased"}}
- Unreleased - Unreleased
{{else}} {{else}}
@ -51,6 +55,10 @@ _No additional response items._
{{#each this}} {{#each this}}
### {{name}} ### {{name}}
{{#if deprecated}}
- **⚠️ Deprecated. {{deprecated}} ⚠️**
{{/if}}
{{#eq since "unreleased"}} {{#eq since "unreleased"}}
- Unreleased - Unreleased
{{else}} {{else}}
@ -89,4 +97,3 @@ _No additional response items._
{{/each}} {{/each}}
{{/each}} {{/each}}