Skip to content

Commit 5797c2e

Browse files
docs($state): document 'parent' parameter
1 parent 06f7379 commit 5797c2e

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

src/state.js

+12-1
Original file line numberDiff line numberDiff line change
@@ -445,6 +445,13 @@ function $StateProvider( $urlRouterProvider, $urlMatcherFactory) {
445445
* published to scope under the controllerAs name.
446446
* <pre>controllerAs: "myCtrl"</pre>
447447
*
448+
* @param {string|object=} stateConfig.parent
449+
* <a id='parent'></a>
450+
* Optionally specifies the parent state of this state.
451+
*
452+
* <pre>parent: 'parentState'</pre>
453+
* <pre>parent: parentState // JS variable</pre>
454+
*
448455
* @param {object=} stateConfig.resolve
449456
* <a id='resolve'></a>
450457
*
@@ -476,15 +483,19 @@ function $StateProvider( $urlRouterProvider, $urlMatcherFactory) {
476483
* transitioned to, the `$stateParams` service will be populated with any
477484
* parameters that were passed.
478485
*
486+
* (See {@link ui.router.util.type:UrlMatcher UrlMatcher} `UrlMatcher`} for
487+
* more details on acceptable patterns )
488+
*
479489
* examples:
480490
* <pre>url: "/home"
481491
* url: "/users/:userid"
482492
* url: "/books/{bookid:[a-zA-Z_-]}"
483493
* url: "/books/{categoryid:int}"
484494
* url: "/books/{publishername:string}/{categoryid:int}"
485495
* url: "/messages?before&after"
486-
* url: "/messages?{before:date}&{after:date}"</pre>
496+
* url: "/messages?{before:date}&{after:date}"
487497
* url: "/messages/:mailboxid?{before:date}&{after:date}"
498+
* </pre>
488499
*
489500
* @param {object=} stateConfig.views
490501
* <a id='views'></a>

0 commit comments

Comments
 (0)