From 7feb8e0c6acfe5894832f20083d54913bb2bef62 Mon Sep 17 00:00:00 2001 From: les Date: Sun, 2 Feb 2020 15:02:37 +0100 Subject: [PATCH] experimenting with jsdoc tags --- server/api/index.js | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/server/api/index.js b/server/api/index.js index 5c559c16..a18ffc70 100644 --- a/server/api/index.js +++ b/server/api/index.js @@ -24,8 +24,8 @@ api.use(express.json()) /** * Get current authenticated user * @category User - * @path /api/user - * @method GET + * @name /api/user + * @type GET */ api.get('/user', isAuth, (req, res) => res.json(req.user)) @@ -53,9 +53,9 @@ api.put('/place', isAdmin, eventController.updatePlace) /** * Add a new event * @category Event - * @path /event - * @method POST - * @note `Content-Type` has to be `multipart/form-data` 'cause support image upload + * @name /event + * @type POST + * @info `Content-Type` has to be `multipart/form-data` 'cause support image upload * @param {string} title - event's title * @param {string} description - event's description (html accepted and sanitized) * @param {string} place_name - the name of the place