fix(docs): Fix comments content and style

combefis · combefis · commit d2b2dfd60636 · 2016-01-17T11:46:11.000+01:00
Changed some bad comments referencing the Articles module in other modules.
Typo fixed in xxx.client.modules.js files ("Application" =&gt; "Applicaion")
Full stop character removed at the end of line comments
diff --git a/modules/articles/server/controllers/articles.server.controller.js b/modules/articles/server/controllers/articles.server.controller.js
@@ -1,15 +1,15 @@
 'use strict';
 
 /**
- * Module dependencies.
+ * Module dependencies
  */
 var path = require('path'),
   mongoose = require('mongoose'),
   Article = mongoose.model('Article'),
   errorHandler = require(path.resolve('./modules/core/server/controllers/errors.server.controller'));
 
 /**
- * Create a article
+ * Create an article
  */
 exports.create = function (req, res) {
   var article = new Article(req.body);
@@ -34,7 +34,7 @@ exports.read = function (req, res) {
 };
 
 /**
- * Update a article
+ * Update an article
  */
 exports.update = function (req, res) {
   var article = req.article;
diff --git a/modules/articles/server/models/article.server.model.js b/modules/articles/server/models/article.server.model.js
@@ -1,7 +1,7 @@
 'use strict';
 
 /**
- * Module dependencies.
+ * Module dependencies
  */
 var mongoose = require('mongoose'),
   Schema = mongoose.Schema;
diff --git a/modules/articles/server/policies/articles.server.policy.js b/modules/articles/server/policies/articles.server.policy.js
@@ -1,7 +1,7 @@
 'use strict';
 
 /**
- * Module dependencies.
+ * Module dependencies
  */
 var acl = require('acl');
 
@@ -56,7 +56,7 @@ exports.isAllowed = function (req, res, next) {
   // Check for user roles
   acl.areAnyRolesAllowed(roles, req.route.path, req.method.toLowerCase(), function (err, isAllowed) {
     if (err) {
-      // An authorization error occurred.
+      // An authorization error occurred
       return res.status(500).send('Unexpected authorization error');
     } else {
       if (isAllowed) {
diff --git a/modules/articles/server/routes/articles.server.routes.js b/modules/articles/server/routes/articles.server.routes.js
@@ -1,7 +1,7 @@
 'use strict';
 
 /**
- * Module dependencies.
+ * Module dependencies
  */
 var articlesPolicy = require('../policies/articles.server.policy'),
   articles = require('../controllers/articles.server.controller');
diff --git a/modules/core/client/core.client.module.js b/modules/core/client/core.client.module.js
@@ -1,6 +1,6 @@
 'use strict';
 
-// Use Applicaion configuration module to register a new module
+// Use Application configuration module to register a new module
 ApplicationConfiguration.registerModule('core');
 ApplicationConfiguration.registerModule('core.admin', ['core']);
 ApplicationConfiguration.registerModule('core.admin.routes', ['ui.router']);
diff --git a/modules/users/client/config/users-admin.client.menus.js b/modules/users/client/config/users-admin.client.menus.js
@@ -1,6 +1,6 @@
 'use strict';
 
-// Configuring the Articles module
+// Configuring the Users module
 angular.module('users.admin').run(['Menus',
   function (Menus) {
     Menus.addSubMenuItem('topbar', 'admin', {
diff --git a/modules/users/client/controllers/password.client.controller.js b/modules/users/client/controllers/password.client.controller.js
@@ -5,7 +5,7 @@ angular.module('users').controller('PasswordController', ['$scope', '$stateParam
     $scope.authentication = Authentication;
     $scope.popoverMsg = PasswordValidator.getPopoverMsg();
 
-    //If user is signed in then redirect back home
+    // If user is signed in then redirect back home
     if ($scope.authentication.user) {
       $location.path('/');
     }
diff --git a/modules/users/client/users.client.module.js b/modules/users/client/users.client.module.js
@@ -1,6 +1,6 @@
 'use strict';
 
-// Use Applicaion configuration module to register a new module
+// Use Application configuration module to register a new module
 ApplicationConfiguration.registerModule('users', ['core']);
 ApplicationConfiguration.registerModule('users.admin', ['core.admin']);
 ApplicationConfiguration.registerModule('users.admin.routes', ['core.admin.routes']);
diff --git a/modules/users/server/config/strategies/facebook.js b/modules/users/server/config/strategies/facebook.js
@@ -1,7 +1,7 @@
 'use strict';
 
 /**
- * Module dependencies.
+ * Module dependencies
  */
 var passport = require('passport'),
   FacebookStrategy = require('passport-facebook').Strategy,
diff --git a/modules/users/server/config/strategies/github.js b/modules/users/server/config/strategies/github.js
@@ -1,7 +1,7 @@
 'use strict';
 
 /**
- * Module dependencies.
+ * Module dependencies
  */
 var passport = require('passport'),
   GithubStrategy = require('passport-github').Strategy,
diff --git a/modules/users/server/config/strategies/google.js b/modules/users/server/config/strategies/google.js
@@ -1,7 +1,7 @@
 'use strict';
 
 /**
- * Module dependencies.
+ * Module dependencies
  */
 var passport = require('passport'),
   GoogleStrategy = require('passport-google-oauth').OAuth2Strategy,
diff --git a/modules/users/server/config/strategies/linkedin.js b/modules/users/server/config/strategies/linkedin.js
@@ -1,7 +1,7 @@
 'use strict';
 
 /**
- * Module dependencies.
+ * Module dependencies
  */
 var passport = require('passport'),
   LinkedInStrategy = require('passport-linkedin').Strategy,
diff --git a/modules/users/server/config/strategies/local.js b/modules/users/server/config/strategies/local.js
@@ -1,7 +1,7 @@
 'use strict';
 
 /**
- * Module dependencies.
+ * Module dependencies
  */
 var passport = require('passport'),
   LocalStrategy = require('passport-local').Strategy,
diff --git a/modules/users/server/config/strategies/paypal.js b/modules/users/server/config/strategies/paypal.js
@@ -1,7 +1,7 @@
 'use strict';
 
 /**
- * Module dependencies.
+ * Module dependencies
  */
 var passport = require('passport'),
   PayPalStrategy = require('passport-paypal-openidconnect').Strategy,
diff --git a/modules/users/server/config/strategies/twitter.js b/modules/users/server/config/strategies/twitter.js
@@ -1,7 +1,7 @@
 'use strict';
 
 /**
- * Module dependencies.
+ * Module dependencies
  */
 var passport = require('passport'),
   TwitterStrategy = require('passport-twitter').Strategy,
diff --git a/modules/users/server/config/users.server.config.js b/modules/users/server/config/users.server.config.js
@@ -1,15 +1,15 @@
 'use strict';
 
 /**
- * Module dependencies.
+ * Module dependencies
  */
 var passport = require('passport'),
   User = require('mongoose').model('User'),
   path = require('path'),
   config = require(path.resolve('./config/config'));
 
 /**
- * Module init function.
+ * Module init function
  */
 module.exports = function (app, db) {
   // Serialize sessions
diff --git a/modules/users/server/controllers/admin.server.controller.js b/modules/users/server/controllers/admin.server.controller.js
@@ -1,7 +1,7 @@
 'use strict';
 
 /**
- * Module dependencies.
+ * Module dependencies
  */
 var path = require('path'),
   mongoose = require('mongoose'),
diff --git a/modules/users/server/controllers/users.server.controller.js b/modules/users/server/controllers/users.server.controller.js
@@ -1,7 +1,7 @@
 'use strict';
 
 /**
- * Module dependencies.
+ * Module dependencies
  */
 var _ = require('lodash');
 
diff --git a/modules/users/server/controllers/users/users.authentication.server.controller.js b/modules/users/server/controllers/users/users.authentication.server.controller.js
@@ -1,7 +1,7 @@
 'use strict';
 
 /**
- * Module dependencies.
+ * Module dependencies
  */
 var path = require('path'),
   errorHandler = require(path.resolve('./modules/core/server/controllers/errors.server.controller')),
diff --git a/modules/users/server/controllers/users/users.authorization.server.controller.js b/modules/users/server/controllers/users/users.authorization.server.controller.js
@@ -1,7 +1,7 @@
 'use strict';
 
 /**
- * Module dependencies.
+ * Module dependencies
  */
 var _ = require('lodash'),
   mongoose = require('mongoose'),
diff --git a/modules/users/server/controllers/users/users.password.server.controller.js b/modules/users/server/controllers/users/users.password.server.controller.js
@@ -1,7 +1,7 @@
 'use strict';
 
 /**
- * Module dependencies.
+ * Module dependencies
  */
 var path = require('path'),
   config = require(path.resolve('./config/config')),
diff --git a/modules/users/server/controllers/users/users.profile.server.controller.js b/modules/users/server/controllers/users/users.profile.server.controller.js
@@ -1,7 +1,7 @@
 'use strict';
 
 /**
- * Module dependencies.
+ * Module dependencies
  */
 var _ = require('lodash'),
   fs = require('fs'),
diff --git a/modules/users/server/models/user.server.model.js b/modules/users/server/models/user.server.model.js
@@ -1,7 +1,7 @@
 'use strict';
 
 /**
- * Module dependencies.
+ * Module dependencies
  */
 var mongoose = require('mongoose'),
   Schema = mongoose.Schema,
@@ -168,7 +168,7 @@ UserSchema.statics.findUniqueUsername = function (username, suffix, callback) {
 };
 
 /**
-* Generates a random passphrase that passes the owasp test.
+* Generates a random passphrase that passes the owasp test
 * Returns a promise that resolves with the generated passphrase, or rejects with an error if something goes wrong.
 * NOTE: Passphrases are only tested against the required owasp strength tests, and not the optional tests.
 */
@@ -177,8 +177,8 @@ UserSchema.statics.generateRandomPassphrase = function () {
     var password = '';
     var repeatingCharacters = new RegExp('(.)\\1{2,}', 'g');
 
-    // iterate until the we have a valid passphrase.
-    // NOTE: Should rarely iterate more than once, but we need this to ensure no repeating characters are present.
+    // iterate until the we have a valid passphrase
+    // NOTE: Should rarely iterate more than once, but we need this to ensure no repeating characters are present
     while (password.length < 20 || repeatingCharacters.test(password)) {
       // build the random password
       password = generatePassword.generate({
@@ -189,7 +189,7 @@ UserSchema.statics.generateRandomPassphrase = function () {
         excludeSimilarCharacters: true,
       });
 
-      // check if we need to remove any repeating characters.
+      // check if we need to remove any repeating characters
       password = password.replace(repeatingCharacters, '');
     }
 
diff --git a/modules/users/server/policies/admin.server.policy.js b/modules/users/server/policies/admin.server.policy.js
@@ -1,7 +1,7 @@
 'use strict';
 
 /**
- * Module dependencies.
+ * Module dependencies
  */
 var acl = require('acl');
 
@@ -33,7 +33,7 @@ exports.isAllowed = function (req, res, next) {
   // Check for user roles
   acl.areAnyRolesAllowed(roles, req.route.path, req.method.toLowerCase(), function (err, isAllowed) {
     if (err) {
-      // An authorization error occurred.
+      // An authorization error occurred
       return res.status(500).send('Unexpected authorization error');
     } else {
       if (isAllowed) {
diff --git a/modules/users/server/routes/admin.server.routes.js b/modules/users/server/routes/admin.server.routes.js
@@ -1,7 +1,7 @@
 'use strict';
 
 /**
- * Module dependencies.
+ * Module dependencies
  */
 var adminPolicy = require('../policies/admin.server.policy'),
   admin = require('../controllers/admin.server.controller');
diff --git a/modules/users/server/routes/auth.server.routes.js b/modules/users/server/routes/auth.server.routes.js
@@ -1,7 +1,7 @@
 'use strict';
 
 /**
- * Module dependencies.
+ * Module dependencies
  */
 var passport = require('passport');
 

Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@ angular.module('users').controller('PasswordController', ['$scope', '$stateParam`
`5`	`5`	`$scope.authentication = Authentication;`
`6`	`6`	`$scope.popoverMsg = PasswordValidator.getPopoverMsg();`
`7`	`7`
`8`		`- //If user is signed in then redirect back home`
	`8`	`+ // If user is signed in then redirect back home`
`9`	`9`	`if ($scope.authentication.user) {`
`10`	`10`	`$location.path('/');`
`11`	`11`	`}`