Add doc generation to several more packages and fix up their index.ts files so all public interface types are exported

This commit is contained in:
fabioberger
2019-11-16 08:09:56 +00:00
parent d0a3495b5f
commit e1ea65525f
45 changed files with 701 additions and 58 deletions

View File

@@ -33,7 +33,9 @@
"contracts:gen": "contracts-gen generate",
"contracts:copy": "contracts-gen copy",
"lint-contracts": "solhint -c ../.solhint.json contracts/**/**/**/**/*.sol",
"compile:truffle": "truffle compile"
"compile:truffle": "truffle compile",
"docs:md": "ts-doc-gen --sourceDir='$PROJECT_FILES' --output=$MD_FILE_DIR --fileExtension=mdx --tsconfig=./typedoc-tsconfig.json",
"docs:json": "typedoc --excludePrivate --excludeExternals --excludeProtected --ignoreCompilerErrors --target ES5 --tsconfig typedoc-tsconfig.json --json $JSON_FILE_PATH $PROJECT_FILES"
},
"config": {
"publicInterfaceContracts": "Exchange,IExchange",
@@ -62,6 +64,8 @@
"@0x/sol-compiler": "^3.2.0-beta.2",
"@0x/tslint-config": "^3.1.0-beta.2",
"@0x/web3-wrapper": "^6.1.0-beta.2",
"@0x/ts-doc-gen": "^0.0.22",
"typedoc": "^0.15.0",
"@types/lodash": "4.14.104",
"@types/mocha": "^5.2.7",
"@types/node": "*",

View File

@@ -1,4 +1,67 @@
export * from './artifacts';
export * from './wrappers';
export { artifacts } from './artifacts';
export {
IExchangeContract,
IExchangeEvents,
IExchangeFillEventArgs,
ExchangeEventArgs,
ExchangeEvents,
ExchangeSignatureValidatorApprovalEventArgs,
ExchangeFillEventArgs,
ExchangeCancelEventArgs,
ExchangeCancelUpToEventArgs,
ExchangeAssetProxyRegisteredEventArgs,
ExchangeContract,
ExchangeProtocolFeeCollectorAddressEventArgs,
ExchangeProtocolFeeMultiplierEventArgs,
ExchangeTransactionExecutionEventArgs,
} from './wrappers';
export import ExchangeRevertErrors = require('./revert_errors');
export { exchangeDataEncoder } from './exchange_data_encoder';
export {
TokenOwnersByName,
TokenContractsByName,
TokenIds,
ERC1155TokenIds,
ERC721TokenIds,
TokenData,
Named,
} from './balance_stores/types';
export { SignedOrder } from '@0x/types';
export {
Numberish,
TokenBalances,
ExchangeFunctionName,
ERC1155Holdings,
ERC20BalancesByOwner,
ERC721TokenIdsByOwner,
EthBalancesByOwner,
} from '@0x/contracts-test-utils';
export { DevUtilsContract } from '@0x/contracts-dev-utils';
export {
ContractArtifact,
ContractChains,
CompilerOpts,
StandardContractOutput,
CompilerSettings,
ContractChainData,
ContractAbi,
DevdocOutput,
EvmOutput,
CompilerSettingsMetadata,
OptimizerSettings,
OutputField,
ParamDescription,
EvmBytecodeOutput,
AbiDefinition,
FunctionAbi,
EventAbi,
RevertErrorAbi,
EventParameter,
DataItem,
MethodAbi,
ConstructorAbi,
FallbackAbi,
ConstructorStateMutability,
TupleDataItem,
StateMutability,
} from 'ethereum-types';

View File

@@ -0,0 +1,7 @@
{
"extends": "../../typedoc-tsconfig",
"compilerOptions": {
"outDir": "lib"
},
"include": ["./src/**/*", "./test/**/*"]
}