Package Exports

@mitche50/soldocgen
@mitche50/soldocgen/dist/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@mitche50/soldocgen) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

soldocgen

MarkDown documentation generator for Solidity.

Forked from soldoc

Notes

The Solidity parser needs to be updated, some of the features from Solidity 0.6+ are not supported. Abstract contracts are an example.

Install

npm i -g soldocgen

Usage

soldocgen docs/ contracts/

If your contracts directory includes markdown files with a filename of either README.md or CONTRACTFILE.md, and the markdown file includes a header with the same name as the contract, the documentation found in the markdown file will be mixed in with the generated documentation.

Example

Solidity File

// Contract.sol

/**
 * @dev Notes about the contract.
 */
contract Contract
  /**
   * @dev Comments from natspec
   */
  function test() public view returns (uint256) {
      return 55;
  }

Markdown Input

// Contract.md

# Contract
Additional notes about the contract.

## test
Comments from markdown file.

Output File

// Contract.md
# Contract
Additional notes about the contract.

Notes about the contract.

# Functions
## test()
Comments from markdown file.

**Developer Notes**
Comments from natspec