raphael/whiteboard
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fix apidoc

Browse Source
This commit is contained in:
Raphael 2022-02-18 10:53:18 +01:00
parent 20aa0d771b
commit 0d25792e1f
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
scripts/server-backend.js
View File

@ -102,8 +102,8 @@ function startBackendServer(port) {
* *
* @apiParam {Number} wid WhiteboardId you find in the Whiteboard URL * @apiParam {Number} wid WhiteboardId you find in the Whiteboard URL
* @apiParam {Number} [at] Accesstoken (Only if activated for this server) * @apiParam {Number} [at] Accesstoken (Only if activated for this server)
* @apiParam {Number} date current timestamp * @apiParam {Number} [date] current timestamp (This is for the filename on the server; Don't set it if not sure)
* @apiParam {Boolean} webdavaccess set true to upload to webdav (Optional; Only if activated for this server) * @apiParam {Boolean} [webdavaccess] set true to upload to webdav (Optional; Only if activated for this server)
* @apiParam {String} imagedata The imagedata base64 encoded * @apiParam {String} imagedata The imagedata base64 encoded
* *
* @apiSuccess {String} body returns "done" * @apiSuccess {String} body returns "done"
@ -173,14 +173,14 @@ function startBackendServer(port) {
* "removeTextbox", * "removeTextbox",
* "setTextboxPosition", * "setTextboxPosition",
* "setTextboxFontSize", * "setTextboxFontSize",
* "setTextboxFontColor", * "setTextboxFontColor"
* @apiParam {String} [username] The username performing this action. Only relevant for the undo/redo function * @apiParam {String} [username] The username performing this action. Only relevant for the undo/redo function
* @apiParam {Number} [draw] Only has a function if t is set to "addImgBG". Set 1 to draw on canvas; 0 to draw into background * @apiParam {Number} [draw] Only has a function if t is set to "addImgBG". Set 1 to draw on canvas; 0 to draw into background
* @apiParam {String} [url] Only has a function if t is set to "addImgBG", then it has to be set to: [rootUrl]/uploads/[ReadOnlyWid]/[ReadOnlyWid]_[date].png * @apiParam {String} [url] Only has a function if t is set to "addImgBG", then it has to be set to: [rootUrl]/uploads/[ReadOnlyWid]/[ReadOnlyWid]_[date].png
* @apiParam {String} [c] Color: Only used if color is needed (pen, rect, circle, addTextBox ... ) * @apiParam {String} [c] Color: Only used if color is needed (pen, rect, circle, addTextBox ... )
* @apiParam {String} [th] Thickness: Only used if Thickness is needed (pen, rect ... ) * @apiParam {String} [th] Thickness: Only used if Thickness is needed (pen, rect ... )
* @apiParam {Number[]} d has different function on every tool you use: * @apiParam {Number[]} d has different function on every tool you use:
* pen: [width, height, left, top, rotation] * fx. pen or addImgBG: [width, height, left, top, rotation]
* *
* @apiSuccess {String} body returns "done" as text * @apiSuccess {String} body returns "done" as text
* @apiError {Number} 401 Unauthorized * @apiError {Number} 401 Unauthorized