Skip to content

Commit 82915c7

Browse files
devversionjosephperrott
authored andcommitted
docs(ripple): fix missing jsdoc descriptions (#12305)
1 parent 3b50e44 commit 82915c7

File tree

2 files changed

+11
-3
lines changed

2 files changed

+11
-3
lines changed

src/lib/core/ripple/ripple-ref.ts

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,14 @@ export enum RippleState {
1818
*/
1919
export class RippleRef {
2020

21-
/** Current state of the ripple reference. */
21+
/** Current state of the ripple. */
2222
state: RippleState = RippleState.HIDDEN;
2323

2424
constructor(
2525
private _renderer: RippleRenderer,
26+
/** Reference to the ripple HTML element. */
2627
public element: HTMLElement,
28+
/** Ripple configuration used for the ripple. */
2729
public config: RippleConfig) {
2830
}
2931

src/lib/core/ripple/ripple.ts

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,10 @@ export class MatRipple implements OnInit, OnDestroy, RippleTarget {
163163
this._rippleRenderer.fadeOutAll();
164164
}
165165

166-
/** Ripple configuration from the directive's input values. */
166+
/**
167+
* Ripple configuration from the directive's input values.
168+
* @docs-private Implemented as part of RippleTarget
169+
*/
167170
get rippleConfig(): RippleConfig {
168171
return {
169172
centered: this.centered,
@@ -175,7 +178,10 @@ export class MatRipple implements OnInit, OnDestroy, RippleTarget {
175178
};
176179
}
177180

178-
/** Whether ripples on pointer-down are disabled or not. */
181+
/**
182+
* Whether ripples on pointer-down are disabled or not.
183+
* @docs-private Implemented as part of RippleTarget
184+
*/
179185
get rippleDisabled(): boolean {
180186
return this.disabled || !!this._globalOptions.disabled;
181187
}

0 commit comments

Comments
 (0)