Update jsdoc

Author: 4ban

src/App.vue

@@ -5,8 +5,11 @@
 </template>
 
 <script>
+/**
+ * Entry point to the application
+ */
 export default {
-  name: 'vdexnode-gui'
+  name: 'App'
 }
 </script>
 

src/components/GeoWidget.vue

@@ -14,6 +14,18 @@ import * as d3 from 'd3'
 const topojson = require('topojson')
 var countries = require('../assets/geoWidgetData/countries.geo.json')
 var initialNodeList = require('../assets/geoWidgetData/initial_node_list.json')
+/**
+ * Map widget component
+ * @vue-prop {Array} geoData
+ * @vue-data {Object} nodeGeoData - Store the node locations
+ * @vue-event {} load - Init loading the widget
+ * @vue-event {} getNodeGeoData - Get the initial node locations and fill the data object
+ * @vue-event {} mapLoad - Load and display the map with node locations data on it
+ *
+ * @example
+ *  import GeoWidget from '../components/GeoWidget.vue'
+ *  <GeoWidget :geoData="geoData"/>
+ */
 
 export default {
   name: 'GeoWidget',

src/pages/Error404.vue

@@ -16,6 +16,9 @@
 </template>
 
 <script>
+/**
+ * Error handler
+ */
 export default {
   name: 'Error404'
 }

src/pages/Index.vue

@@ -338,6 +338,30 @@ import * as utils from '@/util/utils.js'
 const { app, dialog } = require('electron').remote
 const fs = require('fs')
 
+/**
+ * Main page. Loads other components
+ * @vue-data {*} identity - Set of variables for storing user identification information
+ *
+ * @vue-event {} refresher
+ * @vue-event {} identify
+ * @vue-event {} getUptime
+ * @vue-event {} getVoted
+ * @vue-event {} getRank
+ * @vue-event {} getBalance
+ * @vue-event {} updatePrivate
+ * @vue-event {} showPrivate
+ * @vue-event {} refresh
+ * @vue-event {} getInstaller
+ * @vue-event {} forceFileDownload
+ * @vue-event {} addNode
+ * @vue-event {} registerNode
+ * @vue-event {} getAccountName
+ * @vue-event {} getNodes
+ * @vue-event {} getListOfNodes
+ * @vue-event {} addToVote
+ * @vue-event {} vote
+ * @vue-event {} retreiveReward
+ */
 export default {
   name: 'index',
   components: {

src/util/EosWrapper.js

@@ -3,8 +3,17 @@ import { JsSignatureProvider } from 'eosjs/dist/eosjs-jssig'
 import ecc from 'eosjs-ecc'
 const { TextEncoder, TextDecoder } = require('util')
 const fetch = require('node-fetch')
-
+/**
+ * Wrapper on eosjs library for interacting with EOS blockchain
+ *
+ * @class EosWrapper
+ */
 class EosWrapper {
+  /**
+   * Creates an instance of EosWrapper.
+   * @param {String} keyProvider Private key
+   * @memberof EosWrapper
+   */
   constructor (keyProvider) {
     this.rpc = new JsonRpc(process.env.EOS_ENDPOINT, { fetch })
     const rpc = this.rpc
@@ -13,22 +22,49 @@ class EosWrapper {
       this.api = new Api({ rpc, signatureProvider, textDecoder: new TextDecoder(), textEncoder: new TextEncoder() })
     }
   }
-
+  /**
+   * Get public key from private
+   *
+   * @param {String} wif Private key
+   * @returns {String} Public key
+   * @memberof EosWrapper
+   */
   privateToPublic (wif) {
     let pubKey = ecc.privateToPublic(wif)
     return pubKey
   }
-
+  /**
+   * Get accounts assigned to a public key
+   *
+   * @param {String} wif Public key
+   * @returns {Array} Array with accounts
+   * @memberof EosWrapper
+   */
   async getAccounts (wif) {
     let accounts = await this.rpc.history_get_key_accounts(wif)
     return accounts
   }
-
+  /**
+   * Get balance for an account
+   *
+   * @param {String} name Account name
+   * @returns {Array} Array with balance
+   * @memberof EosWrapper
+   */
   async getBalance (name) {
     let balance = await this.rpc.get_currency_balance('volentixgsys', name, 'VTX')
     return balance
   }
-
+  /**
+   * Get contract table
+   *
+   * @param {String} code
+   * @param {String} scope
+   * @param {String} table Table name
+   *
+   * @returns {Array} Array of rows
+   * @memberof EosWrapper
+   */
   async getTable (code, scope, table) {
     const resp = await this.rpc.get_table_rows({ code: code, scope: scope, table: table, json: true, limit: 999999999999 })
     return resp.rows

src/util/utils.js

@@ -1,3 +1,15 @@
+/**
+ * Function returns an array with removed duplicates by any field in the object
+ * @param {Array} arr - Array of objects to work with.
+ * @param {string} comp - Field to check.
+ *
+ * @return {Array} Array of objects with uremoved duplicates
+ *
+ * @example
+ *
+ *    var unique = getUnique([{'key':1}, {'key':2}, {'key':3}, {'key':3}, {'key':3}], 'key')
+ *    unique = [{'key':1}, {'key':2}, {'key':3}]
+ */
 function getUnique (arr, comp) {
   const unique = arr.map(e => e[comp])
     // store the keys of the unique objects