Add JSCS-JSDocs plugin

related to #27

.jscsrc

@@ -48,5 +48,20 @@
   "validateLineBreaks": "LF",
   "requireSemicolons": true,
   "requireParenthesesAroundIIFE": true,
-  "validateIndentation": 2
+  "validateIndentation": 2,
+  "plugins": [
+    "jscs-jsdoc"
+  ],
+  "jsDoc": {
+    "checkParamNames": true,
+    "requireParamTypes": true,
+    "checkRedundantParams": true,
+    "checkRedundantReturns": true,
+    "requireReturnTypes": true,
+    "requireParamDescription": true,
+    "requireHyphenBeforeDescription": true,
+    "disallowNewlineAfterDescription": true,
+    "requireDescriptionCompleteSentence": true,
+    "enforceExistence": "exceptExports"
+  }
 }

package.json

@@ -25,7 +25,8 @@
     "jshint-stylish": "^1.0.0",
     "gulp-jshint": "^1.7.1",
     "gulp-autoprefixer": "^1.0.1",
-    "gulp-plumber": "^0.6.6"
+    "gulp-plumber": "^0.6.6",
+    "jscs-jsdoc": "^1.1.x"
   },
   "scripts": {
     "install-submodules": "./scripts/install/install-submodules.js"

src/shared/configure-keyboard.js

@@ -7,6 +7,9 @@
 
   .run(configKeyBoard);
 
+  /**
+   * Configure Keyboard
+   */
   function configKeyBoard($ionicPlatform) {
     $ionicPlatform.ready(function() {
       if (window.cordova && window.cordova.plugins.Keyboard) {

src/shared/configure-status-bar.js

@@ -7,6 +7,9 @@
 
   .run(configStatusBar);
 
+  /**
+   * Configure Status Bar style
+   */
   function configStatusBar($ionicPlatform) {
     $ionicPlatform.ready(function() {
       if (window.StatusBar) {

src/states/browse/route.js

@@ -5,6 +5,9 @@
 
   .config(configBrowse);
 
+  /**
+   * Define Browse Route
+   */
   function configBrowse($stateProvider) {
     $stateProvider
       .state('app.browse', {

src/states/come-back/controller.js

@@ -6,14 +6,20 @@
 
   ComeBackController.$inject = ['$timeout', '$ionicHistory'];
 
+  /**
+   * Define Come Back Controller
+   */
   function ComeBackController($timeout, $ionicHistory) {
     var vm = this;
     vm.title = 'Wait a second';
 
     vm.$on('$ionicView.enter', returnAfter2Seconds);
 
+    /**
+     * Return to previous view after two seconds in the current view
+     */
     function returnAfter2Seconds() {
-      $timeout(function () {
+      $timeout(function() {
         $ionicHistory.goBack();
       }, 2000);
     }

src/states/come-back/route.js

@@ -2,9 +2,12 @@
   'use strict';
   angular.module('starter.state.come-back', ['starter.state.come-back.controller'])
 
-  .config(configRefresher);
+  .config(configComeBack);
 
-  function configRefresher($stateProvider) {
+  /**
+   * Define Come Back Route
+   */
+  function configComeBack($stateProvider) {
     $stateProvider.state('app.comeBack', {
       url: '/come-back',
       views: {

src/states/index/route.js

@@ -2,8 +2,11 @@
   'use strict';
   angular.module('starter.state.index', [])
 
-    .config(configIndex);
+  .config(configIndex);
 
+  /**
+   * Define default/index route
+   */
   function configIndex($urlRouterProvider) {
     $urlRouterProvider.otherwise('/app/playlists');
   }

src/states/infinite-scroll/controller.js

@@ -8,26 +8,35 @@
 
   var total = 10;
 
+  /**
+   * Define Infinite Scroll Controller
+   */
   function InfiniteScrollController($scope, $state, $timeout) {
     var vm = this;
 
     vm.title = 'Infinite Scroll';
     vm.list = getList();
     vm.loadMore = loadMore;
 
+    /**
+     * Return a list of itens
+     */
     function getList(limit) {
       var dados = [];
       for (var i = limit; i >= 0; i--) {
         dados[i] = i;
-      };
+      }
 
       return dados;
     }
 
+    /**
+     * Load more items in the current state
+     */
     function loadMore() {
       total = total + 20;
 
-      $timeout(function () {
+      $timeout(function() {
         $scope.vm.list = getList(total);
         $scope.$broadcast('scroll.infiniteScrollComplete');
       }, 2000);

src/states/infinite-scroll/route.js

@@ -2,11 +2,14 @@
   'use strict';
   angular.module('starter.state.infinite-scroll', ['starter.state.infinite-scroll.controller'])
 
-  .config(configinfiniteScroll);
+  .config(configInfiniteScroll);
 
-  // configinfiniteScroll.$inject(['$stateProvider']);
+  configInfiniteScroll.$inject(['$stateProvider']);
 
-  function configinfiniteScroll($stateProvider) {
+  /**
+   * Define Infinite Scroll Route
+   */
+  function configInfiniteScroll($stateProvider) {
     $stateProvider.state('app.infinite-scroll', {
       url: '/infinite-scroll',
       views: {

src/states/loading/controller.js

@@ -6,6 +6,9 @@
 
   LoadingController.$inject = ['$scope', '$state', '$timeout', '$ionicLoading'];
 
+  /**
+   * Define Loading Controller
+   */
   function LoadingController($scope, $state, $timeout, $ionicLoading) {
     $scope.title = 'Loading';
   }

src/states/loading/route.js

@@ -5,6 +5,9 @@
     'starter.shared.ig-button-loading'
   ]).config(configRefresher);
 
+  /**
+   * Define Loading Route
+   */
   function configRefresher($stateProvider) {
     $stateProvider.state('app.loading', {
       url: '/loading',

src/states/playlists/controller.js

@@ -4,6 +4,9 @@
 
     .controller('PlaylistsController', PlaylistsController);
 
+  /**
+   * Define Playlists Controller
+   */
   function PlaylistsController() {
     var vm = this;
 

src/states/playlists/route.js

@@ -2,8 +2,11 @@
   'use strict';
   angular.module('starter.state.playlists', ['starter.state.playlists.controller'])
 
-    .config(configPlaylists);
+  .config(configPlaylists);
 
+  /**
+   * Define Playlists Route
+   */
   function configPlaylists($stateProvider, $urlRouterProvider) {
     $stateProvider
       .state('app.playlists', {

src/states/refresher/controller.js

@@ -8,26 +8,35 @@
 
   var total = 10;
 
+  /**
+   * Define Refresher Controller
+   */
   function RefresherController($scope, $state, $timeout) {
     var vm = this;
 
     vm.title = 'Refresher';
     vm.list = getList();
     vm.loadMore = loadMore;
 
+    /**
+     * Return a list of itens
+     */
     function getList(limit) {
       var dados = [];
       for (var i = limit; i >= 0; i--) {
         dados[i] = i;
-      };
+      }
 
       return dados;
     }
 
+    /**
+     * Load more items in the current state
+     */
     function loadMore() {
       total = total + 20;
 
-      $timeout(function () {
+      $timeout(function() {
         $scope.vm.list = getList(total);
         $scope.$broadcast('scroll.refreshComplete');
       }, 1500);

src/states/refresher/route.js

@@ -4,6 +4,9 @@
 
   .config(configRefresher);
 
+  /**
+   * Define Refresher Route
+   */
   function configRefresher($stateProvider) {
     $stateProvider.state('app.refresher', {
       url: '/refresher',

src/states/search/route.js

@@ -4,6 +4,9 @@
 
     .config(configSearch);
 
+  /**
+   * Define Search Route
+   */
   function configSearch($stateProvider) {
     $stateProvider
       .state('app.search', {

src/states/sidemenu/controller.js

@@ -2,35 +2,46 @@
   'use strict';
   angular.module('starter.state.sidemenu.controller', [])
 
-    .controller('SidemenuController', SidemenuController);
+  .controller('SidemenuController', SidemenuController);
 
   SidemenuController.$inject = ['$scope', '$ionicModal', '$timeout'];
 
+  /**
+   * Define Sidemenu Controller
+   */
   function SidemenuController($scope, $ionicModal, $timeout) {
     var vm = this;
 
     // Form data for the login modal
     vm.loginData = {};
 
-    // Create the login modal that we will use later
+    /**
+     * Create the login modal that we will use later
+     */
     $ionicModal.fromTemplateUrl('modals/login.html', {
       scope: $scope
     }).then(function(modal) {
       vm.modal = modal;
       $scope.vm = vm;
     });
 
-    // Triggered in the login modal to close it
+    /**
+     * Triggered in the login modal to close it
+     */
     vm.closeLogin = function() {
       vm.modal.hide();
     };
 
-    // Open the login modal
+    /**
+     * Open the login modal
+     */
     vm.login = function() {
       vm.modal.show();
     };
 
-    // Perform the login action when the user submits the login form
+    /**
+     * Perform the login action when the user submits the login form
+     */
     vm.doLogin = function() {
       console.log('Doing login', vm.loginData);
 

src/states/sidemenu/route.js

@@ -4,6 +4,9 @@
 
     .config(configSidemenu);
 
+  /**
+   * Define Side Menu Route
+   */
   function configSidemenu($stateProvider) {
     $stateProvider.state('app', {
       url: '/app',

src/states/single/controller.js

@@ -6,6 +6,9 @@
 
   SingleController.$inject = ['$state'];
 
+  /**
+   * Define Single Controller
+   */
   function SingleController($state) {
     var vm = this;
 

src/states/single/route.js

@@ -4,6 +4,9 @@
 
     .config(configSingle);
 
+  /**
+   * Define Single Route
+   */
   function configSingle($stateProvider) {
     $stateProvider.state('app.single', {
       url: '/single/:singleId',

src/states/spinners/controller.js

@@ -7,7 +7,9 @@
   SpinnersController.$inject = ['$scope', '$state', '$timeout'];
 
   var total = 10;
-
+  /**
+   * Define State Controller
+   */
   function SpinnersController($scope, $state, $timeout) {
     var vm = this;
 
@@ -16,19 +18,27 @@
     vm.loadMore = loadMore;
     vm.isChecked = true;
 
+    /**
+     * Get an array of items.
+     * @param {Number} limit - Number of items to return
+     * @return {Array} - Returns generated array
+     */
     function getList(limit) {
       var dados = [];
       for (var i = limit; i >= 0; i--) {
         dados[i] = i;
-      };
+      }
 
       return dados;
     }
 
+    /**
+     * Used by ion-infinite-scroll to load more itens
+     */
     function loadMore() {
       total = total + 20;
 
-      $timeout(function () {
+      $timeout(function() {
         $scope.vm.list = getList(total);
         $scope.$broadcast('scroll.refreshComplete');
       }, 1500);