@augurproject/solidity-docgen
v0.2.0-alpha.3
Published
Solidity API documentation automatic generator.
Downloads
22
Readme
solidity-docgen
Documentation generator for Augur's smart contracts.
solidity-docgen
combines inline documentation with long form documents to
generate Augur's smart contract documentation pages.
Install
npm install solidity-docgen
Usage
- Document your source code in inline comments using
@dev
tags in the NatSpec format. - Write longer form documentation in a README.md file next to your smart contracts. (Optional)
- Run
npm build
in theaugur/augur-core
directory to generate documentation pages in theaugur/docs/docs/contracts
directory. If the contracts have already been compiled, runningnpm build:documentation
will have the same effect.