@augurproject/solidity-docgen
Solidity API documentation automatic generator.
Last updated 10 months ago by nuevoalex .
MIT · Original npm · Tarball · package.json
$ cnpm install @augurproject/solidity-docgen 
SYNC missed versions from official npm registry.

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

  1. Document your source code in inline comments using @dev tags in the NatSpec format.
  2. Write longer form documentation in a README.md file next to your smart contracts. (Optional)
  3. Run npm build in the augur/augur-core directory to generate documentation pages in the augur/docs/docs/contracts directory. If the contracts have already been compiled, running npm build:documentation will have the same effect.

Current Tags

  • 0.2.0-alpha.3                                ...           latest (10 months ago)

2 Versions

  • 0.2.0-alpha.3                                ...           10 months ago
  • 0.2.0-alpha.2                                ...           a year ago
Downloads
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 2
Last Month 4
Dependencies (8)
Dependents (0)
None

Copyright 2014 - 2016 © taobao.org |