Skip to content

Commit caaeddf

Browse files
committed
fix review comments
1 parent eec6365 commit caaeddf

File tree

5 files changed

+8
-11
lines changed

5 files changed

+8
-11
lines changed

src/dialog/dialog-placeholder.component.ts

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ import {
77
import { PlaceholderService } from "./../placeholder/placeholder.module";
88

99
/**
10+
* Deprecated as of v2.0, will be removed with v3.0
1011
* Using a dialog (popover, tooltip, etc) with appendToBody="true" in your application
1112
* requires *this* component (`n-dialog-placeholder`).
1213
* It would generally be placed near the end of your app component template
@@ -25,9 +26,7 @@ import { PlaceholderService } from "./../placeholder/placeholder.module";
2526
* <ibm-dialog-placeholder></ibm-dialog-placeholder>
2627
* ```
2728
*
28-
* @export
29-
* @class DialogPlaceholderComponent
30-
* @implements {OnInit}
29+
* @deprecated
3130
*/
3231
@Component({
3332
selector: "ibm-dialog-placeholder",

src/modal/base-modal.class.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
import { Output, EventEmitter } from "@angular/core";
22

33
/**
4-
* Extend BaseModal in your custom modal implementations to ensure consistent close behaviour.
4+
* Extend `BaseModal` in your custom modal implementations to ensure consistent close behaviour.
55
*
6-
* ModalService depends on the `close` event to correctly clean up the component.
6+
* `ModalService` depends on the `close` event to correctly clean up the component.
77
*/
88
export class BaseModal {
99
@Output() close = new EventEmitter();

src/modal/modal-placeholder.component.ts

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ import { PlaceholderService } from "./../placeholder/placeholder.service";
88

99

1010
/**
11+
* Deprecated with v2.0, will be removed in v3.0
1112
* Using a modal in your application requires *this* component (`n-modal-placeholder`).
1213
* It would generally be placed near the end of your app component template
1314
* (app.component.ts or app.component.html) as:
@@ -32,9 +33,7 @@ import { PlaceholderService } from "./../placeholder/placeholder.service";
3233
* <ibm-modal-placeholder></ibm-modal-placeholder>
3334
* ```
3435
*
35-
* @export
36-
* @class ModalPlaceholderComponent
37-
* @implements {OnInit}
36+
* @deprecated
3837
*/
3938
@Component({
4039
selector: "ibm-modal-placeholder",

src/modal/modal.decorator.ts

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,13 @@
11
import { Output, EventEmitter } from "@angular/core";
22

33
/**
4-
* # Deprecated - extend BaseModal instead
4+
* # Deprecated - extend `BaseModal` instead
55
*
66
* Decorator used to apply metadata on `Modal` class.
77
*
88
* class: ModalContainer
99
*
1010
* decorator: @Modal
11-
* @class ModalContainer
1211
* @deprecated
1312
*/
1413
class ModalContainer {

src/placeholder/placeholder.component.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ import { PlaceholderService } from "./placeholder.service";
1212
* It would generally be placed near the end of your root app component template
1313
* (app.component.ts or app.component.html) as:
1414
*
15-
* ...
15+
* ```
1616
* <ibm-placeholder></ibm-placeholder>
1717
* ```
1818
*

0 commit comments

Comments
 (0)