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
This commit is contained in:
Sébastien Combéfis
2016-01-07 22:18:36 +01:00
parent 3dee3fc47a
commit d2b2dfd606
26 changed files with 35 additions and 35 deletions

View File

@@ -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;

View File

@@ -1,7 +1,7 @@
'use strict';
/**
* Module dependencies.
* Module dependencies
*/
var mongoose = require('mongoose'),
Schema = mongoose.Schema;

View File

@@ -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) {

View File

@@ -1,7 +1,7 @@
'use strict';
/**
* Module dependencies.
* Module dependencies
*/
var articlesPolicy = require('../policies/articles.server.policy'),
articles = require('../controllers/articles.server.controller');

View File

@@ -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']);

View File

@@ -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', {

View File

@@ -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('/');
}

View File

@@ -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']);

View File

@@ -1,7 +1,7 @@
'use strict';
/**
* Module dependencies.
* Module dependencies
*/
var passport = require('passport'),
FacebookStrategy = require('passport-facebook').Strategy,

View File

@@ -1,7 +1,7 @@
'use strict';
/**
* Module dependencies.
* Module dependencies
*/
var passport = require('passport'),
GithubStrategy = require('passport-github').Strategy,

View File

@@ -1,7 +1,7 @@
'use strict';
/**
* Module dependencies.
* Module dependencies
*/
var passport = require('passport'),
GoogleStrategy = require('passport-google-oauth').OAuth2Strategy,

View File

@@ -1,7 +1,7 @@
'use strict';
/**
* Module dependencies.
* Module dependencies
*/
var passport = require('passport'),
LinkedInStrategy = require('passport-linkedin').Strategy,

View File

@@ -1,7 +1,7 @@
'use strict';
/**
* Module dependencies.
* Module dependencies
*/
var passport = require('passport'),
LocalStrategy = require('passport-local').Strategy,

View File

@@ -1,7 +1,7 @@
'use strict';
/**
* Module dependencies.
* Module dependencies
*/
var passport = require('passport'),
PayPalStrategy = require('passport-paypal-openidconnect').Strategy,

View File

@@ -1,7 +1,7 @@
'use strict';
/**
* Module dependencies.
* Module dependencies
*/
var passport = require('passport'),
TwitterStrategy = require('passport-twitter').Strategy,

View File

@@ -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

View File

@@ -1,7 +1,7 @@
'use strict';
/**
* Module dependencies.
* Module dependencies
*/
var path = require('path'),
mongoose = require('mongoose'),

View File

@@ -1,7 +1,7 @@
'use strict';
/**
* Module dependencies.
* Module dependencies
*/
var _ = require('lodash');

View File

@@ -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')),

View File

@@ -1,7 +1,7 @@
'use strict';
/**
* Module dependencies.
* Module dependencies
*/
var _ = require('lodash'),
mongoose = require('mongoose'),

View File

@@ -1,7 +1,7 @@
'use strict';
/**
* Module dependencies.
* Module dependencies
*/
var path = require('path'),
config = require(path.resolve('./config/config')),

View File

@@ -1,7 +1,7 @@
'use strict';
/**
* Module dependencies.
* Module dependencies
*/
var _ = require('lodash'),
fs = require('fs'),

View File

@@ -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, '');
}

View File

@@ -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) {

View File

@@ -1,7 +1,7 @@
'use strict';
/**
* Module dependencies.
* Module dependencies
*/
var adminPolicy = require('../policies/admin.server.policy'),
admin = require('../controllers/admin.server.controller');

View File

@@ -1,7 +1,7 @@
'use strict';
/**
* Module dependencies.
* Module dependencies
*/
var passport = require('passport');