solidity-docgen
Solidity API documentation automatic generator.
Last updated a month ago by frangio .
MIT · Original npm · Tarball · package.json
$ cnpm install solidity-docgen 
SYNC missed versions from official npm registry.

solidity-docgen

Documentation generator for smart contract libraries.

solidity-docgen allows you to document your code inline using NatSpec comments (a format similar to Javadoc and JSDoc) and then produce a website to publish the documentation.

Built with :heart: by OpenZeppelin.

Usage

Note: Detailed usage information is not available yet. Please be patient!

npm install solidity-docgen

solidity-docgen takes as input a directory of contracts and README documents. This directory is specified using the --input/-i flag, defaulting to ./contracts. It produces a set of files that it will place in the output directory specified by --output/-o, defaulting to ./docs.

solidity-docgen [ -i <input-dir> ] [ -o <output-dir> ] [ -t <templates-dir> ]

Current Tags

  • 0.3.0-beta.4                                ...           latest (a month ago)

9 Versions

  • 0.3.0-beta.4                                ...           a month ago
  • 0.3.0-beta.3                                ...           a month ago
  • 0.3.0-beta.2                                ...           a month ago
  • 0.3.0-beta.1                                ...           a month ago
  • 0.3.0-beta.0                                ...           a month ago
  • 0.2.0-alpha.1                                ...           3 months ago
  • 0.2.0-alpha.0                                ...           4 months ago
  • 0.1.1                                ...           6 months ago
  • 0.1.0                                ...           a year ago
Maintainers (1)
Downloads
Today 0
This Week 0
This Month 9
Last Day 0
Last Week 9
Last Month 149
Dependencies (13)
Dev Dependencies (7)

Copyright 2014 - 2016 © taobao.org |