docs(*): fixed typos and ngdoc parameter names

carldanley · pkozlowski-opensource · commit 258e9862840f · 2013-07-27T20:53:41.000+02:00
diff --git 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
@@ -202,7 +202,7 @@ function annotate(fn) {
  *   expect(injector.annotate(MyController)).toEqual(['$scope', '$route']);
  * </pre>
  *
- * 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
@@ -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
@@ -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
@@ -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
@@ -30,7 +30,7 @@
  *   }
  * </pre>
  *
- * 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`.
  * <pre>
  *   it('should be the same instance', inject(
  *     function($filterProvider) {
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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;

Original file line number	Diff line number	Diff line change
`@@ -202,7 +202,7 @@ function annotate(fn) {`
`202`	`202`	`* expect(injector.annotate(MyController)).toEqual(['$scope', '$route']);`
`203`	`203`	`* </pre>`
`204`	`204`	`*`
`205`		`- * This method does not work with code minfication / obfuscation. For this reason the following annotation strategies`
	`205`	`+ * This method does not work with code minification / obfuscation. For this reason the following annotation strategies`
`206`	`206`	`* are supported.`
`207`	`207`	`*`
`208`	`208`	* # The `$inject` property
Original file line number	Diff line number	Diff line change
`@@ -323,7 +323,7 @@ function Browser(window, document, $log, $sniffer) {`
`323`	`323`	`/**`
`324`	`324`	`* @name ng.$browser#defer`
`325`	`325`	`* @methodOf ng.$browser`
`326`		`- * @param {function()} fn A function, who's execution should be defered.`
	`326`	`+ * @param {function()} fn A function, who's execution should be deferred.`
`327`	`327`	`* @param {number=} [delay=0] of milliseconds to defer the function execution.`
`328`	`328`	* @returns {*} DeferId that can be used to cancel the task via `$browser.defer.cancel()`.
`329`	`329`	`*`
`@@ -352,7 +352,7 @@ function Browser(window, document, $log, $sniffer) {`
`352`	`352`	`* @methodOf ng.$browser.defer`
`353`	`353`	`*`
`354`	`354`	`* @description`
`355`		- * Cancels a defered task identified with `deferId`.
	`355`	+ * Cancels a deferred task identified with `deferId`.
`356`	`356`	`*`
`357`	`357`	* @param {*} deferId Token returned by the `$browser.defer` function.
`358`	`358`	* @returns {boolean} Returns `true` if the task hasn't executed yet and was successfully canceled.
Original file line number	Diff line number	Diff line change
`@@ -194,8 +194,8 @@ function $CacheFactoryProvider() {`
`194`	`194`	`* @name ng.$templateCache`
`195`	`195`	`*`
`196`	`196`	`* @description`
`197`		`- * The first time a template is used, it is loaded in the template cache for quick retrieval. You can`
`198`		- * load templates directly into the cache in a `script` tag, or by consuming the `$templateCache`
	`197`	`+ * The first time a template is used, it is loaded in the template cache for quick retrieval. You can`
	`198`	+ * load templates directly into the cache in a `script` tag, or by consuming the `$templateCache`
`199`	`199`	`* service directly.`
`200`	`200`	`*`
`201`	`201`	* Adding via the `script` tag:
Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@`
`30`	`30`	`* }`
`31`	`31`	`* </pre>`
`32`	`32`	`*`
`33`		- * The filter function is registered with the `$injector` under the filter name suffixe with `Filter`.
	`33`	+ * The filter function is registered with the `$injector` under the filter name suffix with `Filter`.
`34`	`34`	`* <pre>`
`35`	`35`	`* it('should be the same instance', inject(`
`36`	`36`	`* function($filterProvider) {`
Original file line number	Diff line number	Diff line change
`@@ -254,6 +254,7 @@ LocationHashbangInHtml5Url.prototype =`
`254`	`254`	* Change path, search and hash, when called with parameter and return `$location`.
`255`	`255`	`*`
`256`	`256`	* @param {string=} url New url without base prefix (e.g. `/path?a=b#hash`)
	`257`	`+ * @param {string=} replace The path that will be changed`
`257`	`258`	`* @return {string} url`
`258`	`259`	`*/`
`259`	`260`	`url: function(url, replace) {`
Original file line number	Diff line number	Diff line change
`@@ -94,7 +94,7 @@ angular.scenario.Describe.prototype.xdescribe = angular.noop;`
`94`	`94`	`* Defines a test.`
`95`	`95`	`*`
`96`	`96`	`* @param {string} name Name of the test.`
`97`		`- * @param {function()} vody Body of the block.`
	`97`	`+ * @param {function()} body Body of the block.`
`98`	`98`	`*/`
`99`	`99`	`angular.scenario.Describe.prototype.it = function(name, body) {`
`100`	`100`	`this.its.push({`