diff options
author | Fabio Berger <me@fabioberger.com> | 2017-12-06 06:18:36 +0800 |
---|---|---|
committer | Fabio Berger <me@fabioberger.com> | 2017-12-06 06:18:36 +0800 |
commit | 08168c6e7d52711aeb46e27444ba26970e16e244 (patch) | |
tree | 40a006de279221009d0ee05d73bfbb74f0a9ea91 /packages/website | |
parent | b5030df4e3afe17b4e652b438d655edda79c5f54 (diff) | |
parent | 4441d76725af4e83f90eeb373983b600b6903e8e (diff) | |
download | dexon-0x-contracts-08168c6e7d52711aeb46e27444ba26970e16e244.tar dexon-0x-contracts-08168c6e7d52711aeb46e27444ba26970e16e244.tar.gz dexon-0x-contracts-08168c6e7d52711aeb46e27444ba26970e16e244.tar.bz2 dexon-0x-contracts-08168c6e7d52711aeb46e27444ba26970e16e244.tar.lz dexon-0x-contracts-08168c6e7d52711aeb46e27444ba26970e16e244.tar.xz dexon-0x-contracts-08168c6e7d52711aeb46e27444ba26970e16e244.tar.zst dexon-0x-contracts-08168c6e7d52711aeb46e27444ba26970e16e244.zip |
Merge branch 'development' into feature/addSubproviders
* development: (50 commits)
Add PR number to changelog
Address feedback
Add requestId to subscription messages and update json-schemas
Remove isomorphic-fetch types from contracts package
Update README
Regenerate files
Make it private
Change package name
Update README
Make fileExtension configurable
Rename abi-gen to typed-contracts
Add docs for typed-contracts
Remove TODOs
Introduce separate ContextData type and rework it
Check ABI is defined
Introduce a const for 'contract.mustache'
Improve error message
Reuse util
Fix a typo
Introduce a const for 'function'
...
# Conflicts:
# yarn.lock
Diffstat (limited to 'packages/website')
-rw-r--r-- | packages/website/ts/containers/zero_ex_js_documentation.tsx | 12 | ||||
-rw-r--r-- | packages/website/ts/pages/documentation/type.tsx | 1 | ||||
-rw-r--r-- | packages/website/ts/utils/typedoc_utils.ts | 2 |
3 files changed, 14 insertions, 1 deletions
diff --git a/packages/website/ts/containers/zero_ex_js_documentation.tsx b/packages/website/ts/containers/zero_ex_js_documentation.tsx index fc48297b5..58c0ee186 100644 --- a/packages/website/ts/containers/zero_ex_js_documentation.tsx +++ b/packages/website/ts/containers/zero_ex_js_documentation.tsx @@ -35,6 +35,7 @@ const zeroExJsDocSections = { tokenRegistry: 'tokenRegistry', etherToken: 'etherToken', proxy: 'proxy', + orderWatcher: 'orderWatcher', types: 'types', }; @@ -66,6 +67,9 @@ const docsInfoConfig: DocsInfoConfig = { zeroExJsDocSections.etherToken, zeroExJsDocSections.proxy, ], + orderWatcher: [ + zeroExJsDocSections.orderWatcher, + ], types: [ zeroExJsDocSections.types, ], @@ -122,6 +126,12 @@ const docsInfoConfig: DocsInfoConfig = { 'LogEvent', 'LogEntry', 'DecodedLogEvent', + 'EventWatcherCallback', + 'OnOrderStateChangeCallback', + 'OrderStateValid', + 'OrderStateInvalid', + 'OrderState', + 'FilterObject', ], sectionNameToModulePath: { [zeroExJsDocSections.zeroEx]: ['"src/0x"'], @@ -133,11 +143,13 @@ const docsInfoConfig: DocsInfoConfig = { '"src/contract_wrappers/proxy_wrapper"', '"src/contract_wrappers/token_transfer_proxy_wrapper"', ], + [zeroExJsDocSections.orderWatcher]: ['"src/order_watcher/order_state_watcher"'], [zeroExJsDocSections.types]: ['"src/types"'], }, menuSubsectionToVersionWhenIntroduced: { [zeroExJsDocSections.etherToken]: '0.7.1', [zeroExJsDocSections.proxy]: '0.8.0', + [zeroExJsDocSections.orderWatcher]: '0.27.1', }, sections: zeroExJsDocSections, visibleConstructors: [zeroExJsDocSections.zeroEx], diff --git a/packages/website/ts/pages/documentation/type.tsx b/packages/website/ts/pages/documentation/type.tsx index acd46ab72..c564429d0 100644 --- a/packages/website/ts/pages/documentation/type.tsx +++ b/packages/website/ts/pages/documentation/type.tsx @@ -35,6 +35,7 @@ const typeToSection: {[typeName: string]: string} = { EtherTokenWrapper: 'etherToken', ProxyWrapper: 'proxy', TokenTransferProxyWrapper: 'proxy', + OrderStateWatcher: 'orderWatcher', }; interface TypeProps { diff --git a/packages/website/ts/utils/typedoc_utils.ts b/packages/website/ts/utils/typedoc_utils.ts index 7708efb35..803cfa0cf 100644 --- a/packages/website/ts/utils/typedoc_utils.ts +++ b/packages/website/ts/utils/typedoc_utils.ts @@ -220,7 +220,7 @@ export const typeDocUtils = { let callPath = (!_.isUndefined(sections.zeroEx) && sectionName !== sections.zeroEx) ? `${topLevelInterface}${sectionName}.` : topLevelInterface; - callPath = isConstructor ? '' : callPath; + callPath = isConstructor || entity.name === '__type' ? '' : callPath; const parameters = _.map(signature.parameters, param => { return typeDocUtils._convertParameter(param, sections, sectionName); |