From 258e9862840f9d45709664e0e5b2a18540d8828d Mon Sep 17 00:00:00 2001 From: Carl Danley Date: Mon, 22 Jul 2013 11:01:00 -0400 Subject: docs(*): fixed typos and ngdoc parameter names --- src/Angular.js | 4 ++-- src/auto/injector.js | 2 +- src/ng/browser.js | 4 ++-- src/ng/cacheFactory.js | 4 ++-- src/ng/compile.js | 2 +- src/ng/filter.js | 2 +- src/ng/http.js | 2 +- src/ng/location.js | 1 + src/ng/parse.js | 2 +- src/ngScenario/Describe.js | 2 +- src/ngScenario/Future.js | 6 +++--- src/ngScenario/ObjectModel.js | 6 +++--- src/ngScenario/SpecRunner.js | 2 +- 13 files changed, 20 insertions(+), 19 deletions(-) (limited to 'src') diff --git a/src/Angular.js b/src/Angular.js index 68768d34..27b85419 100644 --- a/src/Angular.js +++ b/src/Angular.js @@ -3,7 +3,7 @@ //////////////////////////////////// /** - * hasOwnProperty may be overriden by a property of the same name, or entirely + * hasOwnProperty may be overwritten by a property of the same name, or entirely * absent from an object that does not inherit Object.prototype; this copy is * used instead */ @@ -793,7 +793,7 @@ function toJsonReplacer(key, value) { * * @param {Object|Array|Date|string|number} obj Input to be serialized into JSON. * @param {boolean=} pretty If set to true, the JSON output will contain newlines and whitespace. - * @returns {string|undefined} Jsonified string representing `obj`. + * @returns {string|undefined} JSON-ified string representing `obj`. */ function toJson(obj, pretty) { if (typeof obj === 'undefined') return undefined; diff --git a/src/auto/injector.js b/src/auto/injector.js index 6399dca8..f165030f 100644 --- a/src/auto/injector.js +++ b/src/auto/injector.js @@ -202,7 +202,7 @@ function annotate(fn) { * expect(injector.annotate(MyController)).toEqual(['$scope', '$route']); * * - * This method does not work with code minfication / obfuscation. For this reason the following annotation strategies + * This method does not work with code minification / obfuscation. For this reason the following annotation strategies * are supported. * * # The `$inject` property diff --git a/src/ng/browser.js b/src/ng/browser.js index 8d6fa80b..bfece646 100644 --- a/src/ng/browser.js +++ b/src/ng/browser.js @@ -323,7 +323,7 @@ function Browser(window, document, $log, $sniffer) { /** * @name ng.$browser#defer * @methodOf ng.$browser - * @param {function()} fn A function, who's execution should be defered. + * @param {function()} fn A function, who's execution should be deferred. * @param {number=} [delay=0] of milliseconds to defer the function execution. * @returns {*} DeferId that can be used to cancel the task via `$browser.defer.cancel()`. * @@ -352,7 +352,7 @@ function Browser(window, document, $log, $sniffer) { * @methodOf ng.$browser.defer * * @description - * Cancels a defered task identified with `deferId`. + * Cancels a deferred task identified with `deferId`. * * @param {*} deferId Token returned by the `$browser.defer` function. * @returns {boolean} Returns `true` if the task hasn't executed yet and was successfully canceled. diff --git a/src/ng/cacheFactory.js b/src/ng/cacheFactory.js index 13d16e00..1a0cb549 100644 --- a/src/ng/cacheFactory.js +++ b/src/ng/cacheFactory.js @@ -194,8 +194,8 @@ function $CacheFactoryProvider() { * @name ng.$templateCache * * @description - * The first time a template is used, it is loaded in the template cache for quick retrieval. You can - * load templates directly into the cache in a `script` tag, or by consuming the `$templateCache` + * The first time a template is used, it is loaded in the template cache for quick retrieval. You can + * load templates directly into the cache in a `script` tag, or by consuming the `$templateCache` * service directly. * * Adding via the `script` tag: diff --git a/src/ng/compile.js b/src/ng/compile.js index 9e7f9553..5b12883d 100644 --- a/src/ng/compile.js +++ b/src/ng/compile.js @@ -1312,7 +1312,7 @@ var PREFIX_REGEXP = /^(x[\:\-_]|data[\:\-_])/i; /** * Converts all accepted directives format into proper directive name. * All of these will become 'myDirective': - * my:DiRective + * my:Directive * my-directive * x-my-directive * data-my:directive diff --git a/src/ng/filter.js b/src/ng/filter.js index ac345306..5c6ffd0f 100644 --- a/src/ng/filter.js +++ b/src/ng/filter.js @@ -30,7 +30,7 @@ * } * * - * The filter function is registered with the `$injector` under the filter name suffixe with `Filter`. + * The filter function is registered with the `$injector` under the filter name suffix with `Filter`. *
  *   it('should be the same instance', inject(
  *     function($filterProvider) {
diff --git a/src/ng/http.js b/src/ng/http.js
index 2aedeacb..b1344ec3 100644
--- a/src/ng/http.js
+++ b/src/ng/http.js
@@ -155,7 +155,7 @@ function $HttpProvider() {
 
       /**
        * Response interceptors go before "around" interceptors (no real reason, just
-       * had to pick one.) But they are already revesed, so we can't use unshift, hence
+       * had to pick one.) But they are already reversed, so we can't use unshift, hence
        * the splice.
        */
       reversedInterceptors.splice(index, 0, {
diff --git a/src/ng/location.js b/src/ng/location.js
index a0f03a8e..6ae1066c 100644
--- a/src/ng/location.js
+++ b/src/ng/location.js
@@ -254,6 +254,7 @@ LocationHashbangInHtml5Url.prototype =
    * Change path, search and hash, when called with parameter and return `$location`.
    *
    * @param {string=} url New url without base prefix (e.g. `/path?a=b#hash`)
+   * @param {string=} replace The path that will be changed
    * @return {string} url
    */
   url: function(url, replace) {
diff --git a/src/ng/parse.js b/src/ng/parse.js
index 102b3312..9660c76f 100644
--- a/src/ng/parse.js
+++ b/src/ng/parse.js
@@ -20,7 +20,7 @@ var $parseMinErr = minErr('$parse');
 // the expression, which is a stronger but more expensive test. Since reflective calls are expensive anyway, this is not
 // such a big deal compared to static dereferencing.
 //
-// This sandboxing techniqueue is not perfect and doesn't aim to be. The goal is to prevent exploits against the
+// This sandboxing technique is not perfect and doesn't aim to be. The goal is to prevent exploits against the
 // expression language, but not to prevent exploits that were enabled by exposing sensitive JavaScript or browser apis
 // on Scope. Exposing such objects on a Scope is never a good practice and therefore we are not even trying to protect
 // against interaction with an object explicitly exposed in this way.
diff --git a/src/ngScenario/Describe.js b/src/ngScenario/Describe.js
index 4d52e9d5..77e28a8b 100644
--- a/src/ngScenario/Describe.js
+++ b/src/ngScenario/Describe.js
@@ -94,7 +94,7 @@ angular.scenario.Describe.prototype.xdescribe = angular.noop;
  * Defines a test.
  *
  * @param {string} name Name of the test.
- * @param {function()} vody Body of the block.
+ * @param {function()} body Body of the block.
  */
 angular.scenario.Describe.prototype.it = function(name, body) {
   this.its.push({
diff --git a/src/ngScenario/Future.js b/src/ngScenario/Future.js
index 335dd2bb..4161bef7 100644
--- a/src/ngScenario/Future.js
+++ b/src/ngScenario/Future.js
@@ -3,9 +3,9 @@
 /**
  * A future action in a spec.
  *
- * @param {string} name of the future action
- * @param {function()} future callback(error, result)
- * @param {function()} Optional. function that returns the file/line number.
+ * @param {string} name name of the future action
+ * @param {function()} behavior future callback(error, result)
+ * @param {function()} line Optional. function that returns the file/line number.
  */
 angular.scenario.Future = function(name, behavior, line) {
   this.name = name;
diff --git a/src/ngScenario/ObjectModel.js b/src/ngScenario/ObjectModel.js
index 9c6ce56c..47ee936b 100644
--- a/src/ngScenario/ObjectModel.js
+++ b/src/ngScenario/ObjectModel.js
@@ -170,7 +170,7 @@ angular.scenario.ObjectModel.prototype.getDefinitionPath = function(spec) {
 /**
  * Gets a spec by id.
  *
- * @param {string} The id of the spec to get the object for.
+ * @param {string} id The id of the spec to get the object for.
  * @return {Object} the Spec instance
  */
 angular.scenario.ObjectModel.prototype.getSpec = function(id) {
@@ -195,7 +195,7 @@ angular.scenario.ObjectModel.Spec = function(id, name, definitionNames) {
 /**
  * Adds a new step to the Spec.
  *
- * @param {string} step Name of the step (really name of the future)
+ * @param {string} name Name of the step (really name of the future)
  * @return {Object} the added step
  */
 angular.scenario.ObjectModel.Spec.prototype.addStep = function(name) {
@@ -229,7 +229,7 @@ angular.scenario.ObjectModel.Spec.prototype.setStatusFromStep = function(step) {
 /**
  * A single step inside a Spec.
  *
- * @param {string} step Name of the step
+ * @param {string} name Name of the step
  */
 angular.scenario.ObjectModel.Step = function(name) {
   this.name = name;
diff --git a/src/ngScenario/SpecRunner.js b/src/ngScenario/SpecRunner.js
index 23cc1dc7..d15912d9 100644
--- a/src/ngScenario/SpecRunner.js
+++ b/src/ngScenario/SpecRunner.js
@@ -18,7 +18,7 @@ angular.scenario.SpecRunner = function() {
  * based on the describe nesting.
  *
  * @param {Object} spec A spec object
- * @param {function()} specDone function that is called when the spec finshes. Function(error, index)
+ * @param {function()} specDone function that is called when the spec finishes. Function(error, index)
  */
 angular.scenario.SpecRunner.prototype.run = function(spec, specDone) {
   var self = this;
-- 
cgit v1.2.3