Skip to content

Commit a46540a

Browse files
committed
API docs: copyedits in followup to angulardart#124
Post-review edits to address comments made in angulardart#124
1 parent 6a2b38c commit a46540a

File tree

7 files changed

+14
-16
lines changed

7 files changed

+14
-16
lines changed

lib/src/common/directives/ng_class.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ import 'package:angular2/src/core/change_detection/differs/default_keyvalue_diff
4646
/// ```
4747
///
4848
/// Try the [live example][ex].
49-
/// See the [Template Syntax section on `ngClass`][guide] for more details.
49+
/// For details, see the [`ngClass` discussion in the Template Syntax][guide] page.
5050
///
5151
/// [ex]: examples/template-syntax/#ngClass
5252
/// [guide]: docs/guide/template-syntax.html#ngClass

lib/src/common/directives/ng_for.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ import "../../core/change_detection/differs/default_iterable_differ.dart"
8383
/// </template>
8484
/// ```
8585
///
86-
/// See the [Template Syntax section on `ngFor`][guide] for details.
86+
/// For details, see the [`ngFor` discussion in the Template Syntax][guide] page.
8787
///
8888
/// [guide]: docs/guide/template-syntax.html#ngFor
8989
@Directive(

lib/src/common/directives/ng_if.dart

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
11
import 'package:angular2/core.dart'
22
show Directive, ViewContainerRef, TemplateRef;
33

4-
/// Causes an element and its contents to be added/removed from the DOM
5-
/// conditionally, based on the value of the supplied boolean template
6-
/// expression.
4+
/// Causes an element and its contents to be conditionally added/removed from
5+
/// the DOM based on the value of the given boolean template expression.
76
///
8-
/// See the [Template Syntax section on `ngIf`][guide] for more details.
7+
/// For details, see the [`ngIf` discussion in the Template Syntax][guide] page.
98
///
109
/// ### Examples
1110
///

lib/src/common/directives/ng_style.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ import '../../core/change_detection/differs/default_keyvalue_differ.dart'
1414
/// are set based on the map entries: each _key_:_value_ pair identifies a
1515
/// style property _name_ and its _value_.
1616
///
17-
/// See the [Template Syntax section on `NgStyle`][guide] for more details.
17+
/// For details, see the [`NgStyle` discussion in the Template Syntax][guide] page.
1818
///
1919
/// ### Examples
2020
///

lib/src/common/directives/ng_switch.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ class SwitchView {
6060
/// ```
6161
///
6262
/// Try the [live example][ex].
63-
/// See the [Template Syntax section on `ngSwitch`][guide] for more details.
63+
/// For details, see the [`ngSwitch` discussion in the Template Syntax][guide] page.
6464
///
6565
/// [ex]: examples/template-syntax/#ngSwitch
6666
/// [guide]: docs/guide/template-syntax.html#ngSwitch

lib/src/common/forms/directives/ng_model.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ const formControlBinding = const Provider(NgControl, useExisting: NgModel);
3636
/// need is the `ngModel` selector to activate it. For a two-way binding, use
3737
/// the `[(ngModel)]` syntax to ensure the model updates in both directions.
3838
///
39-
/// Learn more about `ngModel` in the Guide [Forms](docs/guide/forms.html#ngModel)
39+
/// Learn more about `ngModel` in the [Forms](docs/guide/forms.html#ngModel)
4040
/// and [Template Syntax](docs/guide/template-syntax.html#ngModel) pages.
4141
///
4242
/// ### Examples

lib/src/core/di/provider.dart

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -158,16 +158,15 @@ class Provider {
158158
bool get multi => _multi ?? false;
159159
}
160160

161-
/// Creates an injector [Provider] for the given [token] based on a given
161+
/// Creates a [Provider] that associates [token] with one of the following:
162162
///
163-
/// - Class
164-
/// - Value
165-
/// - Factory function, or
163+
/// - A class
164+
/// - A value
165+
/// - A factory function
166166
/// - Another token
167167
///
168-
/// The [token] is most commonly a class or an opaque token. More details
169-
/// concerning providers can be found in the [Dependency Injection][di] page
170-
/// of the Angular Guide.
168+
/// A [token] is most commonly a class. See the [Dependency Injection][di] page
169+
/// for more details.
171170
///
172171
/// ### Example
173172
///

0 commit comments

Comments
 (0)