Skip to content

Commit a05e8f1

Browse files
committed
docs(material/dialog): add missing descriptions
Adds descriptions for public properties showing up in the API docs. DEPRECATED: `MatDialogClose#dialogRef` class member to become private.
1 parent ade0901 commit a05e8f1

File tree

2 files changed

+7
-0
lines changed

2 files changed

+7
-0
lines changed

src/material/dialog/dialog-content-directives.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,11 @@ export class MatDialogClose implements OnInit, OnChanges {
4848
constructor(
4949
// The dialog title directive is always used in combination with a `MatDialogRef`.
5050
// tslint:disable-next-line: lightweight-tokens
51+
/**
52+
* Reference to the containing dialog.
53+
* @deprecated `dialogRef` property to become private.
54+
* @breaking-change 13.0.0
55+
*/
5156
@Optional() public dialogRef: MatDialogRef<any>,
5257
private _elementRef: ElementRef<HTMLElement>,
5358
private _dialog: MatDialog) {}
@@ -93,6 +98,7 @@ export class MatDialogClose implements OnInit, OnChanges {
9398
},
9499
})
95100
export class MatDialogTitle implements OnInit {
101+
/** Unique id for the dialog title. If none is supplied, it will be auto-generated. */
96102
@Input() id: string = `mat-dialog-title-${dialogElementUid++}`;
97103

98104
constructor(

src/material/dialog/dialog-ref.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,7 @@ export class MatDialogRef<T, R = any> {
5454
constructor(
5555
private _overlayRef: OverlayRef,
5656
public _containerInstance: _MatDialogContainerBase,
57+
/** Id of the dialog. */
5758
readonly id: string = `mat-dialog-${uniqueId++}`) {
5859

5960
// Pass the id along to the container.

0 commit comments

Comments
 (0)