Skip to content

docs(ripple): fix missing jsdoc descriptions #12305

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 23, 2018
Merged

docs(ripple): fix missing jsdoc descriptions #12305

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion src/lib/core/ripple/ripple-ref.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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) {
}

Expand Down
10 changes: 8 additions & 2 deletions src/lib/core/ripple/ripple.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand All @@ -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;
}
Expand Down