From c57190dead41846809effb8823bd4e486ca72512 Mon Sep 17 00:00:00 2001 From: Fabio Berger Date: Wed, 29 Nov 2017 18:57:21 -0600 Subject: Add orderWatcher to 0x.js docs --- packages/website/ts/containers/zero_ex_js_documentation.tsx | 12 ++++++++++++ packages/website/ts/pages/documentation/type.tsx | 1 + packages/website/ts/utils/typedoc_utils.ts | 2 +- 3 files changed, 14 insertions(+), 1 deletion(-) (limited to 'packages/website/ts') 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); -- cgit