style(lib): add some JSDoc comments

emanuelgsouza · Oct 30, 2019 · 7fc33a2 · 7fc33a2
1 parent 396b304
commit 7fc33a2
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 1 deletion.
diff --git a/src/utils/bmi-table.js b/src/utils/bmi-table.js
@@ -1,6 +1,9 @@
 import * as GENRES from './genres'
 import { gte, lte, inRange } from './helpers'
 
+/**
+ * @type{Object}
+ */
 export default {
   [ GENRES.MALE ]: [
     imc => lte(Number(imc), 0),

diff --git a/src/utils/load-index.js b/src/utils/load-index.js
@@ -1,5 +1,10 @@
 import tableCategories from './bmi-table'
 
+/**
+ * @method loadIndex
+ * @param  {String} genre
+ * @return {Function}
+ */
 const loadIndex = genre => weight => {
   return tableCategories[ genre ]
     .reduce((acc, fn, index) => {

diff --git a/src/utils/messages.js b/src/utils/messages.js
@@ -1,3 +1,6 @@
+/**
+ * @type{Object}
+ */
 const messages = {
   'pt-BR': [
     null,
@@ -17,4 +20,4 @@ const messages = {
   ]
 }
 
-export default messages
+export default messages