chore(package): fix some warnings/errors

Related to #14952. Fixed the following warnings/errors:

1. **Warning**: Closure Compiler complained about `/* @this */` (annotations in non-JSDoc comments).
   Fixed by changing `/* @this */` to `/** @this */`.

2. **Warning**: Dgeni complained about `/** @this */` (invalid tags found).
   Fixed by adding an empty `this` tag definition in `docs/config/tag-defs/`.

3. **Error**: ESLint complained about CRLF linebreaks in `build/docs/examples/`. These are generated
   by dgeni and (apparently) use the system's default linebreak (e.g. CRLF on Windows).
   Fixed by disabling the `linebreak-style` rule for `build/docs/examples/`.

Closes #14997
This commit is contained in:
Georgios Kalpakas
2016-08-06 18:24:14 +03:00
parent 975a6170ef
commit ec565ddd9c
40 changed files with 69 additions and 61 deletions
+1 -1
View File
@@ -95,7 +95,7 @@ angular.module('search', [])
}
// Create the lunr index
var index = lunr(/* @this */ function() {
var index = lunr(/** @this */ function() {
this.ref('path');
this.field('titleWords', {boost: 50});
this.field('members', { boost: 40});
+1
View File
@@ -55,6 +55,7 @@ module.exports = new Package('angularjs', [
parseTagsProcessor.tagDefinitions.push(require('./tag-defs/tutorial-step'));
parseTagsProcessor.tagDefinitions.push(require('./tag-defs/sortOrder'));
parseTagsProcessor.tagDefinitions.push(require('./tag-defs/installation'));
parseTagsProcessor.tagDefinitions.push(require('./tag-defs/this'));
})
+5
View File
@@ -0,0 +1,5 @@
'use strict';
module.exports = {
name: 'this'
};
+2
View File
@@ -34,6 +34,8 @@ var getMergedEslintConfig = function(filepath) {
strict: 'off',
// Generated examples may miss the final EOL; ignore that.
'eol-last': 'off',
// Generated files use the system's default linebreak style (e.g. CRLF on Windows)
'linebreak-style': 'off',
// While alerts would be bad to have in the library or test code,
// they're perfectly fine in examples.
'no-alert': 'off',
+1 -1
View File
@@ -74,7 +74,7 @@ HashMap.prototype = {
}
};
var $$HashMapProvider = [/* @this */function() {
var $$HashMapProvider = [/** @this */function() {
this.$get = [function() {
return HashMap;
}];
+1 -1
View File
@@ -710,7 +710,7 @@ function createInjector(modulesToLoad, strictDi) {
}
function enforceReturnValue(name, factory) {
return /* @this */ function enforcedReturnValue() {
return /** @this */ function enforcedReturnValue() {
var result = instanceInjector.invoke(factory, this);
if (isUndefined(result)) {
throw $injectorMinErr('undef', "Provider '{0}' must return a value from $get factory method.", name);
+2 -2
View File
@@ -262,7 +262,7 @@ function jqLiteWrapNode(node, wrapper) {
// IE9-11 has no method "contains" in SVG element and in Node.prototype. Bug #10259.
var jqLiteContains = window.Node.prototype.contains || /* @this */ function(arg) {
var jqLiteContains = window.Node.prototype.contains || /** @this */ function(arg) {
// eslint-disable-next-line no-bitwise
return !!(this.compareDocumentPosition(arg) & 16);
};
@@ -1068,7 +1068,7 @@ forEach({
// Provider for private $$jqLite service
/* @this */
/** @this */
function $$jqLiteProvider() {
this.$get = function $$jqLite() {
return extend(JQLite, {
+3 -3
View File
@@ -53,13 +53,13 @@ function prepareAnimateOptions(options) {
: {};
}
var $$CoreAnimateJsProvider = /* @this */ function() {
var $$CoreAnimateJsProvider = /** @this */ function() {
this.$get = noop;
};
// this is prefixed with Core since it conflicts with
// the animateQueueProvider defined in ngAnimate/animateQueue.js
var $$CoreAnimateQueueProvider = /* @this */ function() {
var $$CoreAnimateQueueProvider = /** @this */ function() {
var postDigestQueue = new HashMap();
var postDigestElements = [];
@@ -177,7 +177,7 @@ var $$CoreAnimateQueueProvider = /* @this */ function() {
*
* To see the functional implementation check out `src/ngAnimate/animate.js`.
*/
var $AnimateProvider = ['$provide', /* @this */ function($provide) {
var $AnimateProvider = ['$provide', /** @this */ function($provide) {
var provider = this;
this.$$registeredAnimations = Object.create(null);
+2 -2
View File
@@ -1,6 +1,6 @@
'use strict';
var $$AnimateAsyncRunFactoryProvider = /* @this */ function() {
var $$AnimateAsyncRunFactoryProvider = /** @this */ function() {
this.$get = ['$$rAF', function($$rAF) {
var waitQueue = [];
@@ -31,7 +31,7 @@ var $$AnimateAsyncRunFactoryProvider = /* @this */ function() {
}];
};
var $$AnimateRunnerFactoryProvider = /* @this */ function() {
var $$AnimateRunnerFactoryProvider = /** @this */ function() {
this.$get = ['$q', '$sniffer', '$$animateAsyncRun', '$$isDocumentHidden', '$timeout',
function($q, $sniffer, $$animateAsyncRun, $$isDocumentHidden, $timeout) {
+1 -1
View File
@@ -353,7 +353,7 @@ function Browser(window, document, $log, $sniffer) {
}
/* @this */
/** @this */
function $BrowserProvider() {
this.$get = ['$window', '$log', '$sniffer', '$document',
function($window, $log, $sniffer, $document) {
+3 -3
View File
@@ -958,7 +958,7 @@ var _UNINITIALIZED_VALUE = new UNINITIALIZED_VALUE();
* @description
*/
$CompileProvider.$inject = ['$provide', '$$sanitizeUriProvider'];
/* @this */
/** @this */
function $CompileProvider($provide, $$sanitizeUriProvider) {
var hasDirectives = {},
Suffix = 'Directive',
@@ -1217,7 +1217,7 @@ function $CompileProvider($provide, $$sanitizeUriProvider) {
function factory($injector) {
function makeInjectable(fn) {
if (isFunction(fn) || isArray(fn)) {
return /* @this */ function(tElement, tAttrs) {
return /** @this */ function(tElement, tAttrs) {
return $injector.invoke(fn, this, {$element: tElement, $attrs: tAttrs});
};
} else {
@@ -2208,7 +2208,7 @@ function $CompileProvider($provide, $$sanitizeUriProvider) {
if (eager) {
return compile($compileNodes, transcludeFn, maxPriority, ignoreDirective, previousCompileContext);
}
return /* @this */ function lazyCompilation() {
return /** @this */ function lazyCompilation() {
if (!compiled) {
compiled = compile($compileNodes, transcludeFn, maxPriority, ignoreDirective, previousCompileContext);
+1 -1
View File
@@ -51,7 +51,7 @@ function $$CookieReader($document) {
$$CookieReader.$inject = ['$document'];
/* @this */
/** @this */
function $$CookieReaderProvider() {
this.$get = $$CookieReader;
}
+2 -2
View File
@@ -1271,7 +1271,7 @@ function baseInputType(scope, element, attr, ctrl, $sniffer, $browser) {
}
};
element.on('keydown', /* @this */ function(event) {
element.on('keydown', /** @this */ function(event) {
var key = event.keyCode;
// ignore
@@ -1296,7 +1296,7 @@ function baseInputType(scope, element, attr, ctrl, $sniffer, $browser) {
// For these event types, when native validators are present and the browser supports the type,
// check for validity changes on various DOM events.
if (PARTIAL_VALIDATION_TYPES[type] && ctrl.$$hasNativeValidators && type === attr.type) {
element.on(PARTIAL_VALIDATION_EVENTS, /* @this */ function(ev) {
element.on(PARTIAL_VALIDATION_EVENTS, /** @this */ function(ev) {
if (!timeout) {
var validity = this[VALIDITY_STATE_PROPERTY];
var origBadInput = validity.badInput;
+1 -1
View File
@@ -221,7 +221,7 @@ is set to `true`. The parse error is stored in `ngModel.$error.parse`.
*
*/
var NgModelController = ['$scope', '$exceptionHandler', '$attrs', '$element', '$parse', '$animate', '$timeout', '$rootScope', '$q', '$interpolate',
/* @this */ function($scope, $exceptionHandler, $attr, $element, $parse, $animate, $timeout, $rootScope, $q, $interpolate) {
/** @this */ function($scope, $exceptionHandler, $attr, $element, $parse, $animate, $timeout, $rootScope, $q, $interpolate) {
this.$viewValue = Number.NaN;
this.$modelValue = Number.NaN;
this.$$rawModelValue = undefined; // stores the parsed modelValue / model set from scope regardless of validity.
+1 -1
View File
@@ -13,7 +13,7 @@ var noopNgModelController = { $setViewValue: noop, $render: noop };
* added `<option>` elements, perhaps by an `ngRepeat` directive.
*/
var SelectController =
['$element', '$scope', /* @this */ function($element, $scope) {
['$element', '$scope', /** @this */ function($element, $scope) {
var self = this,
optionsMap = new HashMap();
+1 -1
View File
@@ -106,7 +106,7 @@
</example>
*/
$FilterProvider.$inject = ['$provide'];
/* @this */
/** @this */
function $FilterProvider($provide) {
var suffix = 'Filter';
+1 -1
View File
@@ -1,6 +1,6 @@
'use strict';
var $$ForceReflowProvider = /* @this */ function() {
var $$ForceReflowProvider = /** @this */ function() {
this.$get = ['$document', function($document) {
return function(domNode) {
//the line below will force the browser to perform a repaint so
+2 -2
View File
@@ -23,7 +23,7 @@ function serializeValue(v) {
}
/* @this */
/** @this */
function $HttpParamSerializerProvider() {
/**
* @ngdoc service
@@ -61,7 +61,7 @@ function $HttpParamSerializerProvider() {
};
}
/* @this */
/** @this */
function $HttpParamSerializerJQLikeProvider() {
/**
* @ngdoc service
+1 -1
View File
@@ -331,7 +331,7 @@ function $InterpolateProvider() {
expressions: expressions,
$$watchDelegate: function(scope, listener) {
var lastValue;
return scope.$watchGroup(parseFns, /* @this */ function interpolateFnWatcher(values, oldValues) {
return scope.$watchGroup(parseFns, /** @this */ function interpolateFnWatcher(values, oldValues) {
var currValue = compute(values);
if (isFunction(listener)) {
listener.call(this, currValue, values !== oldValues ? lastValue : currValue, scope);
+1 -1
View File
@@ -1,6 +1,6 @@
'use strict';
/* @this */
/** @this */
function $IntervalProvider() {
this.$get = ['$rootScope', '$window', '$q', '$$q', '$browser',
function($rootScope, $window, $q, $$q, $browser) {
+1 -1
View File
@@ -9,7 +9,7 @@
* Override this service if you wish to customise where the callbacks are stored and
* how they vary compared to the requested url.
*/
var $jsonpCallbacksProvider = /* @this */ function() {
var $jsonpCallbacksProvider = /** @this */ function() {
this.$get = ['$window', function($window) {
var callbacks = $window.angular.callbacks;
var callbackMap = {};
+2 -2
View File
@@ -657,14 +657,14 @@ forEach([LocationHashbangInHtml5Url, LocationHashbangUrl, LocationHtml5Url], fun
function locationGetter(property) {
return /* @this */ function() {
return /** @this */ function() {
return this[property];
};
}
function locationGetterSetter(property, preprocess) {
return /* @this */ function(value) {
return /** @this */ function(value) {
if (isUndefined(value)) {
return this[property];
}
+1 -1
View File
@@ -254,7 +254,7 @@ function $QProvider() {
};
}
/* @this */
/** @this */
function $$QProvider() {
var errorOnUnhandledRejections = true;
this.$get = ['$browser', '$exceptionHandler', function($browser, $exceptionHandler) {
+1 -1
View File
@@ -1,6 +1,6 @@
'use strict';
/* @this */
/** @this */
function $$RAFProvider() { //rAF
this.$get = ['$window', '$timeout', function($window, $timeout) {
var requestAnimationFrame = $window.requestAnimationFrame ||
+1 -1
View File
@@ -1,6 +1,6 @@
'use strict';
/* @this */
/** @this */
function $$TestabilityProvider() {
this.$get = ['$rootScope', '$browser', '$location',
function($rootScope, $browser, $location) {
+1 -1
View File
@@ -1,6 +1,6 @@
'use strict';
/* @this */
/** @this */
function $TimeoutProvider() {
this.$get = ['$rootScope', '$browser', '$q', '$$q', '$exceptionHandler',
function($rootScope, $browser, $q, $$q, $exceptionHandler) {
+1 -1
View File
@@ -348,7 +348,7 @@ function registerRestorableStyles(backup, node, properties) {
});
}
var $AnimateCssProvider = ['$animateProvider', /* @this */ function($animateProvider) {
var $AnimateCssProvider = ['$animateProvider', /** @this */ function($animateProvider) {
var gcsLookup = createLocalCacheLookup();
var gcsStaggerLookup = createLocalCacheLookup();
+1 -1
View File
@@ -1,6 +1,6 @@
'use strict';
var $$AnimateCssDriverProvider = ['$$animationProvider', /* @this */ function($$animationProvider) {
var $$AnimateCssDriverProvider = ['$$animationProvider', /** @this */ function($$animationProvider) {
$$animationProvider.drivers.push('$$animateCssDriver');
var NG_ANIMATE_SHIM_CLASS_NAME = 'ng-animate-shim';
+1 -1
View File
@@ -4,7 +4,7 @@
// TODO(matsko): add documentation
// by the time...
var $$AnimateJsProvider = ['$animateProvider', /* @this */ function($animateProvider) {
var $$AnimateJsProvider = ['$animateProvider', /** @this */ function($animateProvider) {
this.$get = ['$injector', '$$AnimateRunner', '$$jqLite',
function($injector, $$AnimateRunner, $$jqLite) {
+1 -1
View File
@@ -1,6 +1,6 @@
'use strict';
var $$AnimateJsDriverProvider = ['$$animationProvider', /* @this */ function($$animationProvider) {
var $$AnimateJsDriverProvider = ['$$animationProvider', /** @this */ function($$animationProvider) {
$$animationProvider.drivers.push('$$animateJsDriver');
this.$get = ['$$animateJs', '$$AnimateRunner', function($$animateJs, $$AnimateRunner) {
return function initDriverFn(animationDetails) {
+2 -2
View File
@@ -2,7 +2,7 @@
var NG_ANIMATE_ATTR_NAME = 'data-ng-animate';
var NG_ANIMATE_PIN_DATA = '$ngAnimatePin';
var $$AnimateQueueProvider = ['$animateProvider', /* @this */ function($animateProvider) {
var $$AnimateQueueProvider = ['$animateProvider', /** @this */ function($animateProvider) {
var PRE_DIGEST_STATE = 1;
var RUNNING_STATE = 2;
var ONE_SPACE = ' ';
@@ -176,7 +176,7 @@ var $$AnimateQueueProvider = ['$animateProvider', /* @this */ function($animateP
}
// IE9-11 has no method "contains" in SVG element and in Node.prototype. Bug #10259.
var contains = window.Node.prototype.contains || /* @this */ function(arg) {
var contains = window.Node.prototype.contains || /** @this */ function(arg) {
// eslint-disable-next-line no-bitwise
return this === arg || !!(this.compareDocumentPosition(arg) & 16);
};
+1 -1
View File
@@ -2,7 +2,7 @@
/* exported $$AnimationProvider */
var $$AnimationProvider = ['$animateProvider', /* @this */ function($animateProvider) {
var $$AnimationProvider = ['$animateProvider', /** @this */ function($animateProvider) {
var NG_ANIMATE_REF_ATTR = 'ng-animate-ref';
var drivers = this.drivers = [];
+1 -1
View File
@@ -55,6 +55,6 @@ function $$CookieWriter($document, $log, $browser) {
$$CookieWriter.$inject = ['$document', '$log', '$browser'];
angular.module('ngCookies').provider('$$cookieWriter', /* @this */ function $$CookieWriterProvider() {
angular.module('ngCookies').provider('$$cookieWriter', /** @this */ function $$CookieWriterProvider() {
this.$get = $$CookieWriter;
});
+1 -1
View File
@@ -23,7 +23,7 @@ angular.module('ngCookies', ['ng']).
* @description
* Use `$cookiesProvider` to change the default behavior of the {@link ngCookies.$cookies $cookies} service.
* */
provider('$cookies', [/* @this */function $CookiesProvider() {
provider('$cookies', [/** @this */function $CookiesProvider() {
/**
* @ngdoc property
* @name $cookiesProvider#defaults
+1 -1
View File
@@ -2874,7 +2874,7 @@ angular.mock.$RootScopeDecorator = ['$delegate', function($delegate) {
var initialized = false;
module.$$beforeAllHook(/* @this */ function() {
module.$$beforeAllHook(/** @this */ function() {
if (injectorState.shared) {
injectorState.sharedError = Error("sharedInjector() cannot be called inside a context that has already called sharedInjector()");
throw injectorState.sharedError;
+2 -2
View File
@@ -23,7 +23,7 @@ angular.scenario.Describe = function(descName, parent) {
var beforeEachFns = this.beforeEachFns;
this.setupBefore = function() {
if (parent) parent.setupBefore.call(this);
angular.forEach(beforeEachFns, /* @this */ function(fn) { fn.call(this); }, this);
angular.forEach(beforeEachFns, /** @this */ function(fn) { fn.call(this); }, this);
};
/**
@@ -31,7 +31,7 @@ angular.scenario.Describe = function(descName, parent) {
*/
var afterEachFns = this.afterEachFns;
this.setupAfter = function() {
angular.forEach(afterEachFns, /* @this */ function(fn) { fn.call(this); }, this);
angular.forEach(afterEachFns, /** @this */ function(fn) { fn.call(this); }, this);
if (parent) parent.setupAfter.call(this);
};
};
+4 -4
View File
@@ -21,7 +21,7 @@ angular.scenario.Runner = function($window) {
beforeEach: this.beforeEach,
afterEach: this.afterEach
};
angular.forEach(this.api, angular.bind(this, /* @this */ function(fn, key) {
angular.forEach(this.api, angular.bind(this, /** @this */ function(fn, key) {
this.$window[key] = angular.bind(this, fn);
}));
};
@@ -66,7 +66,7 @@ angular.scenario.Runner.prototype.on = function(eventName, listener) {
*/
angular.scenario.Runner.prototype.describe = function(name, body) {
var self = this;
this.currentDescribe.describe(name, /* @this */ function() {
this.currentDescribe.describe(name, /** @this */ function() {
var parentDescribe = self.currentDescribe;
self.currentDescribe = this;
try {
@@ -87,7 +87,7 @@ angular.scenario.Runner.prototype.describe = function(name, body) {
*/
angular.scenario.Runner.prototype.ddescribe = function(name, body) {
var self = this;
this.currentDescribe.ddescribe(name, /* @this */ function() {
this.currentDescribe.ddescribe(name, /** @this */ function() {
var parentDescribe = self.currentDescribe;
self.currentDescribe = this;
try {
@@ -215,7 +215,7 @@ angular.scenario.Runner.prototype.run = function(application) {
return scope.dsl[key].apply(scope, arguments);
};
});
runner.run(spec, /* @this */ function() {
runner.run(spec, /** @this */ function() {
runner.$destroy();
specDone.apply(this, arguments);
});
+2 -2
View File
@@ -40,7 +40,7 @@ angular.scenario.output = angular.scenario.output || function(name, fn) {
angular.scenario.dsl = angular.scenario.dsl || function(name, fn) {
angular.scenario.dsl[name] = function() {
// The dsl binds `this` for us when calling chained functions
/* @this */
/** @this */
function executeStatement(statement, args) {
var result = statement.apply(this, args);
if (angular.isFunction(result) || result instanceof angular.scenario.Future) {
@@ -60,7 +60,7 @@ angular.scenario.dsl = angular.scenario.dsl || function(name, fn) {
return chain;
}
var statement = fn.apply(this, arguments);
return /* @this */ function() {
return /** @this */ function() {
return executeStatement.call(this, statement, arguments);
};
};
+1 -1
View File
@@ -107,7 +107,7 @@ angular.scenario.SpecRunner.prototype.addFuture = function(name, behavior, line)
angular.scenario.SpecRunner.prototype.addFutureAction = function(name, behavior, line) {
var self = this;
var NG = /\[ng\\:/;
return this.addFuture(name, /* @this */ function(done) {
return this.addFuture(name, /** @this */ function(done) {
this.application.executeAction(function($window, $document) {
//TODO(esprehn): Refactor this so it doesn't need to be in here.
+10 -10
View File
@@ -4,42 +4,42 @@
* Matchers for implementing specs. Follows the Jasmine spec conventions.
*/
angular.scenario.matcher('toEqual', /* @this */ function(expected) {
angular.scenario.matcher('toEqual', /** @this */ function(expected) {
return angular.equals(this.actual, expected);
});
angular.scenario.matcher('toBe', /* @this */ function(expected) {
angular.scenario.matcher('toBe', /** @this */ function(expected) {
return this.actual === expected;
});
angular.scenario.matcher('toBeDefined', /* @this */ function() {
angular.scenario.matcher('toBeDefined', /** @this */ function() {
return angular.isDefined(this.actual);
});
angular.scenario.matcher('toBeTruthy', /* @this */ function() {
angular.scenario.matcher('toBeTruthy', /** @this */ function() {
return this.actual;
});
angular.scenario.matcher('toBeFalsy', /* @this */ function() {
angular.scenario.matcher('toBeFalsy', /** @this */ function() {
return !this.actual;
});
angular.scenario.matcher('toMatch', /* @this */ function(expected) {
angular.scenario.matcher('toMatch', /** @this */ function(expected) {
return new RegExp(expected).test(this.actual);
});
angular.scenario.matcher('toBeNull', /* @this */ function() {
angular.scenario.matcher('toBeNull', /** @this */ function() {
return this.actual === null;
});
angular.scenario.matcher('toContain', /* @this */ function(expected) {
angular.scenario.matcher('toContain', /** @this */ function(expected) {
return includes(this.actual, expected);
});
angular.scenario.matcher('toBeLessThan', /* @this */ function(expected) {
angular.scenario.matcher('toBeLessThan', /** @this */ function(expected) {
return this.actual < expected;
});
angular.scenario.matcher('toBeGreaterThan', /* @this */ function(expected) {
angular.scenario.matcher('toBeGreaterThan', /** @this */ function(expected) {
return this.actual > expected;
});