From 5834c6ed5476e3d97f5628903b9ab6b697923294 Mon Sep 17 00:00:00 2001 From: Chris Angelico Date: Fri, 10 May 2019 18:48:51 +1000 Subject: [PATCH] Switch doc type from Number to int for clarity and precision --- docs/generated/comments.json | 16 ++++++++-------- docs/generated/protocol.md | 8 ++++---- src/WSRequestHandler_General.cpp | 8 ++++---- 3 files changed, 16 insertions(+), 16 deletions(-) diff --git a/docs/generated/comments.json b/docs/generated/comments.json index 7e783099..107fb4e1 100644 --- a/docs/generated/comments.json +++ b/docs/generated/comments.json @@ -2829,10 +2829,10 @@ "subheads": [], "description": "Get basic OBS video information", "return": [ - "{Number} `baseWidth` Base (canvas) width", - "{Number} `baseHeight` Base (canvas) height", - "{Number} `outputWidth` Output width", - "{Number} `outputHeight` Output height", + "{int} `baseWidth` Base (canvas) width", + "{int} `baseHeight` Base (canvas) height", + "{int} `outputWidth` Output width", + "{int} `outputHeight` Output height", "{String} `scaleType` Scaling method used if output size differs from base size", "{double} `fps` Frames rendered per second", "{String} `videoFormat` Video color format", @@ -2845,22 +2845,22 @@ "since": "4.6.0", "returns": [ { - "type": "Number", + "type": "int", "name": "baseWidth", "description": "Base (canvas) width" }, { - "type": "Number", + "type": "int", "name": "baseHeight", "description": "Base (canvas) height" }, { - "type": "Number", + "type": "int", "name": "outputWidth", "description": "Output width" }, { - "type": "Number", + "type": "int", "name": "outputHeight", "description": "Output height" }, diff --git a/docs/generated/protocol.md b/docs/generated/protocol.md index 78fbfc09..f37dbe67 100644 --- a/docs/generated/protocol.md +++ b/docs/generated/protocol.md @@ -1199,10 +1199,10 @@ _No specified parameters._ | Name | Type | Description | | ---- | :---: | ------------| -| `baseWidth` | _Number_ | Base (canvas) width | -| `baseHeight` | _Number_ | Base (canvas) height | -| `outputWidth` | _Number_ | Output width | -| `outputHeight` | _Number_ | Output height | +| `baseWidth` | _int_ | Base (canvas) width | +| `baseHeight` | _int_ | Base (canvas) height | +| `outputWidth` | _int_ | Output width | +| `outputHeight` | _int_ | Output height | | `scaleType` | _String_ | Scaling method used if output size differs from base size | | `fps` | _double_ | Frames rendered per second | | `videoFormat` | _String_ | Video color format | diff --git a/src/WSRequestHandler_General.cpp b/src/WSRequestHandler_General.cpp index b258f98e..62b6fcf3 100644 --- a/src/WSRequestHandler_General.cpp +++ b/src/WSRequestHandler_General.cpp @@ -185,10 +185,10 @@ HandlerResponse WSRequestHandler::HandleGetStats(WSRequestHandler* req) { /** * Get basic OBS video information * - * @return {Number} `baseWidth` Base (canvas) width - * @return {Number} `baseHeight` Base (canvas) height - * @return {Number} `outputWidth` Output width - * @return {Number} `outputHeight` Output height + * @return {int} `baseWidth` Base (canvas) width + * @return {int} `baseHeight` Base (canvas) height + * @return {int} `outputWidth` Output width + * @return {int} `outputHeight` Output height * @return {String} `scaleType` Scaling method used if output size differs from base size * @return {double} `fps` Frames rendered per second * @return {String} `videoFormat` Video color format