From d2b2dfd606362547211d5f05b2a4d8013a3417c2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9bastien=20Comb=C3=A9fis?= Date: Thu, 7 Jan 2016 22:18:36 +0100 Subject: [PATCH] fix(docs): Fix comments content and style Changed some bad comments referencing the Articles module in other modules. Typo fixed in xxx.client.modules.js files ("Application" => "Applicaion") Full stop character removed at the end of line comments --- .../server/controllers/articles.server.controller.js | 6 +++--- modules/articles/server/models/article.server.model.js | 2 +- .../articles/server/policies/articles.server.policy.js | 4 ++-- .../articles/server/routes/articles.server.routes.js | 2 +- modules/core/client/core.client.module.js | 2 +- .../users/client/config/users-admin.client.menus.js | 2 +- .../client/controllers/password.client.controller.js | 2 +- modules/users/client/users.client.module.js | 2 +- modules/users/server/config/strategies/facebook.js | 2 +- modules/users/server/config/strategies/github.js | 2 +- modules/users/server/config/strategies/google.js | 2 +- modules/users/server/config/strategies/linkedin.js | 2 +- modules/users/server/config/strategies/local.js | 2 +- modules/users/server/config/strategies/paypal.js | 2 +- modules/users/server/config/strategies/twitter.js | 2 +- modules/users/server/config/users.server.config.js | 4 ++-- .../server/controllers/admin.server.controller.js | 2 +- .../server/controllers/users.server.controller.js | 2 +- .../users/users.authentication.server.controller.js | 2 +- .../users/users.authorization.server.controller.js | 2 +- .../users/users.password.server.controller.js | 2 +- .../users/users.profile.server.controller.js | 2 +- modules/users/server/models/user.server.model.js | 10 +++++----- modules/users/server/policies/admin.server.policy.js | 4 ++-- modules/users/server/routes/admin.server.routes.js | 2 +- modules/users/server/routes/auth.server.routes.js | 2 +- 26 files changed, 35 insertions(+), 35 deletions(-) diff --git a/modules/articles/server/controllers/articles.server.controller.js b/modules/articles/server/controllers/articles.server.controller.js index 2c146c64..bc0694fb 100644 --- a/modules/articles/server/controllers/articles.server.controller.js +++ b/modules/articles/server/controllers/articles.server.controller.js @@ -1,7 +1,7 @@ 'use strict'; /** - * Module dependencies. + * Module dependencies */ var path = require('path'), mongoose = require('mongoose'), @@ -9,7 +9,7 @@ var path = require('path'), 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 index 2ccb91e3..8a557394 100644 --- 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 index 279277ee..f18d96ff 100644 --- 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 index dd7bab41..31d09530 100644 --- 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 index 5850d6ae..c841d376 100644 --- 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 index eda2af52..4ae2ed87 100644 --- 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 index 35b4aae1..572a5f52 100644 --- 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 index 8a95d388..805261f8 100644 --- 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 index 8c525350..14e8cc0d 100644 --- 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 index 643b7418..633c0f8f 100644 --- 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 index 68c4b846..9b40450f 100644 --- 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 index 47b4e477..5066237f 100644 --- 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 index 97435c4a..9caa9091 100644 --- 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 index 6546fa18..c30834c1 100644 --- 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 index 919d1054..ab543464 100644 --- 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 index 1f9fa19e..2bfedceb 100644 --- a/modules/users/server/config/users.server.config.js +++ b/modules/users/server/config/users.server.config.js @@ -1,7 +1,7 @@ 'use strict'; /** - * Module dependencies. + * Module dependencies */ var passport = require('passport'), User = require('mongoose').model('User'), @@ -9,7 +9,7 @@ var passport = require('passport'), 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 index ca3761d9..c4e7bf9d 100644 --- 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 index 37e0dcda..ad75ab9f 100644 --- 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 index 7341e931..c88497f0 100644 --- 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 index f7fa09a1..8c665425 100644 --- 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 index 90de01ce..5a76bc07 100644 --- 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 index e290a17c..51677303 100644 --- 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 index 975c4761..c92647a6 100644 --- 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 index 83dbc895..af539704 100644 --- 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 index 1c3e5d2a..398086c0 100644 --- 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 index a3ff2205..eb73b5ea 100644 --- 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');