diff options
author | F. Eugene Aumson <gene@aumson.org> | 2018-09-22 23:06:48 +0800 |
---|---|---|
committer | F. Eugene Aumson <gene@aumson.org> | 2018-09-22 23:29:27 +0800 |
commit | 98d06d6d252ed379d60bcef915caf38a5ec7a5af (patch) | |
tree | b68eac94243885495d06e67e70ad8b12a635a517 /packages/react-docs/src/types.ts | |
parent | 9f0dfb1e1a4c97e462cf298e0452be1d0fcf2216 (diff) | |
download | dexon-sol-tools-98d06d6d252ed379d60bcef915caf38a5ec7a5af.tar dexon-sol-tools-98d06d6d252ed379d60bcef915caf38a5ec7a5af.tar.gz dexon-sol-tools-98d06d6d252ed379d60bcef915caf38a5ec7a5af.tar.bz2 dexon-sol-tools-98d06d6d252ed379d60bcef915caf38a5ec7a5af.tar.lz dexon-sol-tools-98d06d6d252ed379d60bcef915caf38a5ec7a5af.tar.xz dexon-sol-tools-98d06d6d252ed379d60bcef915caf38a5ec7a5af.tar.zst dexon-sol-tools-98d06d6d252ed379d60bcef915caf38a5ec7a5af.zip |
BREAKING CHANGE: document contracts from sol-doc
Change website to accept smart contract documentation in the format
generated by sol-doc rather than that generated by Doxity.
Diffstat (limited to 'packages/react-docs/src/types.ts')
-rw-r--r-- | packages/react-docs/src/types.ts | 36 |
1 files changed, 1 insertions, 35 deletions
diff --git a/packages/react-docs/src/types.ts b/packages/react-docs/src/types.ts index 454190342..f475c2756 100644 --- a/packages/react-docs/src/types.ts +++ b/packages/react-docs/src/types.ts @@ -38,7 +38,7 @@ export enum KindString { } export enum SupportedDocJson { - Doxity = 'DOXITY', + Solidity = 'SOLIDITY', TypeDoc = 'TYPEDOC', } @@ -50,40 +50,6 @@ export interface ContractsByVersionByNetworkId { }; } -export interface DoxityDocObj { - [contractName: string]: DoxityContractObj; -} - -export interface DoxityContractObj { - title: string; - fileName: string; - name: string; - abiDocs: DoxityAbiDoc[]; -} - -export interface DoxityAbiDoc { - constant: boolean; - inputs: DoxityInput[]; - name: string; - outputs: DoxityOutput[]; - payable: boolean; - type: string; - details?: string; - return?: string; -} - -export interface DoxityOutput { - name: string; - type: string; -} - -export interface DoxityInput { - name: string; - type: string; - description: string; - indexed?: boolean; -} - export interface AddressByContractName { [contractName: string]: string; } |