diff options
author | Fabio Berger <me@fabioberger.com> | 2018-03-19 01:44:52 +0800 |
---|---|---|
committer | Fabio Berger <me@fabioberger.com> | 2018-03-19 01:44:52 +0800 |
commit | 794b155827868d67f1cec45bbe8c3a3e4be02597 (patch) | |
tree | 8f46fb1fe23f0317b50f9d37e6fa8c671615c981 /packages/react-docs/src/types.ts | |
parent | 4941ffd354a7bbc4fb48cd66acd6db1e36d5ed87 (diff) | |
download | dexon-sol-tools-794b155827868d67f1cec45bbe8c3a3e4be02597.tar dexon-sol-tools-794b155827868d67f1cec45bbe8c3a3e4be02597.tar.gz dexon-sol-tools-794b155827868d67f1cec45bbe8c3a3e4be02597.tar.bz2 dexon-sol-tools-794b155827868d67f1cec45bbe8c3a3e4be02597.tar.lz dexon-sol-tools-794b155827868d67f1cec45bbe8c3a3e4be02597.tar.xz dexon-sol-tools-794b155827868d67f1cec45bbe8c3a3e4be02597.tar.zst dexon-sol-tools-794b155827868d67f1cec45bbe8c3a3e4be02597.zip |
Add support for displaying exported functions
Diffstat (limited to 'packages/react-docs/src/types.ts')
-rw-r--r-- | packages/react-docs/src/types.ts | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/packages/react-docs/src/types.ts b/packages/react-docs/src/types.ts index d192af313..2a300c164 100644 --- a/packages/react-docs/src/types.ts +++ b/packages/react-docs/src/types.ts @@ -42,6 +42,7 @@ export interface TypeDocFlags { isStatic?: boolean; isOptional?: boolean; isPublic?: boolean; + isExported?: boolean; } export interface TypeDocGroup { @@ -96,6 +97,7 @@ export enum KindString { Variable = 'Variable', Function = 'Function', Enumeration = 'Enumeration', + Class = 'Class', } export interface DocAgnosticFormat { @@ -108,6 +110,7 @@ export interface DocSection { methods: Array<TypescriptMethod | SolidityMethod>; properties: Property[]; types: CustomType[]; + functions?: TypescriptFunction[]; events?: Event[]; } @@ -117,6 +120,11 @@ export interface TypescriptMethod extends BaseMethod { typeParameter?: TypeParameter; } +export interface TypescriptFunction extends BaseFunction { + source?: Source; + typeParameter?: TypeParameter; +} + export interface SolidityMethod extends BaseMethod { isConstant?: boolean; isPayable?: boolean; @@ -205,6 +213,14 @@ export interface BaseMethod { comment?: string; } +export interface BaseFunction { + name: string; + returnComment?: string | undefined; + parameters: Parameter[]; + returnType: Type; + comment?: string; +} + export interface TypeDefinitionByName { [typeName: string]: CustomType; } |