aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAnthony Lieuallen2011-02-14 13:17:04 -0500
committerIgor Minar2011-02-16 00:04:15 -0500
commit7cf70c587e436014b2148eb4f12ecda307d25957 (patch)
treedf8171b59e9abd8515fcb93fd5901abcd08af9f7
parent1777110958f76ee4be5760e36c96702223385918 (diff)
downloadangular.js-7cf70c587e436014b2148eb4f12ecda307d25957.tar.bz2
Small spelling and grammar fixes in documentation.
-rw-r--r--src/Angular.js10
-rw-r--r--src/Browser.js6
-rw-r--r--src/Scope.js12
-rw-r--r--src/directives.js6
-rw-r--r--src/service/document.js2
-rw-r--r--src/service/resource.js2
-rw-r--r--src/service/window.js2
7 files changed, 20 insertions, 20 deletions
diff --git a/src/Angular.js b/src/Angular.js
index 710d96f5..4187e9ad 100644
--- a/src/Angular.js
+++ b/src/Angular.js
@@ -195,7 +195,7 @@ function formatError(arg) {
* @function
*
* @description
- * Extends the destination object `dst` by copying all of the properties from the `src` objects to
+ * Extends the destination object `dst` by copying all of the properties from the `src` object(s) to
* `dst`. You can specify multiple `src` objects.
*
* @param {Object} dst The destination object.
@@ -741,11 +741,11 @@ function concat(array1, array2, index) {
* @function
*
* @description
- * Returns function which calls function `fn` bound to `self` (`self` becomes the `this` for `fn`).
+ * Returns a function which calls function `fn` bound to `self` (`self` becomes the `this` for `fn`).
* Optional `args` can be supplied which are prebound to the function, also known as
* [function currying](http://en.wikipedia.org/wiki/Currying).
*
- * @param {Object} self Context in which `fn` should be evaluated in.
+ * @param {Object} self Context which `fn` should be evaluated in.
* @param {function()} fn Function to be bound.
* @param {...*} args Optional arguments to be prebound to the `fn` function call.
* @returns {function()} Function that wraps the `fn` with all the specified bindings.
@@ -850,8 +850,8 @@ function toKeyValue(obj) {
* @TODO rename to ng:autobind to ng:autoboot
*
* @description
- * This section explains how to bootstrap your application with angular using either the angular
- * javascript file.
+ * This section explains how to bootstrap your application with angular, using either the angular
+ * javascript file, or manually.
*
*
* ## The angular distribution
diff --git a/src/Browser.js b/src/Browser.js
index bc278b28..7f8ee729 100644
--- a/src/Browser.js
+++ b/src/Browser.js
@@ -228,7 +228,7 @@ function Browser(window, document, body, XHR, $log) {
* The listener gets called with either HashChangeEvent object or simple object that also contains
* `oldURL` and `newURL` properties.
*
- * NOTE: this is a api is intended for sole use by $location service. Please use
+ * NOTE: this api is intended for use only by the $location service. Please use the
* {@link angular.service.$location $location service} to monitor hash changes in angular apps.
*
* @param {function(event)} listener Listener function to be called when url hash changes.
@@ -330,7 +330,7 @@ function Browser(window, document, body, XHR, $log) {
* Executes a fn asynchroniously via `setTimeout(fn, delay)`.
*
* Unlike when calling `setTimeout` directly, in test this function is mocked and instead of using
- * `setTimeout` in tests, the fns are queued in an array, which can be programaticaly flushed via
+ * `setTimeout` in tests, the fns are queued in an array, which can be programmatically flushed via
* `$browser.defer.flush()`.
*
*/
@@ -353,7 +353,7 @@ function Browser(window, document, body, XHR, $log) {
* @description
* Set hover listener.
*
- * @param {function(Object, boolean)} listener Function that will be called when hover event
+ * @param {function(Object, boolean)} listener Function that will be called when a hover event
* occurs.
*/
self.hover = function(listener) { hoverListener = listener; };
diff --git a/src/Scope.js b/src/Scope.js
index 0084d80c..7d802a51 100644
--- a/src/Scope.js
+++ b/src/Scope.js
@@ -119,13 +119,13 @@ function errorHandlerFor(element, error) {
* - Scopes can be nested. A scope (prototypically) inherits properties from its parent scope.
* - Scopes can be attached (bound) to the HTML DOM tree (the view).
* - A scope {@link angular.scope.$become becomes} `this` for a controller.
- * - Scope's {@link angular.scope.$eval $eval} is used to update its view.
+ * - A scope's {@link angular.scope.$eval $eval} is used to update its view.
* - Scopes can {@link angular.scope.$watch watch} properties and fire events.
*
* # Basic Operations
* Scopes can be created by calling {@link angular.scope() angular.scope()} or by compiling HTML.
*
- * {@link angular.widget Widgets} and data bindings register listeners on the current scope to get
+ * {@link angular.widget Widgets} and data bindings register listeners on the current scope to be
* notified of changes to the scope state. When notified, these listeners push the updated state
* through to the DOM.
*
@@ -172,7 +172,7 @@ function errorHandlerFor(element, error) {
*
* # When scopes are evaluated
* Anyone can update a scope by calling its {@link angular.scope.$eval $eval()} method. By default
- * angular widgets listen to user change events (e.g. the user enters text into text field), copy
+ * angular widgets listen to user change events (e.g. the user enters text into a text field), copy
* the data from the widget to the scope (the MVC model), and then call the `$eval()` method on the
* root scope to update dependents. This creates a spreadsheet-like behavior: the bound views update
* immediately as the user types into the text field.
@@ -183,7 +183,7 @@ function errorHandlerFor(element, error) {
*
* Because a change in the model that's triggered either by user input or by server response calls
* `$eval()`, it is unnecessary to call `$eval()` from within your controller. The only time when
- * calling `$eval()` is needed, is when implementing a custom widget or service.
+ * calling `$eval()` is needed is when implementing a custom widget or service.
*
* Because scopes are inherited, the child scope `$eval()` overrides the parent `$eval()` method.
* So to update the whole page you need to call `$eval()` on the root scope as `$root.$eval()`.
@@ -393,7 +393,7 @@ function createScope(parent, providers, instanceCache) {
* {@link angular.scope.$eval()} with expression parameter, but also wraps it in a try/catch
* block.
*
- * If exception is thrown then `exceptionHandler` is used to handle the exception.
+ * If an exception is thrown then `exceptionHandler` is used to handle the exception.
*
* # Example
<pre>
@@ -448,7 +448,7 @@ function createScope(parent, providers, instanceCache) {
*
* @description
* Registers `listener` as a callback to be executed every time the `watchExp` changes. Be aware
- * that callback gets, by default, called upon registration, this can be prevented via the
+ * that the callback gets, by default, called upon registration, this can be prevented via the
* `initRun` parameter.
*
* # Example
diff --git a/src/directives.js b/src/directives.js
index e0421114..06a99149 100644
--- a/src/directives.js
+++ b/src/directives.js
@@ -700,7 +700,7 @@ angularDirective("ng:class-even", ngClass(function(i){return i % 2 === 1;}));
* of the HTML conditionally.
*
* @element ANY
- * @param {expression} expression If the {@link guide.expression expression} truthy then the element
+ * @param {expression} expression If the {@link guide.expression expression} is truthy then the element
* is shown or hidden respectively.
*
* @example
@@ -781,8 +781,8 @@ angularDirective("ng:hide", function(expression, element){
* The ng:style allows you to set CSS style on an HTML element conditionally.
*
* @element ANY
- * @param {expression} expression {@link guide.expression Expression} which evals to an object who's
- * keys are CSS style names and values are coresponding values for those CSS keys.
+ * @param {expression} expression {@link guide.expression Expression} which evals to an object whose
+ * keys are CSS style names and values are corresponding values for those CSS keys.
*
* @example
<doc:example>
diff --git a/src/service/document.js b/src/service/document.js
index 93d4d9a5..f15c5900 100644
--- a/src/service/document.js
+++ b/src/service/document.js
@@ -5,7 +5,7 @@
* @requires $window
*
* @description
- * Reference to the browser window.document, but wrapped into angular.element().
+ * A reference to the browser window.document, but wrapped into angular.element().
*/
angularServiceInject("$document", function(window){
return jqLite(window.document);
diff --git a/src/service/resource.js b/src/service/resource.js
index 9e86caa7..3cb7b6e8 100644
--- a/src/service/resource.js
+++ b/src/service/resource.js
@@ -5,7 +5,7 @@
* @requires $xhr.cache
*
* @description
- * Is a factory which creates a resource object that lets you interact with
+ * A factory which creates a resource object that lets you interact with
* [RESTful](http://en.wikipedia.org/wiki/Representational_State_Transfer) server-side data sources.
*
* The returned resource object has action methods which provide high-level behaviors without
diff --git a/src/service/window.js b/src/service/window.js
index 2392e7f9..412bf39b 100644
--- a/src/service/window.js
+++ b/src/service/window.js
@@ -4,7 +4,7 @@
* @name angular.service.$window
*
* @description
- * Is reference to the browser's `window` object. While `window`
+ * A reference to the browser's `window` object. While `window`
* is globally available in JavaScript, it causes testability problems, because
* it is a global variable. In angular we always refer to it through the
* `$window` service, so it may be overriden, removed or mocked for testing.