Skip to content

Commit a5ccacb

Browse files
committed
Address feedback
1 parent 9a25d5b commit a5ccacb

File tree

2 files changed

+5
-6
lines changed

2 files changed

+5
-6
lines changed

src/lib/core/ripple/ripple.md

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -85,9 +85,4 @@ const globalRippleConfig: RippleGlobalOptions = {
8585
})
8686
```
8787

88-
All currently available global options are shown here:
89-
90-
| Name | Type | Description |
91-
| --------------- | ------- | ----------------------------------------- |
92-
| disabled | boolean | Whether ripples should show or not. |
93-
| baseSpeedFactor | number | Factor to adjust ripple speed. |
88+
All available global options can be seen in the `RippleGlobalOptions` interface.

tools/dgeni/common/dgeni-definitions.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,14 @@ import {ClassLikeExportDoc} from 'dgeni-packages/typescript/api-doc-types/ClassL
33
import {PropertyMemberDoc} from 'dgeni-packages/typescript/api-doc-types/PropertyMemberDoc';
44
import {NormalizedMethodMemberDoc} from './normalize-method-parameters';
55

6+
/** Extended Dgeni class-like document that includes separated class members. */
67
export interface CategorizedClassLikeDoc extends ClassLikeExportDoc {
78
methods: CategorizedMethodMemberDoc[];
89
properties: CategorizedPropertyMemberDoc[];
910
isDeprecated: boolean;
1011
}
1112

13+
/** Extended Dgeni class document that includes extracted Angular metadata. */
1214
export interface CategorizedClassDoc extends ClassExportDoc, CategorizedClassLikeDoc {
1315
isDirective: boolean;
1416
isService: boolean;
@@ -18,6 +20,7 @@ export interface CategorizedClassDoc extends ClassExportDoc, CategorizedClassLik
1820
extendedDoc: ClassLikeExportDoc | null;
1921
}
2022

23+
/** Extended Dgeni property-member document that includes extracted Angular metadata. */
2124
export interface CategorizedPropertyMemberDoc extends PropertyMemberDoc {
2225
description: string;
2326
isDeprecated: boolean;
@@ -27,6 +30,7 @@ export interface CategorizedPropertyMemberDoc extends PropertyMemberDoc {
2730
directiveOutputAlias: string;
2831
}
2932

33+
/** Extended Dgeni method-member document that simplifies logic for the Dgeni template. */
3034
export interface CategorizedMethodMemberDoc extends NormalizedMethodMemberDoc {
3135
showReturns: boolean;
3236
isDeprecated: boolean;

0 commit comments

Comments
 (0)