Skip to content

Commit c0f9d36

Browse files
naaajiinaaajii
committed
main - d93900c build: update dgeni templates to include deprecated tag description
1 parent 3687ac1 commit c0f9d36

24 files changed

+160
-76
lines changed

‎docs-content/api-docs/cdk-a11y.html‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -418,7 +418,8 @@ <h5 class="docs-api-h5 docs-api-method-header">Methods</h5>
418418
<table class="docs-api-method-table">
419419
<thead>
420420
<tr class="docs-api-method-name-row">
421-
<th colspan="2" class="docs-api-method-name-cell"><div class="docs-api-deprecated-marker" title="Will be removed in v11.0.0 or later">
421+
<th colspan="2" class="docs-api-method-name-cell"><div class="docs-api-deprecated-marker" deprecated-message="Pass a config object instead of the `deferCaptureElements` flag. Will be removed in v11.0.0 or later."
422+
>
422423
Deprecated
423424
</div>create
424425
</th>
@@ -6934,7 +6935,8 @@ <h4 id="INPUT_MODALITY_DETECTOR_OPTIONS" class="docs-header-link docs-api-h4 doc
69346935
<h4 id="MESSAGES_CONTAINER_ID" class="docs-header-link docs-api-h4 docs-api-constant-name">
69356936
<span header-link="MESSAGES_CONTAINER_ID"></span>
69366937
<code>MESSAGES_CONTAINER_ID</code>
6937-
</h4><div class="docs-api-constant-deprecated-marker" title="Will be removed in v14.0.0 or later">
6938+
</h4><div class="docs-api-constant-deprecated-marker" deprecated-message="No longer being used. To be removed. Will be removed in v14.0.0 or later."
6939+
>
69386940
Deprecated
69396941
</div><p class="docs-api-constant-description"><p>ID used for the body container where all messages are appended.</p>
69406942
</p><div class="docs-markdown">
@@ -6950,7 +6952,8 @@ <h4 id="MESSAGES_CONTAINER_ID" class="docs-header-link docs-api-h4 docs-api-cons
69506952
<h4 id="CDK_DESCRIBEDBY_ID_PREFIX" class="docs-header-link docs-api-h4 docs-api-constant-name">
69516953
<span header-link="CDK_DESCRIBEDBY_ID_PREFIX"></span>
69526954
<code>CDK_DESCRIBEDBY_ID_PREFIX</code>
6953-
</h4><div class="docs-api-constant-deprecated-marker" title="Will be removed in v14.0.0 or later">
6955+
</h4><div class="docs-api-constant-deprecated-marker" deprecated-message="To be turned into a private variable. Will be removed in v14.0.0 or later."
6956+
>
69546957
Deprecated
69556958
</div><p class="docs-api-constant-description"><p>ID prefix used for each created message element.</p>
69566959
</p><div class="docs-markdown">
@@ -6966,7 +6969,8 @@ <h4 id="CDK_DESCRIBEDBY_ID_PREFIX" class="docs-header-link docs-api-h4 docs-api-
69666969
<h4 id="CDK_DESCRIBEDBY_HOST_ATTRIBUTE" class="docs-header-link docs-api-h4 docs-api-constant-name">
69676970
<span header-link="CDK_DESCRIBEDBY_HOST_ATTRIBUTE"></span>
69686971
<code>CDK_DESCRIBEDBY_HOST_ATTRIBUTE</code>
6969-
</h4><div class="docs-api-constant-deprecated-marker" title="Will be removed in v14.0.0 or later">
6972+
</h4><div class="docs-api-constant-deprecated-marker" deprecated-message="To be turned into a private variable. Will be removed in v14.0.0 or later."
6973+
>
69706974
Deprecated
69716975
</div><p class="docs-api-constant-description"><p>Attribute given to each host element that is described by a message element.</p>
69726976
</p><div class="docs-markdown">

‎docs-content/api-docs/cdk-dialog.html‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -780,7 +780,8 @@ <h4 id="DialogConfig" class="docs-header-link docs-api-h4 docs-api-class-name">
780780

781781

782782
<tr class="docs-api-properties-row">
783-
<td class="docs-api-properties-name-cell"><div class="docs-api-deprecated-marker" title="Will be removed in v20.0.0 or later">
783+
<td class="docs-api-properties-name-cell"><div class="docs-api-deprecated-marker" deprecated-message="No longer used. Will be removed. Will be removed in v20.0.0 or later."
784+
>
784785
Deprecated
785786
</div><p class="docs-api-property-name">
786787
<code>componentFactoryResolver: unknown</code>

‎docs-content/api-docs/cdk-overlay.html‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2399,7 +2399,8 @@ <h5 class="docs-api-h5 docs-api-method-header">Methods</h5>
23992399
<table class="docs-api-method-table">
24002400
<thead>
24012401
<tr class="docs-api-method-name-row">
2402-
<th colspan="2" class="docs-api-method-name-cell"><div class="docs-api-deprecated-marker" title="Will be removed in v8.0.0 or later">
2402+
<th colspan="2" class="docs-api-method-name-cell"><div class="docs-api-deprecated-marker" deprecated-message="Pass the `height` through the `OverlayConfig`. Will be removed in v8.0.0 or later."
2403+
>
24032404
Deprecated
24042405
</div>height
24052406
</th>
@@ -2451,7 +2452,8 @@ <h5 class="docs-api-h5 docs-api-method-header">Methods</h5>
24512452
<table class="docs-api-method-table">
24522453
<thead>
24532454
<tr class="docs-api-method-name-row">
2454-
<th colspan="2" class="docs-api-method-name-cell"><div class="docs-api-deprecated-marker" title="Will be removed in v8.0.0 or later">
2455+
<th colspan="2" class="docs-api-method-name-cell"><div class="docs-api-deprecated-marker" deprecated-message="Pass the `width` through the `OverlayConfig`. Will be removed in v8.0.0 or later."
2456+
>
24552457
Deprecated
24562458
</div>width
24572459
</th>

‎docs-content/api-docs/cdk-portal.html‎

Lines changed: 20 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -275,7 +275,8 @@ <h4 id="TemplatePortalDirective" class="docs-header-link docs-api-h4 docs-api-cl
275275
<span class="docs-api-class-selector-name">[portal]</span>
276276

277277
</p><span class="docs-api-class-export-label">Exported as:</span>
278-
<span class="docs-api-class-export-name">cdkPortal</span><div class="docs-api-class-deprecated-marker" title="Will be removed in v9.0.0 or later">
278+
<span class="docs-api-class-export-name">cdkPortal</span><div class="docs-api-class-deprecated-marker" deprecated-message="Use `CdkPortal` instead. Will be removed in v9.0.0 or later."
279+
>
279280
Deprecated
280281
</div><h5 class="docs-api-h5 docs-api-method-header">Properties</h5>
281282
<table class="docs-api-properties-table">
@@ -556,7 +557,8 @@ <h4 id="CdkPortalOutlet" class="docs-header-link docs-api-h4 docs-api-class-name
556557

557558

558559
<tr class="docs-api-properties-row">
559-
<td class="docs-api-properties-name-cell"><div class="docs-api-deprecated-marker" title="Will be removed in v10.0.0 or later">
560+
<td class="docs-api-properties-name-cell"><div class="docs-api-deprecated-marker" deprecated-message="To be turned into a method. Will be removed in v10.0.0 or later."
561+
>
560562
Deprecated
561563
</div><p class="docs-api-property-name">
562564
<code>attachDomPortal: (portal: DomPortal) =&gt; {
@@ -912,7 +914,8 @@ <h4 id="PortalHostDirective" class="docs-header-link docs-api-h4 docs-api-class-
912914
<span class="docs-api-class-selector-name">[portalHost]</span>
913915

914916
</p><span class="docs-api-class-export-label">Exported as:</span>
915-
<span class="docs-api-class-export-name">cdkPortalHost</span><div class="docs-api-class-deprecated-marker" title="Will be removed in v9.0.0 or later">
917+
<span class="docs-api-class-export-name">cdkPortalHost</span><div class="docs-api-class-deprecated-marker" deprecated-message="Use `CdkPortalOutlet` instead. Will be removed in v9.0.0 or later."
918+
>
916919
Deprecated
917920
</div><h5 class="docs-api-h5 docs-api-method-header">Properties</h5>
918921
<table class="docs-api-properties-table">
@@ -965,7 +968,8 @@ <h4 id="PortalHostDirective" class="docs-header-link docs-api-h4 docs-api-class-
965968

966969

967970
<tr class="docs-api-properties-row">
968-
<td class="docs-api-properties-name-cell"><div class="docs-api-deprecated-marker" title="Will be removed in v10.0.0 or later">
971+
<td class="docs-api-properties-name-cell"><div class="docs-api-deprecated-marker" deprecated-message="To be turned into a method. Will be removed in v10.0.0 or later."
972+
>
969973
Deprecated
970974
</div><p class="docs-api-property-name">
971975
<code>attachDomPortal: (portal: DomPortal) =&gt; {
@@ -1534,7 +1538,8 @@ <h4 id="ComponentPortal" class="docs-header-link docs-api-h4 docs-api-class-name
15341538

15351539

15361540
<tr class="docs-api-properties-row">
1537-
<td class="docs-api-properties-name-cell"><div class="docs-api-deprecated-marker" title="Will be removed in v18.0.0 or later">
1541+
<td class="docs-api-properties-name-cell"><div class="docs-api-deprecated-marker" deprecated-message="No longer in use. To be removed. Will be removed in v18.0.0 or later."
1542+
>
15381543
Deprecated
15391544
</div><p class="docs-api-property-name">
15401545
<code>componentFactoryResolver: any</code>
@@ -2369,7 +2374,8 @@ <h4 id="BasePortalHost" class="docs-header-link docs-api-h4 docs-api-class-name"
23692374
</a>
23702375
</span>
23712376

2372-
</h4><div class="docs-api-class-deprecated-marker" title="Will be removed in v9.0.0 or later">
2377+
</h4><div class="docs-api-class-deprecated-marker" deprecated-message="Use `BasePortalOutlet` instead. Will be removed in v9.0.0 or later."
2378+
>
23732379
Deprecated
23742380
</div><h5 class="docs-api-h5 docs-api-method-header">Properties</h5>
23752381
<table class="docs-api-properties-table">
@@ -2722,7 +2728,8 @@ <h4 id="DomPortalOutlet" class="docs-header-link docs-api-h4 docs-api-class-name
27222728

27232729

27242730
<tr class="docs-api-properties-row">
2725-
<td class="docs-api-properties-name-cell"><div class="docs-api-deprecated-marker" title="Will be removed in v10.0.0 or later">
2731+
<td class="docs-api-properties-name-cell"><div class="docs-api-deprecated-marker" deprecated-message="To be turned into a method. Will be removed in v10.0.0 or later."
2732+
>
27262733
Deprecated
27272734
</div><p class="docs-api-property-name">
27282735
<code>attachDomPortal: (portal: DomPortal) =&gt; {
@@ -3069,7 +3076,8 @@ <h4 id="DomPortalHost" class="docs-header-link docs-api-h4 docs-api-class-name">
30693076
</a>
30703077
</span>
30713078

3072-
</h4><div class="docs-api-class-deprecated-marker" title="Will be removed in v9.0.0 or later">
3079+
</h4><div class="docs-api-class-deprecated-marker" deprecated-message="Use `DomPortalOutlet` instead. Will be removed in v9.0.0 or later."
3080+
>
30733081
Deprecated
30743082
</div><h5 class="docs-api-h5 docs-api-method-header">Properties</h5>
30753083
<table class="docs-api-properties-table">
@@ -3094,7 +3102,8 @@ <h4 id="DomPortalHost" class="docs-header-link docs-api-h4 docs-api-class-name">
30943102

30953103

30963104
<tr class="docs-api-properties-row">
3097-
<td class="docs-api-properties-name-cell"><div class="docs-api-deprecated-marker" title="Will be removed in v10.0.0 or later">
3105+
<td class="docs-api-properties-name-cell"><div class="docs-api-deprecated-marker" deprecated-message="To be turned into a method. Will be removed in v10.0.0 or later."
3106+
>
30983107
Deprecated
30993108
</div><p class="docs-api-property-name">
31003109
<code>attachDomPortal: (portal: DomPortal) =&gt; {
@@ -3643,7 +3652,8 @@ <h3 id="cdk-portal-type_aliases" class="docs-header-link docs-api-h3">
36433652
<h4 id="PortalHost" class="docs-header-link docs-api-h4 docs-api-type-alias-name">
36443653
<span header-link="PortalHost"></span>
36453654
<code>PortalHost</code>
3646-
</h4><div class="docs-api-type-alias-deprecated-marker" title="Will be removed in v9.0.0 or later">
3655+
</h4><div class="docs-api-type-alias-deprecated-marker" deprecated-message="Use `PortalOutlet` instead. Will be removed in v9.0.0 or later."
3656+
>
36473657
Deprecated
36483658
</div><div class="docs-markdown">
36493659
<pre class="docs-markdown-pre">

‎docs-content/api-docs/cdk-tree.html‎

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -199,7 +199,9 @@ <h4 id="CdkNestedTreeNode" class="docs-header-link docs-api-h4 docs-api-class-na
199199

200200
<tr class="docs-api-properties-row">
201201
<td class="docs-api-properties-name-cell"><div class="docs-api-input-marker">
202-
@Input()</div><div class="docs-api-deprecated-marker" title="Will be removed in v21.0.0 or later">
202+
@Input()</div><div class="docs-api-deprecated-marker" deprecated-message="This will be ignored; the tree will automatically determine the appropriate role
203+
for tree node. This input will be removed in a future version. Will be removed in v21.0.0 or later."
204+
>
203205
Deprecated
204206
</div><p class="docs-api-property-name">
205207
<code>role: &#39;treeitem&#39; | &#39;group&#39;</code>
@@ -712,7 +714,9 @@ <h4 id="CdkTree" class="docs-header-link docs-api-h4 docs-api-class-name">
712714

713715
<tr class="docs-api-properties-row">
714716
<td class="docs-api-properties-name-cell"><div class="docs-api-input-marker">
715-
@Input()</div><div class="docs-api-deprecated-marker" title="Will be removed in v21.0.0 or later">
717+
@Input()</div><div class="docs-api-deprecated-marker" deprecated-message="Use one of `levelAccessor` or `childrenAccessor` instead. To be removed in a
718+
future version. Will be removed in v21.0.0 or later."
719+
>
716720
Deprecated
717721
</div><p class="docs-api-property-name">
718722
<code>treeControl: TreeControl&lt;T, K&gt;</code>
@@ -1338,7 +1342,9 @@ <h4 id="CdkTreeNode" class="docs-header-link docs-api-h4 docs-api-class-name">
13381342

13391343
<tr class="docs-api-properties-row">
13401344
<td class="docs-api-properties-name-cell"><div class="docs-api-input-marker">
1341-
@Input()</div><div class="docs-api-deprecated-marker" title="Will be removed in v21.0.0 or later">
1345+
@Input()</div><div class="docs-api-deprecated-marker" deprecated-message="This will be ignored; the tree will automatically determine the appropriate role
1346+
for tree node. This input will be removed in a future version. Will be removed in v21.0.0 or later."
1347+
>
13421348
Deprecated
13431349
</div><p class="docs-api-property-name">
13441350
<code>role: &#39;treeitem&#39; | &#39;group&#39;</code>
@@ -1591,7 +1597,8 @@ <h4 id="BaseTreeControl" class="docs-header-link docs-api-h4 docs-api-class-name
15911597
<code>BaseTreeControl</code>
15921598

15931599
</h4><p class="docs-api-class-description"><p>Base tree control. It has basic toggle/expand/collapse operations on a single data node.</p>
1594-
</p><div class="docs-api-class-deprecated-marker" title="Will be removed in v21.0.0 or later">
1600+
</p><div class="docs-api-class-deprecated-marker" deprecated-message="Use one of levelAccessor or childrenAccessor. To be removed in a future version. Will be removed in v21.0.0 or later."
1601+
>
15951602
Deprecated
15961603
</div><h5 class="docs-api-h5 docs-api-method-header">Properties</h5>
15971604
<table class="docs-api-properties-table">
@@ -2046,7 +2053,9 @@ <h4 id="FlatTreeControl" class="docs-header-link docs-api-h4 docs-api-class-name
20462053
</span>
20472054

20482055
</h4><p class="docs-api-class-description"><p>Flat tree control. Able to expand/collapse a subtree recursively for flattened tree.</p>
2049-
</p><div class="docs-api-class-deprecated-marker" title="Will be removed in v21.0.0 or later">
2056+
</p><div class="docs-api-class-deprecated-marker" deprecated-message="Use one of levelAccessor or childrenAccessor instead. To be removed in a future
2057+
version. Will be removed in v21.0.0 or later."
2058+
>
20502059
Deprecated
20512060
</div><h5 class="docs-api-h5 docs-api-method-header">Properties</h5>
20522061
<table class="docs-api-properties-table">
@@ -2514,7 +2523,9 @@ <h4 id="NestedTreeControl" class="docs-header-link docs-api-h4 docs-api-class-na
25142523
</span>
25152524

25162525
</h4><p class="docs-api-class-description"><p>Nested tree control. Able to expand/collapse a subtree recursively for NestedNode type.</p>
2517-
</p><div class="docs-api-class-deprecated-marker" title="Will be removed in v21.0.0 or later">
2526+
</p><div class="docs-api-class-deprecated-marker" deprecated-message="Use one of levelAccessor or childrenAccessor instead. To be removed in a future
2527+
version. Will be removed in v21.0.0 or later."
2528+
>
25182529
Deprecated
25192530
</div><h5 class="docs-api-h5 docs-api-method-header">Properties</h5>
25202531
<table class="docs-api-properties-table">
@@ -3133,7 +3144,8 @@ <h4 id="TreeControl" class="docs-header-link docs-api-h4 docs-api-interface-name
31333144
</h4><p class="docs-api-interface-description"><p>Tree control interface. User can implement TreeControl to expand/collapse dataNodes in the tree.
31343145
The CDKTree will use this TreeControl to expand/collapse a node.
31353146
User can also use it outside the <code>&lt;cdk-tree&gt;</code> to control the expansion status of the tree.</p>
3136-
</p><div class="docs-api-interface-deprecated-marker" title="Will be removed in v21.0.0 or later">
3147+
</p><div class="docs-api-interface-deprecated-marker" deprecated-message="Use one of levelAccessor or childrenAccessor instead. To be removed in a future version. Will be removed in v21.0.0 or later."
3148+
>
31373149
Deprecated
31383150
</div><h5 class="docs-api-h5 docs-api-method-header">Properties</h5>
31393151
<table class="docs-api-properties-table">

‎docs-content/api-docs/material-button-toggle.html‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -669,7 +669,8 @@ <h3 id="material-button-toggle-type_aliases" class="docs-header-link docs-api-h3
669669
<h4 id="ToggleType" class="docs-header-link docs-api-h4 docs-api-type-alias-name">
670670
<span header-link="ToggleType"></span>
671671
<code>ToggleType</code>
672-
</h4><div class="docs-api-type-alias-deprecated-marker" title="Will be removed in v11.0.0 or later">
672+
</h4><div class="docs-api-type-alias-deprecated-marker" deprecated-message="No longer used. Will be removed in v11.0.0 or later."
673+
>
673674
Deprecated
674675
</div><div class="docs-markdown">
675676
<pre class="docs-markdown-pre">

‎docs-content/api-docs/material-checkbox.html‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -468,7 +468,8 @@ <h4 id="MatCheckboxRequiredValidator" class="docs-header-link docs-api-h4 docs-a
468468

469469
<span class="docs-api-class-selector-name">mat-checkbox[required][ngModel]</span>
470470

471-
</p><div class="docs-api-class-deprecated-marker" title="Will be removed in v19.0.0 or later">
471+
</p><div class="docs-api-class-deprecated-marker" deprecated-message="No longer used, `MatCheckbox` implements required validation directly. Will be removed in v19.0.0 or later."
472+
>
472473
Deprecated
473474
</div><h5 class="docs-api-h5 docs-api-method-header">Properties</h5>
474475
<table class="docs-api-properties-table">
@@ -767,7 +768,8 @@ <h3 id="material-checkbox-constants" class="docs-header-link docs-api-h3">
767768
<h4 id="MAT_CHECKBOX_CONTROL_VALUE_ACCESSOR" class="docs-header-link docs-api-h4 docs-api-constant-name">
768769
<span header-link="MAT_CHECKBOX_CONTROL_VALUE_ACCESSOR"></span>
769770
<code>MAT_CHECKBOX_CONTROL_VALUE_ACCESSOR</code>
770-
</h4><div class="docs-api-constant-deprecated-marker" title="Will be removed in v19.0.0 or later">
771+
</h4><div class="docs-api-constant-deprecated-marker" deprecated-message="Will stop being exported. Will be removed in v19.0.0 or later."
772+
>
771773
Deprecated
772774
</div><div class="docs-markdown">
773775
<pre class="docs-markdown-pre">
@@ -796,7 +798,8 @@ <h4 id="MAT_CHECKBOX_DEFAULT_OPTIONS" class="docs-header-link docs-api-h4 docs-a
796798
<h4 id="MAT_CHECKBOX_REQUIRED_VALIDATOR" class="docs-header-link docs-api-h4 docs-api-constant-name">
797799
<span header-link="MAT_CHECKBOX_REQUIRED_VALIDATOR"></span>
798800
<code>MAT_CHECKBOX_REQUIRED_VALIDATOR</code>
799-
</h4><div class="docs-api-constant-deprecated-marker" title="Will be removed in v19.0.0 or later">
801+
</h4><div class="docs-api-constant-deprecated-marker" deprecated-message="No longer used, `MatCheckbox` implements required validation directly. Will be removed in v19.0.0 or later."
802+
>
800803
Deprecated
801804
</div><div class="docs-markdown">
802805
<pre class="docs-markdown-pre">

‎docs-content/api-docs/material-chips.html‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2682,7 +2682,8 @@ <h4 id="MatChipInputEvent" class="docs-header-link docs-api-h4 docs-api-interfac
26822682

26832683

26842684
<tr class="docs-api-properties-row">
2685-
<td class="docs-api-properties-name-cell"><div class="docs-api-deprecated-marker" title="Will be removed in v13.0.0 This property will be removed. or later">
2685+
<td class="docs-api-properties-name-cell"><div class="docs-api-deprecated-marker" deprecated-message="Use `MatChipInputEvent#chipInput.inputElement` instead. Will be removed in v13.0.0 This property will be removed. or later."
2686+
>
26862687
Deprecated
26872688
</div><p class="docs-api-property-name">
26882689
<code>input: HTMLInputElement</code>

0 commit comments

Comments
 (0)