fix: Fixed linting erros

Author: john-ghatas

frontend/lib/public/Model.js

@@ -55,6 +55,7 @@ export default class Model extends Observable {
 
     /**
      * Delegates sub-model actions depending on new location of the page
+     * @returns {vnode} The page to be loaded
      */
     handleLocationChange() {
         switch (this.router.params.page) {

frontend/lib/public/components/Filters/index.js

@@ -21,9 +21,9 @@ const FILTERS_LIMITS = 5;
 
 /**
  * Checkbox filter
- * @param {Object} model
- * @param {Array} tags
- * @return {vnode}
+ * @param {Object} model Pass the model to access the defined functions
+ * @param {Array} tags Pass the tags to load in the view
+ * @return {vnode} Return the form to be shown
  */
 const checkboxFilter = (model, tags) => {
     const checkboxes = Object.entries(tags).map(([tag, count], index) =>
@@ -56,9 +56,9 @@ const checkboxFilter = (model, tags) => {
 
 /**
  * Render the filters
- * @param {Object} model
- * @param {Array} tags
- * @return {vnode}
+ * @param {Object} model Pass the model to access the defined functions
+ * @param {Array} tags Pass the tags to load in the view
+ * @return {vnode} Return final view of the filtering form
  */
 const filters = (model, tags) =>
     h('.w-25.shadow-level1.p2', [

frontend/lib/public/components/NavBar/index.js

@@ -20,9 +20,9 @@ import { iconPerson } from '/js/src/icons.js';
 
 /**
  * Top header of the page
- * @param {object} model
- * @param {pages}
- * @return {vnode}
+ * @param {Object} model Pass the model to access the defined functions
+ * @param {Array} pages THe pages in defined in the view.js file
+ * @return {vnode} Returns the navbar
  */
 const navBar = (model, pages) =>
     h('.flex-row.justify-between.items-center.ph4.pv2.shadow-level2.level2.bg-gray-light', [
@@ -33,9 +33,10 @@ const navBar = (model, pages) =>
             }),
             h('.f6', 'Logbook'),
         ]),
-        h('btn-group', Object.keys(pages).map((tab) => h(`button.btn.btn-tab ${model.router.params.page === tab ? 'selected' : ''}`, {
-            onclick: () => model.router.go(`?page=${tab}`),
-        }, tab[0].toUpperCase() + tab.slice(1)))),
+        h('btn-group', Object.keys(pages).map((tab) =>
+            h(`button.btn.btn-tab ${model.router.params.page === tab ? 'selected' : ''}`, {
+                onclick: () => model.router.go(`?page=${tab}`),
+            }, tab[0].toUpperCase() + tab.slice(1)))),
         h('button.btn.h3', iconPerson()),
     ]);
 

frontend/lib/public/components/Table/index.js

@@ -19,23 +19,23 @@ import { h } from '/js/src/index.js';
 
 /**
  * Table row header
- * @param {String} header
- * @return {vnode}
+ * @param {String} header The text of the header elements
+ * @return {vnode} Return a single row header element
  */
 const rowHeader = (header) => [h('th', header)];
 
 /**
  * Table data row
- * @param {Object} data
- * @return {vnode}
+ * @param {Object} data The data to be rendered in the child element of the row
+ * @return {vnode} Return a row of data in the table
  */
 const rowData = (data) => [h('td', data)];
 
 /**
  * Renders the table
- * @param {Array} data
- * @param {Array} headers
- * @returns {vnode}
+ * @param {Array} data The data array containing the objects with the data per row
+ * @param {Array} headers The array of of the headers to be rendered in the table
+ * @returns {vnode} Return the total view of the table to rendered
  */
 const table = (data, headers) => h('table.table.shadow-level1.mh3', [
     h('tr', [headers.map((header) => rowHeader(header))]),

frontend/lib/public/view.js

@@ -40,7 +40,8 @@ export default (model) => {
 
 /**
  * Page content
- * @param {object} model
- * @return {vnode}
+ * @param {Object} model Pass the model object to the child
+ * @param {Object} pages Pass the pages to the switchcase
+ * @returns {vnode} Returns a vnode to render the pages
  */
 const content = (model, pages) => h('.p4', switchCase(model.router.params.page, pages)(model));

frontend/lib/public/views/Overview/General/page.js

@@ -23,8 +23,8 @@ export default (model) => [overviewScreen(model)];
 
 /**
  * Table row header
- * @param {object} model
- * @return {vnode}
+ * @param {object} model Pass the model to access the defined functions
+ * @return {vnode} Return the view of the table with the filtering options
  */
 const overviewScreen = (model) => {
     const headers = model.overview.getHeaders();

frontend/lib/public/views/Overview/Overview.js

@@ -22,7 +22,9 @@ import { Observable } from '/js/src/index.js';
  */
 export default class Overview extends Observable {
     /**
-     * @param {Object} model
+     * The constructor of the Overview model object
+     * @param {Object} model Pass the model to access the defined functions
+     * @returns {Object} Constructs the Overview model
      */
     constructor(model) {
         super();
@@ -54,14 +56,16 @@ export default class Overview extends Observable {
     }
 
     /**
-     * @returns {Array} headers
+     * Get the headers from the Overview class
+     * @returns {Array} Returns the headers
      */
     getHeaders() {
         return this.headers;
     }
 
     /**
-     * @returns {Array} subentries
+     * Get the table data
+     * @returns {Array} The data without the tags to be rendered in a table
      */
     getTableData() {
         const subentries = this.filtered.map((entry) => {
@@ -79,7 +83,8 @@ export default class Overview extends Observable {
 
     /**
      * Add filter to the selection
-     * @param {string} tag
+     * @param {string} tag The tag to be added to the filter criteria
+     * @returns {Array} Sets the data according to the filters applied
      */
     addFilter(tag) {
         this.filterCriteria = [...this.filterCriteria, tag];
@@ -88,7 +93,8 @@ export default class Overview extends Observable {
 
     /**
      * Remove filter from the selection
-     * @param {string} condition
+     * @param {string} condition The ocondition to filter the array on
+     * @returns {Array} Sets the array with the new filter criteria
      */
     removeFilter(condition) {
         this.filterCriteria = this.filterCriteria.filter((tag) => tag !== condition);
@@ -97,6 +103,7 @@ export default class Overview extends Observable {
 
     /**
      * Filter the data
+     * @returns {Array} Sets the data according to the amount of applied filters
      */
     getFilteredData() {
         this.filterCriteria.length !== 0
@@ -108,6 +115,7 @@ export default class Overview extends Observable {
 
     /**
      * Filter data by tags if applicable
+     * @returns {Array} Sets the filtered data on the criterium applied by the user
      */
     filterByTags() {
         this.filtered = this.data
@@ -125,8 +133,8 @@ export default class Overview extends Observable {
 
     /**
      * Check for an existing tag
-     * @param {object} entry
-     * @return {bool}
+     * @param {Object} entry The entry in the total array of the data
+     * @return {Boolean} Returns the status of the existence of a tag in the data entry
      */
     checkExistingTag(entry) {
         const check = this.filterCriteria.map((tag) => {
@@ -142,7 +150,7 @@ export default class Overview extends Observable {
 
     /**
      * Counts the tags with their total appearances
-     * @return {object}
+     * @return {Object} Returns the count of each tag
      */
     getTagCounts() {
         return this.data.reduce((accumulator, currentValue) => {