Skip to content

Commit 644cc20

Browse files
committed
fix(core): Reword documentation
1 parent 72508ff commit 644cc20

1 file changed

Lines changed: 4 additions & 5 deletions

File tree

projects/ngqp/core/src/lib/directives/query-param.directive.ts

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,10 @@ import { QueryParam } from '../model/query-param';
77
import { QueryParamGroup } from '../model/query-param-group';
88

99
/**
10-
* Binds a standalone {@link QueryParam} to a DOM element.
10+
* Binds a {@link QueryParam} to a component directly.
1111
*
12-
* This directive accepts a {@link QueryParam} without having outer {@link QueryParamGroup}.
13-
* It binds this parameter to the host element, which is required to have a [ControlValueAccessor]
12+
* This directive accepts a {@link QueryParam} without requiring an outer {@link QueryParamGroup}.
13+
* It binds this parameter to the host component, which is required to have a [ControlValueAccessor]
1414
* {@link https://angular.io/api/forms/ControlValueAccessor}.
1515
*/
1616
@Directive({
@@ -20,8 +20,7 @@ import { QueryParamGroup } from '../model/query-param-group';
2020
export class QueryParamDirective implements QueryParamAccessor, OnChanges, OnDestroy {
2121

2222
/**
23-
* Reference to standalone {@link QueryParam} instance.
24-
* Note that this does not refer to the [parameter name]{@link QueryParam#urlParam}.
23+
* The {@link QueryParam} to bind to the host component.
2524
*/
2625
@Input('queryParam')
2726
public queryParam: QueryParam<any>;

0 commit comments

Comments
 (0)