@@ -1010,11 +1010,12 @@ function $StateProvider( $urlRouterProvider, $urlMatcherFactory) {
1010
1010
* @methodOf ui.router.state.$state
1011
1011
*
1012
1012
* @description
1013
- * A method to determine if the current active state is equal to or is the child of the
1013
+ * A method to determine if the current active state is equal to or is the child of the
1014
1014
* state stateName. If any params are passed then they will be tested for a match as well.
1015
1015
* Not all the parameters need to be passed, just the ones you'd like to test for equality.
1016
1016
*
1017
1017
* @example
1018
+ * Partial and relative names
1018
1019
* <pre>
1019
1020
* $state.$current.name = 'contacts.details.item';
1020
1021
*
@@ -1028,13 +1029,9 @@ function $StateProvider( $urlRouterProvider, $urlMatcherFactory) {
1028
1029
* // Using relative names (. and ^), typically from a template
1029
1030
* // E.g. from the 'contacts.details' template
1030
1031
* <div ng-class="{highlighted: $state.includes('.item')}">Item</div>
1031
- *
1032
1032
* </pre>
1033
1033
*
1034
- * @description
1035
- * Basic globbing patterns will also work.
1036
- *
1037
- * @example
1034
+ * Basic globbing patterns
1038
1035
* <pre>
1039
1036
* $state.$current.name = 'contacts.details.item.url';
1040
1037
*
@@ -1049,7 +1046,7 @@ function $StateProvider( $urlRouterProvider, $urlMatcherFactory) {
1049
1046
*
1050
1047
* @param {string } stateOrName A partial name, relative name, or glob pattern
1051
1048
* to be searched for within the current state name.
1052
- * @param {object } params A param object, e.g. `{sectionId: section.id}`,
1049
+ * @param {object } params A param object, e.g. `{sectionId: section.id}`,
1053
1050
* that you'd like to test against the current active state.
1054
1051
* @returns {boolean } Returns true if it does include the state
1055
1052
*/
0 commit comments