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 #287 from Lange/4.5.1-types-cleanup

Browse Source 
docs(jsdoc): clean up types for compatability with obs-websocket-js typedef generator
This commit is contained in:
Stéphane Lepin 2019-03-30 22:08:09 +01:00 committed by GitHub
commit 71d523437e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/generated/comments.json
View File

@ -3107,7 +3107,7 @@
"description": "Changes the order of scene items in the requested scene.", "description": "Changes the order of scene items in the requested scene.",
"param": [ "param": [
"{String (optional)} `scene` Name of the scene to reorder (defaults to current).", "{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<Scene>} `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.", "{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." "{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)." "description": "Name of the scene to reorder (defaults to current)."
}, },
{ {
"type": "Scene|Array", "type": "Array<Scene>",
"name": "items", "name": "items",
"description": "Ordered list of objects with name and/or id specified. Id preferred due to uniqueness per scene" "description": "Ordered list of objects with name and/or id specified. Id preferred due to uniqueness per scene"
}, },

2
docs/generated/protocol.md
View File

@ -1477,7 +1477,7 @@ Changes the order of scene items in the requested scene.
| Name | Type | Description | | Name | Type | Description |
| ---- | :---: | ------------| | ---- | :---: | ------------|
| `scene` | _String (optional)_ | Name of the scene to reorder (defaults to current). | | `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&lt;Scene&gt;_ | 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[].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. | | `items[].name` | _String (optional)_ | Name of a scene item. Sufficiently unique if no scene items share sources within the scene. |

2
src/WSRequestHandler_Scenes.cpp
View File

@ -84,7 +84,7 @@ HandlerResponse WSRequestHandler::HandleGetSceneList(WSRequestHandler* req) {
* Changes the order of scene items in the requested scene. * Changes the order of scene items in the requested scene.
* *
* @param {String (optional)} `scene` Name of the scene to reorder (defaults to current). * @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<Scene>} `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 {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. * @param {String (optional)} `items[].name` Name of a scene item. Sufficiently unique if no scene items share sources within the scene.
* *