├── .c8rc ├── .codecov.yml ├── .github └── workflows │ └── test.yml ├── .gitignore ├── ARCHITECTURE.md ├── CHANGELOG.md ├── LICENSE ├── README.md ├── ava.config.js ├── hardhat.config.ts ├── package.json ├── renovate.json ├── src ├── common │ ├── helpers.ts │ └── properties.ts ├── config.ts ├── doc-item.ts ├── hardhat │ ├── index.ts │ └── type-extensions.ts ├── index.ts ├── main.ts ├── render.test.ts ├── render.ts ├── site.test.ts ├── site.ts ├── templates.ts ├── themes │ └── markdown │ │ ├── common.hbs │ │ ├── contract.hbs │ │ ├── enum.hbs │ │ ├── error.hbs │ │ ├── event.hbs │ │ ├── function.hbs │ │ ├── helpers.ts │ │ ├── modifier.hbs │ │ ├── page.hbs │ │ ├── struct.hbs │ │ ├── user-defined-value-type.hbs │ │ └── variable.hbs └── utils │ ├── ItemError.ts │ ├── arrays-equal.ts │ ├── assert-equal-types.ts │ ├── clone.ts │ ├── ensure-array.ts │ ├── execall.ts │ ├── fs-exists.ts │ ├── is-child.ts │ ├── item-type.ts │ ├── map-keys.ts │ ├── map-values.ts │ ├── memoized-getter.ts │ ├── natspec.ts │ ├── read-item-docs.ts │ ├── scope.ts │ └── test.ts ├── test-contracts ├── S08_AB.sol ├── S08_C.sol ├── S08_I.sol └── S08_K.sol └── tsconfig.json /.c8rc: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/OpenZeppelin/solidity-docgen/HEAD/.c8rc -------------------------------------------------------------------------------- /.codecov.yml: -------------------------------------------------------------------------------- 1 | comment: off 2 | -------------------------------------------------------------------------------- /.github/workflows/test.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/OpenZeppelin/solidity-docgen/HEAD/.github/workflows/test.yml -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/OpenZeppelin/solidity-docgen/HEAD/.gitignore -------------------------------------------------------------------------------- /ARCHITECTURE.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/OpenZeppelin/solidity-docgen/HEAD/ARCHITECTURE.md -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/OpenZeppelin/solidity-docgen/HEAD/CHANGELOG.md -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/OpenZeppelin/solidity-docgen/HEAD/LICENSE -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/OpenZeppelin/solidity-docgen/HEAD/README.md -------------------------------------------------------------------------------- /ava.config.js: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/OpenZeppelin/solidity-docgen/HEAD/ava.config.js -------------------------------------------------------------------------------- /hardhat.config.ts: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/OpenZeppelin/solidity-docgen/HEAD/hardhat.config.ts -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/OpenZeppelin/solidity-docgen/HEAD/package.json -------------------------------------------------------------------------------- /renovate.json: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/OpenZeppelin/solidity-docgen/HEAD/renovate.json -------------------------------------------------------------------------------- /src/common/helpers.ts: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/OpenZeppelin/solidity-docgen/HEAD/src/common/helpers.ts -------------------------------------------------------------------------------- /src/common/properties.ts: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/OpenZeppelin/solidity-docgen/HEAD/src/common/properties.ts -------------------------------------------------------------------------------- /src/config.ts: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/OpenZeppelin/solidity-docgen/HEAD/src/config.ts -------------------------------------------------------------------------------- /src/doc-item.ts: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/OpenZeppelin/solidity-docgen/HEAD/src/doc-item.ts -------------------------------------------------------------------------------- /src/hardhat/index.ts: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/OpenZeppelin/solidity-docgen/HEAD/src/hardhat/index.ts -------------------------------------------------------------------------------- /src/hardhat/type-extensions.ts: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/OpenZeppelin/solidity-docgen/HEAD/src/hardhat/type-extensions.ts -------------------------------------------------------------------------------- /src/index.ts: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/OpenZeppelin/solidity-docgen/HEAD/src/index.ts -------------------------------------------------------------------------------- /src/main.ts: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/OpenZeppelin/solidity-docgen/HEAD/src/main.ts -------------------------------------------------------------------------------- /src/render.test.ts: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/OpenZeppelin/solidity-docgen/HEAD/src/render.test.ts -------------------------------------------------------------------------------- /src/render.ts: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/OpenZeppelin/solidity-docgen/HEAD/src/render.ts -------------------------------------------------------------------------------- /src/site.test.ts: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/OpenZeppelin/solidity-docgen/HEAD/src/site.test.ts -------------------------------------------------------------------------------- /src/site.ts: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/OpenZeppelin/solidity-docgen/HEAD/src/site.ts -------------------------------------------------------------------------------- /src/templates.ts: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/OpenZeppelin/solidity-docgen/HEAD/src/templates.ts -------------------------------------------------------------------------------- /src/themes/markdown/common.hbs: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/OpenZeppelin/solidity-docgen/HEAD/src/themes/markdown/common.hbs -------------------------------------------------------------------------------- /src/themes/markdown/contract.hbs: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/OpenZeppelin/solidity-docgen/HEAD/src/themes/markdown/contract.hbs -------------------------------------------------------------------------------- /src/themes/markdown/enum.hbs: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/OpenZeppelin/solidity-docgen/HEAD/src/themes/markdown/enum.hbs -------------------------------------------------------------------------------- /src/themes/markdown/error.hbs: -------------------------------------------------------------------------------- 1 | {{>common}} 2 | -------------------------------------------------------------------------------- /src/themes/markdown/event.hbs: -------------------------------------------------------------------------------- 1 | {{>common}} 2 | -------------------------------------------------------------------------------- /src/themes/markdown/function.hbs: -------------------------------------------------------------------------------- 1 | {{>common}} 2 | -------------------------------------------------------------------------------- /src/themes/markdown/helpers.ts: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/OpenZeppelin/solidity-docgen/HEAD/src/themes/markdown/helpers.ts -------------------------------------------------------------------------------- /src/themes/markdown/modifier.hbs: -------------------------------------------------------------------------------- 1 | {{>common}} 2 | -------------------------------------------------------------------------------- /src/themes/markdown/page.hbs: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/OpenZeppelin/solidity-docgen/HEAD/src/themes/markdown/page.hbs -------------------------------------------------------------------------------- /src/themes/markdown/struct.hbs: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/OpenZeppelin/solidity-docgen/HEAD/src/themes/markdown/struct.hbs -------------------------------------------------------------------------------- /src/themes/markdown/user-defined-value-type.hbs: -------------------------------------------------------------------------------- 1 | {{>common}} 2 | -------------------------------------------------------------------------------- /src/themes/markdown/variable.hbs: -------------------------------------------------------------------------------- 1 | {{>common}} 2 | -------------------------------------------------------------------------------- /src/utils/ItemError.ts: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/OpenZeppelin/solidity-docgen/HEAD/src/utils/ItemError.ts -------------------------------------------------------------------------------- /src/utils/arrays-equal.ts: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/OpenZeppelin/solidity-docgen/HEAD/src/utils/arrays-equal.ts -------------------------------------------------------------------------------- /src/utils/assert-equal-types.ts: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/OpenZeppelin/solidity-docgen/HEAD/src/utils/assert-equal-types.ts -------------------------------------------------------------------------------- /src/utils/clone.ts: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/OpenZeppelin/solidity-docgen/HEAD/src/utils/clone.ts -------------------------------------------------------------------------------- /src/utils/ensure-array.ts: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/OpenZeppelin/solidity-docgen/HEAD/src/utils/ensure-array.ts -------------------------------------------------------------------------------- /src/utils/execall.ts: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/OpenZeppelin/solidity-docgen/HEAD/src/utils/execall.ts -------------------------------------------------------------------------------- /src/utils/fs-exists.ts: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/OpenZeppelin/solidity-docgen/HEAD/src/utils/fs-exists.ts -------------------------------------------------------------------------------- /src/utils/is-child.ts: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/OpenZeppelin/solidity-docgen/HEAD/src/utils/is-child.ts -------------------------------------------------------------------------------- /src/utils/item-type.ts: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/OpenZeppelin/solidity-docgen/HEAD/src/utils/item-type.ts -------------------------------------------------------------------------------- /src/utils/map-keys.ts: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/OpenZeppelin/solidity-docgen/HEAD/src/utils/map-keys.ts -------------------------------------------------------------------------------- /src/utils/map-values.ts: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/OpenZeppelin/solidity-docgen/HEAD/src/utils/map-values.ts -------------------------------------------------------------------------------- /src/utils/memoized-getter.ts: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/OpenZeppelin/solidity-docgen/HEAD/src/utils/memoized-getter.ts -------------------------------------------------------------------------------- /src/utils/natspec.ts: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/OpenZeppelin/solidity-docgen/HEAD/src/utils/natspec.ts -------------------------------------------------------------------------------- /src/utils/read-item-docs.ts: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/OpenZeppelin/solidity-docgen/HEAD/src/utils/read-item-docs.ts -------------------------------------------------------------------------------- /src/utils/scope.ts: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/OpenZeppelin/solidity-docgen/HEAD/src/utils/scope.ts -------------------------------------------------------------------------------- /src/utils/test.ts: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/OpenZeppelin/solidity-docgen/HEAD/src/utils/test.ts -------------------------------------------------------------------------------- /test-contracts/S08_AB.sol: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/OpenZeppelin/solidity-docgen/HEAD/test-contracts/S08_AB.sol -------------------------------------------------------------------------------- /test-contracts/S08_C.sol: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/OpenZeppelin/solidity-docgen/HEAD/test-contracts/S08_C.sol -------------------------------------------------------------------------------- /test-contracts/S08_I.sol: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/OpenZeppelin/solidity-docgen/HEAD/test-contracts/S08_I.sol -------------------------------------------------------------------------------- /test-contracts/S08_K.sol: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/OpenZeppelin/solidity-docgen/HEAD/test-contracts/S08_K.sol -------------------------------------------------------------------------------- /tsconfig.json: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/OpenZeppelin/solidity-docgen/HEAD/tsconfig.json --------------------------------------------------------------------------------