From 268f50387550f726f030806845a6ca9247c8cba4 Mon Sep 17 00:00:00 2001 From: Alex Van Camp Date: Sat, 30 Mar 2019 14:26:15 -0500 Subject: [PATCH] docs(jsdoc): clean up types for compatability with obs-websocket-js typedef generator --- docs/generated/comments.json | 4 ++-- docs/generated/protocol.md | 2 +- src/WSRequestHandler_Scenes.cpp | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/generated/comments.json b/docs/generated/comments.json index 7cc069dd..20e74484 100644 --- a/docs/generated/comments.json +++ b/docs/generated/comments.json @@ -3107,7 +3107,7 @@ "description": "Changes the order of scene items in the requested scene.", "param": [ "{String (optional)} `scene` Name of the scene to reorder (defaults to current).", - "{Scene|Array} `items` Ordered list of objects with name and/or id specified. Id preferred due to uniqueness per scene", + "{Array} `items` Ordered list of objects with name and/or id specified. Id preferred due to uniqueness per scene", "{int (optional)} `items[].id` Id of a specific scene item. Unique on a scene by scene basis.", "{String (optional)} `items[].name` Name of a scene item. Sufficiently unique if no scene items share sources within the scene." ], @@ -3122,7 +3122,7 @@ "description": "Name of the scene to reorder (defaults to current)." }, { - "type": "Scene|Array", + "type": "Array", "name": "items", "description": "Ordered list of objects with name and/or id specified. Id preferred due to uniqueness per scene" }, diff --git a/docs/generated/protocol.md b/docs/generated/protocol.md index 6a6948cd..d26b63bf 100644 --- a/docs/generated/protocol.md +++ b/docs/generated/protocol.md @@ -1477,7 +1477,7 @@ Changes the order of scene items in the requested scene. | Name | Type | Description | | ---- | :---: | ------------| | `scene` | _String (optional)_ | Name of the scene to reorder (defaults to current). | -| `items` | _Scene\|Array_ | Ordered list of objects with name and/or id specified. Id preferred due to uniqueness per scene | +| `items` | _Array<Scene>_ | Ordered list of objects with name and/or id specified. Id preferred due to uniqueness per scene | | `items[].id` | _int (optional)_ | Id of a specific scene item. Unique on a scene by scene basis. | | `items[].name` | _String (optional)_ | Name of a scene item. Sufficiently unique if no scene items share sources within the scene. | diff --git a/src/WSRequestHandler_Scenes.cpp b/src/WSRequestHandler_Scenes.cpp index 3cdbf8ad..497d17a0 100644 --- a/src/WSRequestHandler_Scenes.cpp +++ b/src/WSRequestHandler_Scenes.cpp @@ -84,7 +84,7 @@ HandlerResponse WSRequestHandler::HandleGetSceneList(WSRequestHandler* req) { * Changes the order of scene items in the requested scene. * * @param {String (optional)} `scene` Name of the scene to reorder (defaults to current). -* @param {Scene|Array} `items` Ordered list of objects with name and/or id specified. Id preferred due to uniqueness per scene +* @param {Array} `items` Ordered list of objects with name and/or id specified. Id preferred due to uniqueness per scene * @param {int (optional)} `items[].id` Id of a specific scene item. Unique on a scene by scene basis. * @param {String (optional)} `items[].name` Name of a scene item. Sufficiently unique if no scene items share sources within the scene. *