Add orderWatcher to 0x.js docs

This commit is contained in:
Fabio Berger
2017-11-29 18:57:21 -06:00
parent 3d73167f53
commit c57190dead
3 changed files with 14 additions and 1 deletions

View File

@@ -35,6 +35,7 @@ const zeroExJsDocSections = {
tokenRegistry: 'tokenRegistry', tokenRegistry: 'tokenRegistry',
etherToken: 'etherToken', etherToken: 'etherToken',
proxy: 'proxy', proxy: 'proxy',
orderWatcher: 'orderWatcher',
types: 'types', types: 'types',
}; };
@@ -66,6 +67,9 @@ const docsInfoConfig: DocsInfoConfig = {
zeroExJsDocSections.etherToken, zeroExJsDocSections.etherToken,
zeroExJsDocSections.proxy, zeroExJsDocSections.proxy,
], ],
orderWatcher: [
zeroExJsDocSections.orderWatcher,
],
types: [ types: [
zeroExJsDocSections.types, zeroExJsDocSections.types,
], ],
@@ -122,6 +126,12 @@ const docsInfoConfig: DocsInfoConfig = {
'LogEvent', 'LogEvent',
'LogEntry', 'LogEntry',
'DecodedLogEvent', 'DecodedLogEvent',
'EventWatcherCallback',
'OnOrderStateChangeCallback',
'OrderStateValid',
'OrderStateInvalid',
'OrderState',
'FilterObject',
], ],
sectionNameToModulePath: { sectionNameToModulePath: {
[zeroExJsDocSections.zeroEx]: ['"src/0x"'], [zeroExJsDocSections.zeroEx]: ['"src/0x"'],
@@ -133,11 +143,13 @@ const docsInfoConfig: DocsInfoConfig = {
'"src/contract_wrappers/proxy_wrapper"', '"src/contract_wrappers/proxy_wrapper"',
'"src/contract_wrappers/token_transfer_proxy_wrapper"', '"src/contract_wrappers/token_transfer_proxy_wrapper"',
], ],
[zeroExJsDocSections.orderWatcher]: ['"src/order_watcher/order_state_watcher"'],
[zeroExJsDocSections.types]: ['"src/types"'], [zeroExJsDocSections.types]: ['"src/types"'],
}, },
menuSubsectionToVersionWhenIntroduced: { menuSubsectionToVersionWhenIntroduced: {
[zeroExJsDocSections.etherToken]: '0.7.1', [zeroExJsDocSections.etherToken]: '0.7.1',
[zeroExJsDocSections.proxy]: '0.8.0', [zeroExJsDocSections.proxy]: '0.8.0',
[zeroExJsDocSections.orderWatcher]: '0.27.1',
}, },
sections: zeroExJsDocSections, sections: zeroExJsDocSections,
visibleConstructors: [zeroExJsDocSections.zeroEx], visibleConstructors: [zeroExJsDocSections.zeroEx],

View File

@@ -35,6 +35,7 @@ const typeToSection: {[typeName: string]: string} = {
EtherTokenWrapper: 'etherToken', EtherTokenWrapper: 'etherToken',
ProxyWrapper: 'proxy', ProxyWrapper: 'proxy',
TokenTransferProxyWrapper: 'proxy', TokenTransferProxyWrapper: 'proxy',
OrderStateWatcher: 'orderWatcher',
}; };
interface TypeProps { interface TypeProps {

View File

@@ -220,7 +220,7 @@ export const typeDocUtils = {
let callPath = (!_.isUndefined(sections.zeroEx) && sectionName !== sections.zeroEx) ? let callPath = (!_.isUndefined(sections.zeroEx) && sectionName !== sections.zeroEx) ?
`${topLevelInterface}${sectionName}.` : `${topLevelInterface}${sectionName}.` :
topLevelInterface; topLevelInterface;
callPath = isConstructor ? '' : callPath; callPath = isConstructor || entity.name === '__type' ? '' : callPath;
const parameters = _.map(signature.parameters, param => { const parameters = _.map(signature.parameters, param => {
return typeDocUtils._convertParameter(param, sections, sectionName); return typeDocUtils._convertParameter(param, sections, sectionName);