Address feedback

angular · Nov 14, 2017 · a5ccacb · a5ccacb
1 parent 9a25d5b
commit a5ccacb
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 6 deletions.
diff --git a/src/lib/core/ripple/ripple.md b/src/lib/core/ripple/ripple.md
@@ -85,9 +85,4 @@ const globalRippleConfig: RippleGlobalOptions = {
 })
 ```
 
-All currently available global options are shown here:
-
-| Name            | Type    | Description                               |
-| --------------- | ------- | ----------------------------------------- |
-| disabled        | boolean | Whether ripples should show or not.       |
-| baseSpeedFactor | number  | Factor to adjust ripple speed.            |
+All available global options can be seen in the `RippleGlobalOptions` interface.
diff --git a/tools/dgeni/common/dgeni-definitions.ts b/tools/dgeni/common/dgeni-definitions.ts
@@ -3,12 +3,14 @@ import {ClassLikeExportDoc} from 'dgeni-packages/typescript/api-doc-types/ClassL
 import {PropertyMemberDoc} from 'dgeni-packages/typescript/api-doc-types/PropertyMemberDoc';
 import {NormalizedMethodMemberDoc} from './normalize-method-parameters';
 
+/** Extended Dgeni class-like document that includes separated class members. */
 export interface CategorizedClassLikeDoc extends ClassLikeExportDoc {
   methods: CategorizedMethodMemberDoc[];
   properties: CategorizedPropertyMemberDoc[];
   isDeprecated: boolean;
 }
 
+/** Extended Dgeni class document that includes extracted Angular metadata. */
 export interface CategorizedClassDoc extends ClassExportDoc, CategorizedClassLikeDoc {
   isDirective: boolean;
   isService: boolean;
@@ -18,6 +20,7 @@ export interface CategorizedClassDoc extends ClassExportDoc, CategorizedClassLik
   extendedDoc: ClassLikeExportDoc | null;
 }
 
+/** Extended Dgeni property-member document that includes extracted Angular metadata. */
 export interface CategorizedPropertyMemberDoc extends PropertyMemberDoc {
   description: string;
   isDeprecated: boolean;
@@ -27,6 +30,7 @@ export interface CategorizedPropertyMemberDoc extends PropertyMemberDoc {
   directiveOutputAlias: string;
 }
 
+/** Extended Dgeni method-member document that simplifies logic for the Dgeni template. */
 export interface CategorizedMethodMemberDoc extends NormalizedMethodMemberDoc {
   showReturns: boolean;
   isDeprecated: boolean;