Skip to content
This repository was archived by the owner on Apr 12, 2024. It is now read-only.

Commit ea18f45

Browse files
committed
doc($formFactory): migrated the $formFactory documentation
1 parent 57c37a2 commit ea18f45

File tree

1 file changed

+25
-18
lines changed

1 file changed

+25
-18
lines changed

src/service/formFactory.js

+25-18
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
'use strict';
22

33
/**
4-
* @ngdoc service
5-
* @name angular.service.$formFactory
4+
* @ngdoc object
5+
* @name angular.module.NG.$formFactory
66
*
77
* @description
8-
* Use `$formFactory` to create a new instance of a {@link guide/dev_guide.forms form}
8+
* Use `$formFactory` to create a new instance of a {@link angular.module.NG.$formFactory.Form Form}
99
* controller or to find the nearest form instance for a given DOM element.
1010
*
1111
* The form instance is a collection of widgets, and is responsible for life cycle and validation
@@ -15,7 +15,7 @@
1515
*
1616
* @param {Form=} parentForm The form which should be the parent form of the new form controller.
1717
* If none specified default to the `rootForm`.
18-
* @returns {Form} A new <a href="#form">form</a> instance.
18+
* @returns {Form} A new {@link angular.module.NG.$formFactory.Form Form} instance.
1919
*
2020
* @example
2121
*
@@ -95,14 +95,21 @@
9595
</doc:example>
9696
*/
9797

98+
/**
99+
* @ngdoc object
100+
* @name angular.module.NG.$formFactory.Form
101+
* @description
102+
* The `Form` is a controller which keeps track of the validity of the widgets contained within it.
103+
*/
104+
98105
function $FormFactoryProvider() {
99106
var $parse;
100107
this.$get = ['$rootScope', '$parse', function($rootScope, $parse_) {
101108
$parse = $parse_;
102109
/**
103110
* @ngdoc proprety
104111
* @name rootForm
105-
* @propertyOf angular.service.$formFactory
112+
* @propertyOf angular.module.NG.$formFactory
106113
* @description
107114
* Static property on `$formFactory`
108115
*
@@ -115,7 +122,7 @@ function $FormFactoryProvider() {
115122
/**
116123
* @ngdoc method
117124
* @name forElement
118-
* @methodOf angular.service.$formFactory
125+
* @methodOf angular.module.NG.$formFactory
119126
* @description
120127
* Static method on `$formFactory` service.
121128
*
@@ -142,7 +149,7 @@ function $FormFactoryProvider() {
142149
/**
143150
* @ngdoc property
144151
* @name $error
145-
* @propertyOf angular.service.$formFactory
152+
* @propertyOf angular.module.NG.$formFactory.Form
146153
* @description
147154
* Property of the form and widget instance.
148155
*
@@ -154,7 +161,7 @@ function $FormFactoryProvider() {
154161
/**
155162
* @ngdoc property
156163
* @name $invalid
157-
* @propertyOf angular.service.$formFactory
164+
* @propertyOf angular.module.NG.$formFactory.Form
158165
* @description
159166
* Property of the form and widget instance.
160167
*
@@ -164,7 +171,7 @@ function $FormFactoryProvider() {
164171
/**
165172
* @ngdoc property
166173
* @name $valid
167-
* @propertyOf angular.service.$formFactory
174+
* @propertyOf angular.module.NG.$formFactory.Form
168175
* @description
169176
* Property of the form and widget instance.
170177
*
@@ -173,8 +180,8 @@ function $FormFactoryProvider() {
173180

174181
/**
175182
* @ngdoc event
176-
* @name angular.service.$formFactory#$valid
177-
* @eventOf angular.service.$formFactory
183+
* @name angular.module.NG.$formFactory.Form#$valid
184+
* @eventOf angular.module.NG.$formFactory.Form
178185
* @eventType listen on form
179186
* @description
180187
* Upon receiving the `$valid` event from the widget update the `$error`, `$valid` and `$invalid`
@@ -187,8 +194,8 @@ function $FormFactoryProvider() {
187194

188195
/**
189196
* @ngdoc event
190-
* @name angular.service.$formFactory#$invalid
191-
* @eventOf angular.service.$formFactory
197+
* @name angular.module.NG.$formFactory.Form#$invalid
198+
* @eventOf angular.module.NG.$formFactory.Form
192199
* @eventType listen on form
193200
* @description
194201
* Upon receiving the `$invalid` event from the widget update the `$error`, `$valid` and `$invalid`
@@ -201,8 +208,8 @@ function $FormFactoryProvider() {
201208

202209
/**
203210
* @ngdoc event
204-
* @name angular.service.$formFactory#$validate
205-
* @eventOf angular.service.$formFactory
211+
* @name angular.module.NG.$formFactory.Form#$validate
212+
* @eventOf angular.module.NG.$formFactory.Form
206213
* @eventType emit on widget
207214
* @description
208215
* Emit the `$validate` event on the widget, giving a widget a chance to emit a
@@ -212,8 +219,8 @@ function $FormFactoryProvider() {
212219

213220
/**
214221
* @ngdoc event
215-
* @name angular.service.$formFactory#$viewChange
216-
* @eventOf angular.service.$formFactory
222+
* @name angular.module.NG.$formFactory.Form#$viewChange
223+
* @eventOf angular.module.NG.$formFactory.Form
217224
* @eventType listen on widget
218225
* @description
219226
* A widget is responsible for emitting this event whenever the view changes do to user interaction.
@@ -286,7 +293,7 @@ function $FormFactoryProvider() {
286293
/**
287294
* @ngdoc method
288295
* @name $createWidget
289-
* @methodOf angular.service.$formFactory
296+
* @methodOf angular.module.NG.$formFactory.Form
290297
* @description
291298
*
292299
* Use form's `$createWidget` instance method to create new widgets. The widgets can be created

0 commit comments

Comments
 (0)