@@ -1010,11 +1010,12 @@ function $StateProvider( $urlRouterProvider, $urlMatcherFactory) {
10101010 * @methodOf ui.router.state.$state
10111011 *
10121012 * @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
10141014 * state stateName. If any params are passed then they will be tested for a match as well.
10151015 * Not all the parameters need to be passed, just the ones you'd like to test for equality.
10161016 *
10171017 * @example
1018+ * Partial and relative names
10181019 * <pre>
10191020 * $state.$current.name = 'contacts.details.item';
10201021 *
@@ -1028,13 +1029,9 @@ function $StateProvider( $urlRouterProvider, $urlMatcherFactory) {
10281029 * // Using relative names (. and ^), typically from a template
10291030 * // E.g. from the 'contacts.details' template
10301031 * <div ng-class="{highlighted: $state.includes('.item')}">Item</div>
1031- *
10321032 * </pre>
10331033 *
1034- * @description
1035- * Basic globbing patterns will also work.
1036- *
1037- * @example
1034+ * Basic globbing patterns
10381035 * <pre>
10391036 * $state.$current.name = 'contacts.details.item.url';
10401037 *
@@ -1049,7 +1046,7 @@ function $StateProvider( $urlRouterProvider, $urlMatcherFactory) {
10491046 *
10501047 * @param {string } stateOrName A partial name, relative name, or glob pattern
10511048 * 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}`,
10531050 * that you'd like to test against the current active state.
10541051 * @returns {boolean } Returns true if it does include the state
10551052 */
0 commit comments