docs(ripple): fix missing jsdoc descriptions (#12305)

This commit is contained in:
Paul Gschwendtner
2018-07-23 16:13:46 +02:00
committed by Joey Perrott
parent 3b50e44bf2
commit 82915c75d4
2 changed files with 11 additions and 3 deletions
+3 -1
View File
@@ -18,12 +18,14 @@ export enum RippleState {
*/
export class RippleRef {
/** Current state of the ripple reference. */
/** Current state of the ripple. */
state: RippleState = RippleState.HIDDEN;
constructor(
private _renderer: RippleRenderer,
/** Reference to the ripple HTML element. */
public element: HTMLElement,
/** Ripple configuration used for the ripple. */
public config: RippleConfig) {
}
+8 -2
View File
@@ -163,7 +163,10 @@ export class MatRipple implements OnInit, OnDestroy, RippleTarget {
this._rippleRenderer.fadeOutAll();
}
/** Ripple configuration from the directive's input values. */
/**
* Ripple configuration from the directive's input values.
* @docs-private Implemented as part of RippleTarget
*/
get rippleConfig(): RippleConfig {
return {
centered: this.centered,
@@ -175,7 +178,10 @@ export class MatRipple implements OnInit, OnDestroy, RippleTarget {
};
}
/** Whether ripples on pointer-down are disabled or not. */
/**
* Whether ripples on pointer-down are disabled or not.
* @docs-private Implemented as part of RippleTarget
*/
get rippleDisabled(): boolean {
return this.disabled || !!this._globalOptions.disabled;
}