aboutsummaryrefslogtreecommitdiffstats
path: root/packages
diff options
context:
space:
mode:
authorFabio Berger <me@fabioberger.com>2018-08-15 07:34:48 +0800
committerFabio Berger <me@fabioberger.com>2018-08-15 07:34:48 +0800
commit19e17ba12859a9cc94ce480fc6b29e28c711321e (patch)
treeab9fdc2cfb3bd3050e6a9c3d426b26632d1bf148 /packages
parent04e00e0c2849951b352692a8d8327160dc7475f8 (diff)
downloaddexon-0x-contracts-19e17ba12859a9cc94ce480fc6b29e28c711321e.tar
dexon-0x-contracts-19e17ba12859a9cc94ce480fc6b29e28c711321e.tar.gz
dexon-0x-contracts-19e17ba12859a9cc94ce480fc6b29e28c711321e.tar.bz2
dexon-0x-contracts-19e17ba12859a9cc94ce480fc6b29e28c711321e.tar.lz
dexon-0x-contracts-19e17ba12859a9cc94ce480fc6b29e28c711321e.tar.xz
dexon-0x-contracts-19e17ba12859a9cc94ce480fc6b29e28c711321e.tar.zst
dexon-0x-contracts-19e17ba12859a9cc94ce480fc6b29e28c711321e.zip
Add ability to hide specific class constructors
Diffstat (limited to 'packages')
-rw-r--r--packages/monorepo-scripts/src/utils/doc_generate_and_upload_utils.ts21
1 files changed, 21 insertions, 0 deletions
diff --git a/packages/monorepo-scripts/src/utils/doc_generate_and_upload_utils.ts b/packages/monorepo-scripts/src/utils/doc_generate_and_upload_utils.ts
index dfaaf1c07..187358421 100644
--- a/packages/monorepo-scripts/src/utils/doc_generate_and_upload_utils.ts
+++ b/packages/monorepo-scripts/src/utils/doc_generate_and_upload_utils.ts
@@ -28,6 +28,16 @@ const EXTERNAL_TYPE_TO_LINK: { [externalType: string]: string } = {
'solc.CompilerSettings': 'https://solidity.readthedocs.io/en/v0.4.24/using-the-compiler.html#input-description',
};
+const CLASSES_WITH_HIDDEN_CONSTRUCTORS: string[] = [
+ 'ERC20ProxyWrapper',
+ 'ERC20TokenWrapper',
+ 'ERC721ProxyWrapper',
+ 'ERC721TokenWrapper',
+ 'EtherTokenWrapper',
+ 'ExchangeWrapper',
+ 'ForwarderWrapper',
+];
+
export async function generateAndUploadDocsAsync(packageName: string, isStaging: boolean): Promise<void> {
const monorepoPackages = utils.getPackages(constants.monorepoRootPath);
const pkg = _.find(monorepoPackages, monorepoPackage => {
@@ -146,6 +156,17 @@ export async function generateAndUploadDocsAsync(packageName: string, isStaging:
if (!_.includes(exportItems, child.name)) {
delete finalTypeDocOutput.children[i].children[j];
}
+ if (child.kindString === 'Class' && _.includes(CLASSES_WITH_HIDDEN_CONSTRUCTORS, child.name)) {
+ const classChildren = typedocOutput.children[i].children[j].children;
+ _.each(classChildren, (classChild, k) => {
+ if (classChild.kindString === 'Constructor') {
+ delete finalTypeDocOutput.children[i].children[j].children[k];
+ finalTypeDocOutput.children[i].children[j].children = _.compact(
+ finalTypeDocOutput.children[i].children[j].children,
+ );
+ }
+ });
+ }
});
finalTypeDocOutput.children[i].children = _.compact(finalTypeDocOutput.children[i].children);
});