aboutsummaryrefslogtreecommitdiffstats
path: root/packages/monorepo-scripts/src/doc_gen_configs.ts
diff options
context:
space:
mode:
authorBrandon Millman <brandon@0xproject.com>2018-10-18 01:57:57 +0800
committerGitHub <noreply@github.com>2018-10-18 01:57:57 +0800
commitb2012bf1610eda65afe180b04df6c9ee8f5dc659 (patch)
tree1beb80ae49db8a19bdcd2039fb471d1c60b8656a /packages/monorepo-scripts/src/doc_gen_configs.ts
parentc767404ad09ca9fdacf9ab43c0e6b13fc70bffb9 (diff)
parent81505ba56cc8a5b0a2991b07e8320a442ee74f27 (diff)
downloaddexon-0x-contracts-b2012bf1610eda65afe180b04df6c9ee8f5dc659.tar
dexon-0x-contracts-b2012bf1610eda65afe180b04df6c9ee8f5dc659.tar.gz
dexon-0x-contracts-b2012bf1610eda65afe180b04df6c9ee8f5dc659.tar.bz2
dexon-0x-contracts-b2012bf1610eda65afe180b04df6c9ee8f5dc659.tar.lz
dexon-0x-contracts-b2012bf1610eda65afe180b04df6c9ee8f5dc659.tar.xz
dexon-0x-contracts-b2012bf1610eda65afe180b04df6c9ee8f5dc659.tar.zst
dexon-0x-contracts-b2012bf1610eda65afe180b04df6c9ee8f5dc659.zip
Merge pull request #1139 from 0xProject/feature/website/asset-buyer-docs
[asset-buyer][monorepo-scripts][website] Add asset-buyer documentation
Diffstat (limited to 'packages/monorepo-scripts/src/doc_gen_configs.ts')
-rw-r--r--packages/monorepo-scripts/src/doc_gen_configs.ts9
1 files changed, 8 insertions, 1 deletions
diff --git a/packages/monorepo-scripts/src/doc_gen_configs.ts b/packages/monorepo-scripts/src/doc_gen_configs.ts
index e3ddeddc9..b5a36376a 100644
--- a/packages/monorepo-scripts/src/doc_gen_configs.ts
+++ b/packages/monorepo-scripts/src/doc_gen_configs.ts
@@ -30,6 +30,7 @@ export const docGenConfigs: DocGenConfigs = {
// factory method which instantiates an instance of a class, but we don't want users instantiating it themselves
// and getting confused. Any class name in this list will not have it's constructor rendered in our docs.
CLASSES_WITH_HIDDEN_CONSTRUCTORS: [
+ 'AssetBuyer',
'ERC20ProxyWrapper',
'ERC20TokenWrapper',
'ERC721ProxyWrapper',
@@ -43,7 +44,13 @@ export const docGenConfigs: DocGenConfigs = {
// Some types are not explicitly part of the public interface like params, return values, etc... But we still
// want them exported. E.g error enum types that can be thrown by methods. These must be manually added to this
// config
- IGNORED_EXCESSIVE_TYPES: ['NonceSubproviderErrors', 'Web3WrapperErrors', 'ContractWrappersError', 'OrderError'],
+ IGNORED_EXCESSIVE_TYPES: [
+ 'NonceSubproviderErrors',
+ 'Web3WrapperErrors',
+ 'ContractWrappersError',
+ 'OrderError',
+ 'AssetBuyerError',
+ ],
// Some libraries only export types. In those cases, we cannot check if the exported types are part of the
// "exported public interface". Thus we add them here and skip those checks.
TYPES_ONLY_LIBRARIES: ['ethereum-types', 'types'],