diff --git a/.eslintrc.js b/.eslintrc.js index f867aa193..5327e74a8 100644 --- a/.eslintrc.js +++ b/.eslintrc.js @@ -3,6 +3,6 @@ module.exports = { 'nextcloud' ], rules: { - 'valid-jsdoc': ['warn'], + 'valid-jsdoc': ['off'], } } diff --git a/src/services/BoardApi.js b/src/services/BoardApi.js index 7d8474ed1..e1f6868e7 100644 --- a/src/services/BoardApi.js +++ b/src/services/BoardApi.js @@ -37,8 +37,8 @@ export class BoardApi { /** * Updates a board. * - * @param {Board} board - * @returns Promise + * @param {Board} board the board object to update + * @returns {Promise} */ updateBoard(board) { return axios.put(this.url(`/boards/${board.id}`), board) @@ -57,10 +57,13 @@ export class BoardApi { /** * Creates a new board. + * @typedef {Object} BoardCreateObject + * @property {string} title + * @property {string} color * - * @param {{String title, String color}} boardData The board data to send. - * color the hexadecimal color value formated /[0-9A-F]{6}/i - * @return Promise + * @param {BoardCreateObject} boardData The board data to send. + * color the hexadecimal color value formated /[0-9A-F]{6}/i + * @returns {Promise} */ createBoard(boardData) { return axios.post(this.url('/boards'), boardData) diff --git a/src/services/StackApi.js b/src/services/StackApi.js index 0732bce4f..2c61abe8b 100644 --- a/src/services/StackApi.js +++ b/src/services/StackApi.js @@ -92,7 +92,7 @@ export class StackApi { } /** - * @param {Stack} stack + * @param {Stack} stack stack object to create * @returns {Promise} */ createStack(stack) {