frontend komponenttien dokumentointi

breeku · Dec 11, 2020 · 56d61c0 · 56d61c0
1 parent c090baa
commit 56d61c0
Show file tree

Hide file tree

Showing 30 changed files with 1,202 additions and 1,076 deletions.
diff --git a/backend/jsdoc.json b/backend/jsdoc.json
diff --git a/backend/package-lock.json b/backend/package-lock.json
diff --git a/backend/package.json b/backend/package.json
@@ -40,7 +40,5 @@
         "sequelize-cli": "^6.2.0",
         "@cypress/code-coverage": "^3.8.1"
     },
-    "devDependencies": {
-        "jsdoc": "^3.6.6"
-    }
+    "devDependencies": {}
 }
diff --git a/backend/routes/auth.js b/backend/routes/auth.js
@@ -9,9 +9,9 @@ const authRouter = express.Router()
 
 /**
  * Route sisäänkirjautumiseen ja käyttäjätilin luomiseen
- * 
- * @component
+ *
  * @category Kirjautuminen
+ * @subcategory backend
  */
 
 authRouter.post('/login', async (req, res) => {

diff --git a/backend/routes/events.js b/backend/routes/events.js
@@ -9,9 +9,9 @@ const JWTKEY = process.env.JWTKEY
 
 /**
  * Route Tapahtumien varausmäärän hakemiselle, arvostelun hakemiselle, poistamiselle ja päivittämiselle sekä tapahtumien fetchaukselle ja kategorioittain hakemiselle
- * 
- * @component
+ *
  * @category Tapahtumat
+ * @subcategory backend
  */
 
 eventsRouter.get('/reservation/:id/:count', async (req, res) => {

diff --git a/backend/routes/tags.js b/backend/routes/tags.js
@@ -6,9 +6,9 @@ const tagsRouter = express.Router()
 
 /**
  * Route tagien hakemiselle
- * 
- * @component
+ *
  * @category Tagit
+ * @subcategory backend
  */
 
 tagsRouter.get('/', async (req, res) => {

diff --git a/backend/routes/user.js b/backend/routes/user.js
@@ -9,9 +9,9 @@ const JWTKEY = process.env.JWTKEY
 
 /**
  * Route käyttäjätietojen hakemiselle
- * 
- * @component
+ *
  * @category Käyttäjätiedot
+ * @subcategory backend
  */
 
 userRouter.get('/', async (req, res) => {